WCC PReference Es-ES

VB Scripting 1
C-Scripting (RT Professional) 2

API de runtime (RT
Professional) 3
SIMATIC
WinCC
WinCC Engineering V15.1:
Referencia para la programación
Manual de sistema
Impresión de la Ayuda en pantalla
10/2018
Expresión de la ayuda en pantalla
Notas jurídicas
Filosofía en la señalización de advertencias y peligros
Este manual contiene las informaciones necesarias para la seguridad personal así como para la prevención de
daños materiales. Las informaciones para su seguridad personal están resaltadas con un triángulo de advertencia;
las informaciones para evitar únicamente daños materiales no llevan dicho triángulo. De acuerdo al grado de peligro
las consignas se representan, de mayor a menor peligro, como sigue.
PELIGRO
Significa que, si no se adoptan las medidas preventivas adecuadas se producirá la muerte, o bien lesiones
corporales graves.
ADVERTENCIA
Significa que, si no se adoptan las medidas preventivas adecuadas puede producirse la muerte o bien lesiones
corporales graves.
PRECAUCIÓN
Significa que si no se adoptan las medidas preventivas adecuadas, pueden producirse lesiones corporales.
ATENCIÓN
Significa que si no se adoptan las medidas preventivas adecuadas, pueden producirse daños materiales.
Si se dan varios niveles de peligro se usa siempre la consigna de seguridad más estricta en cada caso. Si en una
consigna de seguridad con triángulo de advertencia de alarma de posibles daños personales, la misma consigna
puede contener también una advertencia sobre posibles daños materiales.
Personal cualificado
El producto/sistema tratado en esta documentación sólo deberá ser manejado o manipulado por personal
cualificado para la tarea encomendada y observando lo indicado en la documentación correspondiente a la misma,
particularmente las consignas de seguridad y advertencias en ella incluidas. Debido a su formación y experiencia,
el personal cualificado está en condiciones de reconocer riesgos resultantes del manejo o manipulación de dichos
productos/sistemas y de evitar posibles peligros.
Uso previsto de los productos de Siemens
Considere lo siguiente:
ADVERTENCIA
Los productos de Siemens sólo deberán usarse para los casos de aplicación previstos en el catálogo y la
documentación técnica asociada. De usarse productos y componentes de terceros, éstos deberán haber sido
recomendados u homologados por Siemens. El funcionamiento correcto y seguro de los productos exige que su
transporte, almacenamiento, instalación, montaje, manejo y mantenimiento hayan sido realizados de forma
correcta. Es preciso respetar las condiciones ambientales permitidas. También deberán seguirse las indicaciones
y advertencias que figuran en la documentación asociada.
Marcas registradas
Todos los nombres marcados con ® son marcas registradas de Siemens AG. Los restantes nombres y
designaciones contenidos en el presente documento pueden ser marcas registradas cuya utilización por terceros
para sus propios fines puede violar los derechos de sus titulares.
Exención de responsabilidad
Hemos comprobado la concordancia del contenido de esta publicación con el hardware y el software descritos. Sin
embargo, como es imposible excluir desviaciones, no podemos hacernos responsable de la plena concordancia.
El contenido de esta publicación se revisa periódicamente; si es necesario, las posibles correcciones se incluyen
en la siguiente edición.
Siemens AG Referencia del documento: Expresión de la ayuda en pantalla Copyright © Siemens AG 2018.
Division Digital Factory Ⓟ 10/2018 Sujeto a cambios sin previo aviso Reservados todos los derechos
Postfach 48 48
90026 NÜRNBERG
ALEMANIA
Índice
1 VB Scripting................................................................................................................................................25
1.1 Funciones de sistema (Panels, Comfort Panels, RT Advanced)...........................................25
1.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)...............................................25
1.1.2 ActivatePLCCodeView (Panels, Comfort Panels, RT Advanced)..........................................25
1.1.3 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)........................................27
1.1.4 ActivateScreen (Panels, Comfort Panels, RT Advanced)......................................................28
1.1.5 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced).....................................29
1.1.6 ActivateSystemDiagnosticsView (Panels, Comfort Panels, RT Advanced)...........................30
1.1.7 ArchiveLogFile (Panels, Comfort Panels, RT Advanced)......................................................31
1.1.8 BackupRAMFileSystem (Panels, Comfort Panels, RT Advanced)........................................32
1.1.9 CalibrateTouchScreen (Panels, Comfort Panels, RT Advanced)..........................................33
1.1.10 ChangeConnection (Panels, Comfort Panels, RT Advanced)...............................................34
1.1.11 ChangeConnectionEIP (Panels, Comfort Panels, RT Advanced)..........................................35
1.1.12 ClearAlarmBuffer (Panels, Comfort Panels, RT Advanced)...................................................37
1.1.13 ClearAlarmBufferProtool (Panels, Comfort Panels, RT Advanced).......................................38
1.1.14 ClearDataRecord (Panels, Comfort Panels, RT Advanced)..................................................39
1.1.15 ClearDataRecordMemory (Panels, Comfort Panels, RT Advanced).....................................40
1.1.16 ClearLog (Panels, Comfort Panels, RT Advanced)................................................................41
1.1.17 CloseAllLogs (Panels, Comfort Panels, RT Advanced).........................................................41
1.1.18 ControlSmartServer (Panels, Comfort Panels, RT Advanced)..............................................42
1.1.19 ControlWebServer (Panels, Comfort Panels, RT Advanced).................................................43
1.1.20 CopyLog (Panels, Comfort Panels, RT Advanced)................................................................44
1.1.21 DecreaseTag (Panels, Comfort Panels, RT Advanced).........................................................45
1.1.22 EditAlarm (Panels, Comfort Panels, RT Advanced)...............................................................46
1.1.23 Encode (Panels, Comfort Panels, RT Advanced)..................................................................46
1.1.24 EncodeEx (Panels, Comfort Panels, RT Advanced)..............................................................47
1.1.25 ExportDataRecords (Panels, Comfort Panels, RT Advanced)...............................................48
1.1.26 ExportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced).......................51
1.1.27 ExportImportUserAdministration (Panels, Comfort Panels, RT Advanced)...........................53
1.1.28 GetBrightness (Panels, Comfort Panels, RT Advanced).......................................................54
1.1.29 GetDataRecordFromPLC (Panels, Comfort Panels, RT Advanced)......................................55
1.1.30 GetDataRecordName (Panels, Comfort Panels, RT Advanced)............................................56
1.1.31 GetDataRecordTagsFromPLC (Panels, Comfort Panels, RT Advanced)..............................58
1.1.32 GetGroupNumber (Panels, Comfort Panels, RT Advanced)..................................................59
1.1.33 GetPassword (Panels, Comfort Panels, RT Advanced).........................................................59
1.1.34 GetUserName (Panels, Comfort Panels, RT Advanced).......................................................60
1.1.35 GoToEnd (Panels, Comfort Panels, RT Advanced)...............................................................61
1.1.36 GoToHome (Panels, Comfort Panels, RT Advanced)............................................................61
1.1.37 ImportDataRecords (Panels, Comfort Panels, RT Advanced)...............................................62
1.1.38 ImportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced).......................64
1.1.39 IncreaseTag (Panels, Comfort Panels, RT Advanced)..........................................................65
1.1.40 InverseLinearScaling (Panels, Comfort Panels, RT Advanced).............................................66
1.1.41 InvertBit (Panels, Comfort Panels, RT Advanced).................................................................67
1.1.42 InvertBitInTag (Panels, Comfort Panels, RT Advanced)........................................................69
1.1.43 LinearScaling (Panels, Comfort Panels, RT Advanced)........................................................70
1.1.44 LoadDataRecord (Panels, Comfort Panels, RT Advanced)...................................................72
WinCC Engineering V15.1: Referencia para la programación

Manual de sistema, 10/2018, Expresión de la ayuda en pantalla 3
Índice
1.1.45 Logoff (Panels, Comfort Panels, RT Advanced)....................................................................73

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

4 Manual de sistema, 10/2018, Expresión de la ayuda en pantalla
Índice
1.2.2 ActivateScreenInScreenWindow (RT Professional).............................................................122

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

Índice
1.4.5.8 Input (Panels, Comfort Panels)............................................................................................177

1.4.5.9 InputB (Panels, Comfort Panels)..........................................................................................177
1.4.5.10 InputFields (Panels, Comfort Panels)..................................................................................178
1.4.5.11 Kill (Panels, Comfort Panels)...............................................................................................179
1.4.5.12 LineInputString (Panels, Comfort Panels)............................................................................180
1.4.5.13 LinePrint (Panels, Comfort Panels)......................................................................................180
1.4.5.14 MkDir (Panels, Comfort Panels)...........................................................................................181
1.4.5.15 MoveFile (Panels, Comfort Panels).....................................................................................182
1.4.5.16 Open (Panels, Comfort Panels)...........................................................................................182
1.4.5.17 Put (Panels, Comfort Panels)...............................................................................................183
1.4.5.18 RmDir (Panels, Comfort Panels)..........................................................................................184
1.4.5.19 SetAttr (Panels, Comfort Panels).........................................................................................185
1.4.5.20 WriteFields (Panels, Comfort Panels)..................................................................................186
1.5 Modelo de objetos VBS (Panels, Comfort Panels, RT Advanced, RT Professional)...........188
1.5.1 Modelo de objeto VBS (RT Professional)............................................................................188
1.5.2 Objetos (Panels, Comfort Panels, RT Advanced)................................................................190
1.5.2.1 HMIRuntime (Panels, Comfort Panels, RT Advanced)........................................................190
1.5.2.2 Screens (lista) (Panels, Comfort Panels, RT Advanced).....................................................191
1.5.2.3 Screen (Panels, Comfort Panels, RT Advanced).................................................................193
1.5.2.4 ScreenItem (Panels, Comfort Panels, RT Advanced)..........................................................194
1.5.2.5 ScreenItems (Panels, Comfort Panels, RT Advanced)........................................................196
1.5.2.6 SmartTags (Panels, Comfort Panels, RT Advanced)...........................................................197
1.5.2.7 SmartTag (Panels, Comfort Panels, RT Advanced)............................................................199
1.5.3 Objetos (RT Professional)....................................................................................................201
1.5.3.1 Alarm (RT Professional).......................................................................................................201
1.5.3.2 Alarms (lista) (RT Professional)...........................................................................................202
1.5.3.3 AlarmLogs (lista) (RT Professional).....................................................................................203
1.5.3.4 DataItem (RT Professional)..................................................................................................205
1.5.3.5 DataLogs (lista) (RT Professional).......................................................................................206
1.5.3.6 DataSet (lista) (RT Professional).........................................................................................208
1.5.3.7 HMIRuntime (RT Professional)...........................................................................................210
1.5.3.8 Item (RT Professional).........................................................................................................212
1.5.3.9 Layer (RT Professional).......................................................................................................212
1.5.3.10 Layers (lista) (RT Professional)...........................................................................................214
1.5.3.11 Logging (RT Professional)...................................................................................................215
1.5.3.12 Project (RT Professional).....................................................................................................216
1.5.3.13 Screen (RT Professional).....................................................................................................217
1.5.3.14 ScreenItem (RT Professional)..............................................................................................220
1.5.3.15 ScreenItems (lista) (RT Professional)..................................................................................222
1.5.3.16 Screens (lista) (RT Professional).........................................................................................224
1.5.3.17 SmartTag (RT Professional)................................................................................................226
1.5.3.18 SmartTags (RT Professional)...............................................................................................228
1.5.3.19 Tag (RT Professional)..........................................................................................................230
1.5.3.20 Tags (lista) (RT Professional)..............................................................................................233
1.5.3.21 TagSet (lista) (RT Professional)..........................................................................................234
1.5.4 Tipos de objeto (Panels, Comfort Panels, RT Advanced, RT Professional)........................235
1.5.4.1 Tipos de objeto disponibles en VBS (Panels, Comfort Panels, RT Advanced, RT
Professional)........................................................................................................................235
1.5.4.2 Objetos A-I (Panels, Comfort Panels, RT Advanced, RT Professional)...............................238
1.5.4.3 Objetos K-Z (Panels, Comfort Panels, RT Advanced, RT Professional).............................342
1.5.5 Propiedades (Panels, Comfort Panels, RT Advanced, RT Professional)............................501
1.5.5.1 Propiedades A (Panels, Comfort Panels, RT Advanced, RT Professional).........................501

Índice
1.5.5.2 Propiedades B (Panels, Comfort Panels, RT Advanced, RT Professional).........................537

1.5.5.3 Propiedades C (Panels, Comfort Panels, RT Advanced, RT Professional).........................598
1.5.5.4 Propiedades D (Panels, Comfort Panels, RT Advanced, RT Professional).........................652
1.5.5.5 Propiedades E-F (Panels, Comfort Panels, RT Advanced, RT Professional)......................669
1.5.5.6 Propiedades G-H (Panels, Comfort Panels, RT Advanced, RT Professional).....................728
1.5.5.7 Propiedades I-J (Panels, Comfort Panels, RT Advanced, RT Professional).......................753
1.5.5.8 Propiedades K-L (Panels, Comfort Panels, RT Advanced, RT Professional)......................771
1.5.5.9 Propiedades M-N (Panels, Comfort Panels, RT Advanced, RT Professional).....................809
1.5.5.10 Propiedades O-P (Panels, Comfort Panels, RT Advanced, RT Professional).....................849
1.5.5.11 Propiedades Q-R (Panels, Comfort Panels, RT Advanced, RT Professional).....................888
1.5.5.12 Propiedades S (Panels, Comfort Panels, RT Advanced, RT Professional).........................905
1.5.5.13 Propiedades T (Panels, Comfort Panels, RT Advanced, RT Professional).........................999
1.5.5.14 Propiedades U-W (Panels, Comfort Panels, RT Advanced, RT Professional)..................1159
1.5.5.15 Propiedades X-Z (Panels, Comfort Panels, RT Advanced, RT Professional)....................1243
1.5.6 Métodos (Panels, Comfort Panels, RT Advanced, RT Professional).................................1268
1.5.6.1 Métodos A-G (Panels, Comfort Panels, RT Advanced, RT Professional).........................1268
1.5.6.2 Métodos H-R (Panels, Comfort Panels, RT Advanced, RT Professional).........................1333
1.5.6.3 Métodos S-Z (Panels, Comfort Panels, RT Advanced, RT Professional)..........................1360
2 C-Scripting (RT Professional).................................................................................................................1389
2.1 Funciones de sistema (RT Professional)...........................................................................1389
2.1.1 ActivateNextScreen (RT Professional)...............................................................................1389
2.1.2 ActivatePreviousScreen (RT Professional)........................................................................1390
2.1.3 ActivateScreen (RT Professional)......................................................................................1391
2.1.4 ActivateScreenInScreenWindow (RT Professional)...........................................................1392
2.1.5 ActivateStartScreen (RT Professional)..............................................................................1393
2.1.6 ActivateStoredScreen (RT Professional)...........................................................................1394
2.1.7 DateToSystemTime (RT Professional)..............................................................................1395
2.1.8 DecreaseTag (RT Professional).........................................................................................1397
2.1.9 GetLocalScreen (RT Professional)....................................................................................1398
2.1.10 GetLinkedTag (RT Professional)........................................................................................1400
2.1.11 GetLanguageByLocaleID (RT Professional)......................................................................1401
2.1.12 GetParentScreen (RT Professional)..................................................................................1403
2.1.13 GetParentScreenWindow (RT Professional)......................................................................1405
2.1.14 GetProp (RT Professional).................................................................................................1407
2.1.14.1 GetPropBOOL (RT Professional)......................................................................................1407
2.1.14.2 GetPropChar (RT Professional).........................................................................................1408
2.1.14.3 GetPropDouble (RT Professional).....................................................................................1410
2.1.14.4 GetPropLong (RT Professional).........................................................................................1411
2.1.15 GetServerTagPrefix (RT Professional)..............................................................................1412
2.1.16 GetTag (RT Professional)..................................................................................................1415
2.1.16.1 Funciones GetTag (RT Professional).................................................................................1415
2.1.16.2 Función GetTagDateTime (RT Professional).....................................................................1416
2.1.16.3 Funciones GetTagMultiStateQCWait (RT Professional)....................................................1417
2.1.16.4 Funciones GetTagMultiStateWait (RT Professional).........................................................1419
2.1.16.5 Funciones GetTagMultiWait (RT Professional)..................................................................1420
2.1.16.6 Funciones GetTagState (RT Professional)........................................................................1422
2.1.16.7 Funciones GetTagStateQC (RT Professional)...................................................................1424
2.1.16.8 Funciones GetTagStateQCWait (RT Professional)............................................................1427
2.1.16.9 Funciones GetTagStateWait (RT Professional).................................................................1430
2.1.16.10 Funciones GetTagValue (RT Professional).......................................................................1432
2.1.16.11 Funciones GetTagValueStateQC (RT Professional)..........................................................1434

Índice
2.1.16.12 Funciones GetTagValueStateQCWait (RT Professional)..................................................1436

2.1.16.13 Funciones GetTagValueWait (RT Professional)................................................................1437
2.1.16.14 Funciones GetTagWait (RT Professional).........................................................................1438
2.1.17 IncreaseTag (RT Professional)..........................................................................................1440
2.1.18 InquireLanguage (RT Professional)...................................................................................1441
2.1.19 InverseLinearScaling (RT Professional).............................................................................1443
2.1.20 InvertBit (RT Professional).................................................................................................1445
2.1.21 InvertBitInTag (RT Professional)........................................................................................1446
2.1.22 IsUserAuthorized (RT Professional)...................................................................................1448
2.1.23 LinearScaling (RT Professional)........................................................................................1450
2.1.24 ReportJob (RT Professional)..............................................................................................1451
2.1.25 ResetBit (RT Professional).................................................................................................1452
2.1.26 ResetBitInTag (RT Professional).......................................................................................1454
2.1.27 Set_Focus (RT Professional).............................................................................................1455
2.1.28 SetBit (RT Professional).....................................................................................................1456
2.1.29 SetBitInTag (RT Professional)...........................................................................................1457
2.1.30 SetLanguageByLocaleID (RT Professional)......................................................................1459
2.1.31 SetLanguageByName (RT Professional)...........................................................................1461
2.1.32 SetProp (RT Professional).................................................................................................1462
2.1.32.1 SetPropBOOL (RT Professional).......................................................................................1462
2.1.32.2 SetPropChar (RT Professional).........................................................................................1463
2.1.32.3 SetPropDouble (RT Professional)......................................................................................1465
2.1.32.4 SetPropLong (RT Professional).........................................................................................1466
2.1.33 SetPropertyByConstant (RT Professional).........................................................................1468
2.1.34 SetPropertyByProperty (RT Professional).........................................................................1470
2.1.35 SetPropertyByTag (RT Professional).................................................................................1472
2.1.36 SetPropertyByTagIndirect (RT Professional).....................................................................1474
2.1.37 SetTag (RT Professional)...................................................................................................1475
2.1.37.1 Funciones SetTag (RT Professional).................................................................................1475
2.1.37.2 SetTagDateTime (RT Professional)...................................................................................1478
2.1.37.3 Funciones SetTagMultiStateWait (RT Professional)..........................................................1478
2.1.37.4 Funciones SetTagMultiWait (RT Professional)..................................................................1480
2.1.37.5 Funciones SetTagState (RT Professional).........................................................................1482
2.1.37.6 Funciones SetTagStateWait (RT Professional).................................................................1485
2.1.37.7 Funciones SetTagValue (RT Professional)........................................................................1487
2.1.37.8 Funciones SetTagValueWait (RT Professional).................................................................1489
2.1.37.9 Funciones SetTagWait (RT Professional)..........................................................................1490
2.1.37.10 SetTag (RT Professional)...................................................................................................1492
2.1.37.11 SetTagByProperty (RT Professional).................................................................................1493
2.1.37.12 SetTagByTagIndirect (RT Professional)............................................................................1495
2.1.37.13 SetTagIndirect (RT Professional)......................................................................................1496
2.1.37.14 SetTagIndirectByProperty (RT Professional).....................................................................1497
2.1.37.15 SetTagIndirectByTagIndirect (RT Professional).................................................................1498
2.1.37.16 SetTagIndirectWithOperatorEvent (RT Professional)........................................................1499
2.1.37.17 SetTagWithOperatorEvent (RT Professional)....................................................................1499
2.1.38 StartProgram (RT Professional).........................................................................................1500
2.1.39 StopRuntime (RT Professional).........................................................................................1501
2.1.40 StoreScreen (RT Professional).........................................................................................1502
2.1.41 SystemTimeToDate (RT Professional)..............................................................................1503
2.1.42 TriggerOperatorEvent (RT Professional)...........................................................................1505
2.1.43 UA (Recipe) (RT Professional)...........................................................................................1506
2.1.43.1 uaArchiveClose (RT Professional).....................................................................................1506

Índice
2.1.43.2 uaArchiveDelete (RT Professional)....................................................................................1507

2.1.43.3 uaArchiveExport (RT Professional)....................................................................................1508
2.1.43.4 uaArchiveGetCount (RT Professional)...............................................................................1509
2.1.43.5 uaArchiveGetFieldLength (RT Professional)......................................................................1509
2.1.43.6 uaArchiveGetFieldName (RT Professional).......................................................................1510
2.1.43.7 uaArchiveGetFields (RT Professional)...............................................................................1511
2.1.43.8 uaArchiveGetFieldType (RT Professional)........................................................................1511
2.1.43.9 uaArchiveGetFieldValueDate (RT Professional)................................................................1512
2.1.43.10 uaArchiveGetFieldValueDouble (RT Professional)............................................................1513
2.1.43.11 uaArchiveGetFieldValueFloat (RT Professional)...............................................................1513
2.1.43.12 uaArchiveGetFieldValueLong (RT Professional)...............................................................1514
2.1.43.13 uaArchiveGetFieldValueString (RT Professional)..............................................................1515
2.1.43.14 uaArchiveGetFilter (RT Professional)................................................................................1516
2.1.43.15 uaArchiveGetID (RT Professional).....................................................................................1516
2.1.43.16 uaArchiveGetName (RT Professional)...............................................................................1517
2.1.43.17 uaArchiveGetSor (RT Professional)...................................................................................1518
2.1.43.18 uaArchiveImport (RT Professional)....................................................................................1518
2.1.43.19 uaArchiveInsert (RT Professional).....................................................................................1519
2.1.43.20 uaArchiveMoveFirst (RT Professional)..............................................................................1520
2.1.43.21 uaArchiveMoveLast (RT Professional)..............................................................................1520
2.1.43.22 uaArchiveMoveNext (RT Professional)..............................................................................1521
2.1.43.23 uaArchiveMovePrevious (RT Professional).......................................................................1522
2.1.43.24 uaArchiveOpen (RT Professional).....................................................................................1522
2.1.43.25 uaArchiveReadTagValues (RT Professional)....................................................................1523
2.1.43.26 uaArchiveReadTagValuesByName (RT Professional).......................................................1524
2.1.43.27 uaArchiveRequery (RT Professional).................................................................................1525
2.1.43.28 uaArchiveSetFieldValueDate (RT Professional)................................................................1526
2.1.43.29 uaArchiveSetFieldValueDouble (RT Professional)............................................................1526
2.1.43.30 uaArchiveSetFieldValueFloat (RT Professional)................................................................1527
2.1.43.31 uaArchiveSetFieldValueLong (RT Professional)................................................................1528
2.1.43.32 uaArchiveSetFieldValueString (RT Professional).............................................................1529
2.1.43.33 uaArchiveSetFilter (RT Professional).................................................................................1530
2.1.43.34 uaArchiveSetSort (RT Professional)..................................................................................1530
2.1.43.35 uaArchiveUpdate (RT Professional)...................................................................................1531
2.1.43.36 uaArchiveWriteTagValues (RT Professional).....................................................................1532
2.1.43.37 uaArchiveWriteTagValuesByName (RT Professional).......................................................1533
2.1.43.38 uaConnect (RT Professional).............................................................................................1533
2.1.43.39 uaDisconnect (RT Professional)........................................................................................1534
2.1.43.40 uaGetArchive (RT Professional)........................................................................................1535
2.1.43.41 uaGetField (RT Professional).............................................................................................1535
2.1.43.42 uaGetLastError (RT Professional).....................................................................................1536
2.1.43.43 uaGetLastHResult (RT Professional)................................................................................1538
2.1.43.44 uaGetNumArchives (RT Professional)...............................................................................1539
2.1.43.45 uaGetNumFields (RT Professional)...................................................................................1539
2.1.43.46 uaQueryArchive (RT Professional)...................................................................................1540
2.1.43.47 uaQueryArchiveByName (RT Professional)......................................................................1541
2.1.43.48 uaQueryConfiguration (RT Professional)...........................................................................1542
2.1.43.49 uaReleaseArchive (RT Professional).................................................................................1542
2.1.43.50 uaReleaseConfiguration (RT Professional).......................................................................1543
2.2 C-bib (RT Professional)......................................................................................................1544
2.2.1 Funciones ctype (RT Professional)....................................................................................1544
2.2.2 Grupo de funciones c_bib (RT Professional).....................................................................1545

Índice
2.2.3 Funciones math (RT Professional).....................................................................................1545

2.2.4 Funciones memory (RT Professional)................................................................................1546
2.2.5 Funciones multibyte (RT Professional)..............................................................................1547
2.2.6 Funciones stdio (RT Professional).....................................................................................1548
2.2.7 Funciones stdlib (RT Professional)....................................................................................1549
2.2.8 Funciones string (RT Professional)....................................................................................1550
2.2.9 Funciones time (RT Professional)......................................................................................1551
2.3 Definición de estructura (RT Professional)........................................................................1551
2.3.1 Definición de estructura CCAPErrorExecute (RT Professional)........................................1551
2.3.2 Definición de estructura CCAPTime (RT Professional).....................................................1553
2.3.3 Definición de estructura CMN_ERROR (RT Professional)................................................1553
2.3.4 Definición de estructura DM_TYPEREF (RT Professional)...............................................1554
2.3.5 Definición de estructura DM_VAR_UPDATE_STRUCT (RT Professional)........................1555
2.3.6 Definición de estructura DM_VAR_UPDATE_STRUCTEX (RT Professional)...................1556
2.3.7 Definición de estructura DM_VARKEY (RT Professional)................................................1557
2.3.8 Definición de estructura LINKINFO (RT Professional).......................................................1558
2.3.9 Definición de estructura MSG_FILTER_STRUCT (RT Professional).................................1559
2.3.10 Definición de estructura MSG_RTDATA_STRUCT (RT Professional)...............................1562
3 API de runtime (RT Professional)...........................................................................................................1565
3.1 Runtime API (RT Professional)..........................................................................................1565
3.2 Funciones de la gestión de datos (RT Professional).........................................................1566
3.2.1 Principios básicos (RT Professional).................................................................................1566
3.2.1.1 Sinopsis de las estructuras (RT Professional)...................................................................1566
3.2.1.2 Sinopsis de las funciones (RT Professional)......................................................................1567
3.2.1.3 Quality Codes de variables HMI (RT Professional)............................................................1568
3.2.1.4 Propiedad VariableStateType (RT Professional)...............................................................1572
3.2.1.5 Constantes (RT Professional)............................................................................................1573
3.2.1.6 Mensajes de error (RT Professional).................................................................................1578
3.2.1.7 Rutinas de conversión (Control Center) (RT Professional)................................................1579
3.2.2 Estructuras (RT Professional)............................................................................................1586
3.2.2.1 DM_CONNECTION_DATA (RT Professional)...................................................................1586
3.2.2.2 DM_CONNKEY (RT Professional).....................................................................................1587
3.2.2.3 DM_CYCLE_INFO (RT Professional)................................................................................1588
3.2.2.4 DM_DATA_SERVICE (RT Professional)............................................................................1589
3.2.2.5 DM_DIRECTORY_INFO (RT Professional).......................................................................1590
3.2.2.6 DM_DLGOPTIONS (RT Professional)...............................................................................1591
3.2.2.7 DM_FORMAT_INFO (RT Professional).............................................................................1592
3.2.2.8 DM_MACHINE_TABLE (RT Professional).........................................................................1593
3.2.2.9 DM_PROJECT_INFO (RT Professional)............................................................................1594
3.2.2.10 DM_SEND_DATA_STRUCT (RT Professional).................................................................1595
3.2.2.11 DM_SD_TARGET_MACHINE (RT Professional)...............................................................1597
3.2.2.12 DM_SD_TARGET_APP (RT Professional)........................................................................1598
3.2.2.13 DM_TYPEREF (RT Professional)......................................................................................1598
3.2.2.14 DM_VAR_UPDATE_STRUCT (RT Professional)...............................................................1600
3.2.2.15 DM_VAR_UPDATE_STRUCTEX (RT Professional)..........................................................1602
3.2.2.16 DM_VARFILTER (RT Professional)...................................................................................1605
3.2.2.17 DM_VARGRP_DATA (RT Professional)............................................................................1607
3.2.2.18 DM_VARGRPKEY (RT Professional)................................................................................1608
3.2.2.19 DM_VARIABLE_DATA (RT Professional)..........................................................................1609
3.2.2.20 DM_VARIABLE_DATA4 (RT Professional)........................................................................1611

Índice
3.2.2.21 DM_VARKEY (RT Professional)........................................................................................1614

3.2.2.22 DM_VARLIMIT (RT Professional)......................................................................................1616
3.2.2.23 MCP_NEWVARIABLE_DATA (RT Professional)...............................................................1617
3.2.2.24 MCP_NEWVARIABLE_DATA_4 (RT Professional)...........................................................1620
3.2.2.25 MCP_NEWVARIABLE_DATA_5 (RT Professional)...........................................................1622
3.2.2.26 MCP_NEWVARIABLE_DATA_EX (RT Professional)........................................................1624
3.2.2.27 MCP_NEWVARIABLE_DATA_EX4 (RT Professional)......................................................1626
3.2.2.28 MCP_VARIABLE_COMMON (RT Professional)................................................................1629
3.2.2.29 MCP_VARIABLE_COMMON_EX (RT Professional)..........................................................1630
3.2.2.30 MCP_VARIABLE_LIMITS (RT Professional).....................................................................1633
3.2.2.31 MCP_VARIABLE_LIMITS5 (RT Professional)...................................................................1635
3.2.2.32 MCP_VARIABLE_LIMITS_EX (RT Professional)...............................................................1637
3.2.2.33 MCP_VARIABLE_PROTOCOL (RT Professional).............................................................1638
3.2.2.34 MCP_VARIABLE_PROTOCOL_EX (RT Professional)......................................................1640
3.2.2.35 MCP_VARIABLE_SCALES (RT Professional)...................................................................1641
3.2.3 Funciones generales (RT Professional).............................................................................1642
3.2.3.1 DMActivateRTProject (RT Professional)............................................................................1642
3.2.3.2 DMAddNotify (RT Professional).........................................................................................1643
3.2.3.3 DMChangeDataLocale (RT Professional)..........................................................................1650
3.2.3.4 DMConnect (RT Professional)...........................................................................................1651
3.2.3.5 DM_NOTIFY_PROC (RT Professional).............................................................................1654
3.2.3.6 DMDeactivateRTProject (RT Professional)........................................................................1657
3.2.3.7 DMDisconnect (RT Professional).......................................................................................1658
3.2.3.8 DMEnumNumberFormats (RT Professional).....................................................................1659
3.2.3.9 DM_ENUM_FORMATS_PROC (RT Professional).............................................................1661
3.2.3.10 DMEnumUpdateCycles (RT Professional).........................................................................1662
3.2.3.11 DM_ENUM_CYCLES_PROC (RT Professional)................................................................1664
3.2.3.12 DMExitWinCC (RT Professional).......................................................................................1665
3.2.3.13 DMExitWinCCEx (RT Professional)...................................................................................1666
3.2.3.14 DMFireNotifyData (RT Professional)..................................................................................1667
3.2.3.15 DMGetConnectionState (RT Professional)........................................................................1670
3.2.3.16 DMGetDataLocale (RT Professional).................................................................................1671
3.2.3.17 DMGetHotkey (RT Professional)........................................................................................1672
3.2.3.18 DMGetMachineInfo (RT Professional)...............................................................................1673
3.2.3.19 DMGetMachineTable (RT Professional)............................................................................1674
3.2.3.20 DMRemoveNotify (RT Professional)..................................................................................1675
3.2.4 Funciones para la administración de proyectos (RT Professional)....................................1678
3.2.4.1 DMEnumOpenedProjects (RT Professional).....................................................................1678
3.2.4.2 DM_ENUM_OPENED_PROJECTS_PROC (RT Professional)..........................................1679
3.2.4.3 DMGetProjectDirectory (RT Professional).........................................................................1681
3.2.4.4 DMGetProjectInformation (RT Professional)......................................................................1682
3.2.4.5 DMGetRuntimeProject (RT Professional)..........................................................................1684
3.2.4.6 DMOpenProjectDocPlus (RT Professional).......................................................................1685
3.2.4.7 DMOpenProjectPlus (RT Professional)..............................................................................1686
3.2.5 Canales de transporte de datos (RT Professional)............................................................1688
3.2.5.1 DMClearBlockQueue (RT Professional)............................................................................1688
3.2.5.2 DMEnumDataServices (RT Professional)..........................................................................1689
3.2.5.3 DM_ENUM_DATA_SERVICE_PROC (RT Professional)...................................................1691
3.2.5.4 DM_DATA_SERVICE_PROC (RT Professional)...............................................................1692
3.2.5.5 DMGetNumPendingBlocks (RT Professional)...................................................................1693
3.2.5.6 DMInstallDataService (RT Professional)............................................................................1694
3.2.5.7 DMSendApplicationData (RT Professional).......................................................................1696

Índice
3.2.5.8 DMSetBlockQueueSize (RT Professional).........................................................................1697

3.2.6 Funciones para procesar variables (RT Professional).......................................................1698
3.2.6.1 DMEnumVarData (RT Professional)..................................................................................1698
3.2.6.2 DM_ENUM_VARIABLE_PROC (RT Professional).............................................................1700
3.2.6.3 DMEnumVarData4 (RT Professional)................................................................................1702
3.2.6.4 DM_ENUM_VARIABLE_PROC4 (RT Professional)...........................................................1704
3.2.6.5 DMEnumVarGrpData (RT Professional)............................................................................1706
3.2.6.6 DMEnumVarGrpDataExStr (RT Professional)...................................................................1708
3.2.6.7 DM_ENUM_VARGRP_PROC (RT Professional)...............................................................1709
3.2.6.8 DMEnumVariables (RT Professional)................................................................................1711
3.2.6.9 DM_ENUM_VAR_PROC (RT Professional).......................................................................1712
3.2.6.10 DMGetValue (RT Professional)..........................................................................................1714
3.2.6.11 DMGetValueEx (RT Professional).....................................................................................1716
3.2.6.12 DMGetValueExStr (RT Professional).................................................................................1718
3.2.6.13 DMGetValueWait (RT Professional)..................................................................................1727
3.2.6.14 DMGetValueWaitEx (RT Professional)..............................................................................1729
3.2.6.15 DMGetValueWaitExStr (RT Professional)..........................................................................1731
3.2.6.16 DMGetVarInfo (RT Professional).......................................................................................1734
3.2.6.17 DMGetVarInfoExStr (RT Professional)..............................................................................1735
3.2.6.18 DMGetVarLimits (RT Professional)....................................................................................1745
3.2.6.19 DMGetVarLimitsExStr (RT Professional)...........................................................................1747
3.2.6.20 DMGetVarType (RT Professional).....................................................................................1752
3.2.6.21 DMGetVarTypeExStr (RT Professional)............................................................................1754
3.2.6.22 DMSetValue (RT Professional)..........................................................................................1758
3.2.6.23 DMSetValueExStr (RT Professional).................................................................................1761
3.2.6.24 DMSetValueMessage (RT Professional)...........................................................................1764
3.2.6.25 DMSetValueMessageExStr (RT Professional)...................................................................1766
3.2.6.26 DMSetValueWait (RT Professional)...................................................................................1768
3.2.6.27 DMSetValueWaitExStr (RT Professional)..........................................................................1770
3.2.6.28 DMSetValueWaitMessage (RT Professional)....................................................................1774
3.2.6.29 DMSetValueWaitMessageExStr (RT Professional)...........................................................1776
3.2.6.30 DM_COMPLETITION_PROC (RT Professional)................................................................1779
3.2.6.31 DMShowVarPropertiesExStr (RT Professional).................................................................1781
3.2.6.32 DMShowVarDatabase (RT Professional)...........................................................................1783
3.2.6.33 DMShowVarDatabaseExStr (RT Professional)..................................................................1785
3.2.6.34 DMShowVarDatabaseMulti (RT Professional)...................................................................1788
3.2.6.35 DMShowVarDatabaseMultiExStr (RT Professional)..........................................................1791
3.2.6.36 DM_NOTIFY_SELECT_VAR_PROC (RT Professional)....................................................1795
3.2.6.37 GAPICreateNewVariable (RT Professional)......................................................................1796
3.2.6.38 GAPICreateNewVariable4 (RT Professional)...................................................................1797
3.2.6.39 GAPICreateNewVariable5 (RT Professional)...................................................................1799
3.2.6.40 GAPICreateNewVariableEx4 (RT Professional)...............................................................1801
3.2.7 Funciones para procesar variables estructuradas (RT Professional)................................1802
3.2.7.1 GAPIEnumTypeMembers (RT Professional).....................................................................1802
3.2.7.2 DM_ENUM_TYPEMEMBERS_PROC (RT Professional)...................................................1804
3.2.7.3 GAPIEnumTypeMembersEx (RT Professional).................................................................1805
3.2.7.4 GAPIEnumTypeMembersExStr (RT Professional)............................................................1807
3.2.7.5 DM_ENUM_TYPEMEMBERS_PROC_EX (RT Professional)............................................1809
3.2.7.6 GAPIEnumTypeMembersEx4 (RT Professional)...............................................................1810
3.2.7.7 DM_ENUM_TYPEMEMBERS_PROC_EX4 (RT Professional)..........................................1812
3.2.7.8 GAPIEnumTypes (RT Professional)..................................................................................1813
3.2.7.9 DM_ENUM_TYPES_PROC (RT Professional)..................................................................1815

Índice
3.2.8 Funciones para procesar conexiones (RT Professional)...................................................1817

3.2.8.1 DMEnumConnectionData (RT Professional).....................................................................1817
3.2.8.2 DMEnumConnectionDataExStr (RT Professional).............................................................1819
3.2.8.3 DM_ENUM_CONNECTION_PROC (RT Professional)......................................................1820
3.2.9 Funciones de la plataforma de trabajo (RT Professional)..................................................1821
3.2.9.1 DMGetOSVersion (RT Professional).................................................................................1821
3.2.9.2 DMGetSystemLocale (RT Professional)............................................................................1823
3.2.9.3 DMSetLanguage (RT Professional)...................................................................................1825
3.2.9.4 DMShowLanguageDialog (RT Professional).....................................................................1826
3.2.10 Funciones para actualizar variables (RT Professional)......................................................1827
3.2.10.1 DMBeginStartVarUpdate (RT Professional).......................................................................1827
3.2.10.2 DMEndStartVarUpdate (RT Professional).........................................................................1829
3.2.10.3 DMResumeVarUpdate (RT Professional)..........................................................................1830
3.2.10.4 DMStartVarUpdate (RT Professional)................................................................................1832
3.2.10.5 DM_NOTIFY_VARIABLE_PROC (RT Professional)..........................................................1834
3.2.10.6 DMStartVarUpdateEx (RT Professional)............................................................................1835
3.2.10.7 DMStartVarUpdateExStr (RT Professional).......................................................................1838
3.2.10.8 DM_NOTIFY_VARIABLEEX_PROC (RT Professional).....................................................1845
3.2.10.9 DMStopAllUpdates (RT Professional)................................................................................1847
3.2.10.10 DMStopVarUpdate (RT Professional)................................................................................1848
3.2.10.11 DMSuspendVarUpdate (RT Professional).........................................................................1849
3.2.11 Ejemplos (RT Professional)...............................................................................................1851
3.2.11.1 Connection to DM (RT Professional).................................................................................1851
3.2.11.2 Enum Data of Tags (RT Professional)...............................................................................1854
3.2.11.3 Enum open projects (RT Professional)..............................................................................1856
3.2.11.4 Enumerate all structured types (RT Professional).............................................................1858
3.2.11.5 Enumerate all connections (RT Professional)....................................................................1860
3.2.11.6 Inquire project informations (RT Professional)...................................................................1862
3.2.11.7 OnTestDeactivateRuntimeProject (RT Professional).........................................................1863
3.2.11.8 OnTestEnumGroupsAll (RT Professional).........................................................................1863
3.2.11.9 OnTestEnumVariables (RT Professional)..........................................................................1864
3.2.11.10 OnTestEnumConnectionDataAll (RT Professional)...........................................................1865
3.2.11.11 OnTestMachines (RT Professional)...................................................................................1866
3.2.11.12 OnTestProjectInfo (RT Professional).................................................................................1867
3.2.11.13 OnTestProjectPaths (RT Professional)..............................................................................1868
3.2.11.14 OnTestOpenProject (RT Professional)..............................................................................1869
3.2.11.15 OnTestOpenProjects (RT Professional).............................................................................1870
3.2.11.16 OnTestRuntimeProject (RT Professional)..........................................................................1870
3.2.11.17 OnTestSystemLocale (RT Professional)............................................................................1871
3.2.11.18 OnTestUpdateCycles (RT Professional)............................................................................1871
3.2.11.19 OnTestVariablenBeginstartvarupdate (RT Professional)...................................................1872
3.2.11.20 OnTestVariablenEndstartvarupdate (RT Professional)......................................................1873
3.2.11.21 OnTestVariablenGetvalue (RT Professional).....................................................................1874
3.2.11.22 OnTestVariablenGetvaluewait (RT Professional)..............................................................1877
3.2.11.23 OnTestVariablenGetVarInfo (RT Professional)..................................................................1881
3.2.11.24 OnTestVariablenGetvarlimits (RT Professional)................................................................1882
3.2.11.25 OnTestVariablenGetvartype (RT Professional)..................................................................1883
3.2.11.26 OnTestVariablenResumevarupdate (RT Professional)......................................................1884
3.2.11.27 OnTestVariablenSetvalue (RT Professional).....................................................................1885
3.2.11.28 OnTestVariablenSetvaluewait (RT Professional)...............................................................1886
3.2.11.29 OnTestVariablenStopallupdates (RT Professional)...........................................................1887
3.2.11.30 OnTestVariablenStopvarupdate (RT Professional)............................................................1887

Índice
3.2.11.31 OnTestVariablenSuspendvarupdate (RT Professional).....................................................1888

3.2.11.32 OnTestWinCCShutdown (RT Professional).......................................................................1888
3.2.11.33 Open project by means of dialog (RT Professional)..........................................................1889
3.2.11.34 Read tag (RT Professional)................................................................................................1890
3.2.11.35 Write tag (RT Professional)................................................................................................1895
3.3 Funciones del sistema gráfico (RT Professional)...............................................................1897
3.3.1.4 constantes (RT Professional).............................................................................................1900
3.3.1.5 Lista de las propiedades de objeto (A-K) (Graphics Designer) (RT Professional).............1901
3.3.1.6 Lista de las propiedades de objeto (L-Z) (Graphics Designer) (RT Professional).............1914
3.3.1.7 Llamadas de API en los OCX (RT Professional)...............................................................1927
3.3.2.1 LINKINFO (RT Professional)..............................................................................................1928
3.3.2.2 MULTILINK (RT Professional)...........................................................................................1930
3.3.2.3 MULTILINKINFO (RT Professional)...................................................................................1931
3.3.2.4 FOCUSINFO (RT Professional).........................................................................................1932
3.3.3.1 PDLRTClosePicture (RT Professional)..............................................................................1932
3.3.3.2 PDLRTDisableClosePicture (RT Professional)..................................................................1934
3.3.3.3 PDLRTEnableClosePicture (RT Professional)...................................................................1936
3.3.3.4 PDLRTGotoPicture (RT Professional)...............................................................................1937
3.3.3.5 PDLRTInquireFreeArea (RT Professional)........................................................................1939
3.3.3.6 PDLRTOpenPicture (RT Professional)..............................................................................1940
3.3.3.7 PDLRTPictureNavigation (RT Professional)......................................................................1943
3.3.3.8 PDLRTShowApp (RT Professional)...................................................................................1944
3.3.3.9 PDLRT_CALLBACK (RT Professional)..............................................................................1945
3.3.4 Funciones para influir en el cursor de runtime (RT Professional)......................................1947
3.3.4.1 PDLRTGetCursorKeys (RT Professional)..........................................................................1947
3.3.4.2 PDLRTGetFocus (RT Professional)...................................................................................1949
3.3.4.3 PDLRTSetCursorKeys (RT Professional)..........................................................................1951
3.3.4.4 PDLRTSetFocus (RT Professional)...................................................................................1953
3.3.5 Funciones para editar propiedades de objeto (RT Professional).......................................1956
3.3.5.1 PDLRTGetDefPropEx (RT Professional)...........................................................................1956
3.3.5.2 PDLRTGetPropEx (RT Professional).................................................................................1958
3.3.5.3 PDLRTSetPropEx (RT Professional).................................................................................1961
3.3.6 Funciones para editar dinámicas (RT Professional)..........................................................1966
3.3.6.1 PDLRTGetLink (RT Professional)......................................................................................1966
3.3.6.2 PDLRTSetLink (RT Professional)......................................................................................1968
3.3.6.3 PDLRTSetMultiLink (RT Professional)...............................................................................1970
3.4 Funciones del scripting (RT Professional).........................................................................1972
3.4.2.1 AP_ACT_KEY (RT Professional).......................................................................................1977
3.4.2.2 AP_ACT_RESULT_STRUCT (RT Professional)................................................................1979

Índice
3.4.2.3 CREATE_USER_HEADER_FILE (RT Professional)..........................................................1980

3.4.2.4 GENERATE_COMPILE (RT Professional)........................................................................1981
3.4.2.5 GET_ACTION_STREAM (RT Professional).......................................................................1982
3.4.3.1 APConnect (RT Professional)............................................................................................1983
3.4.3.2 APDisconnect (RT Professional)........................................................................................1985
3.4.3.3 APSetLanguage (RT Professional)....................................................................................1987
3.4.3.4 AP_RT_PROC (RT Professional).......................................................................................1988
3.4.4 Funciones para editar Source Code (RT Professional).....................................................1991
3.4.4.1 APCompile (RT Professional)............................................................................................1991
3.4.4.2 APCompileEx (RT Professional)........................................................................................1993
3.4.4.3 GSCGenCompile (RT Professional)..................................................................................1996
3.4.4.4 GSCGenCompileUserFunctions (RT Professional)...........................................................1997
3.4.5 Funciones para editar acciones (RT Professional)............................................................1998
3.4.5.1 GSCGenGetActionStream (RT Professional)....................................................................1998
3.4.6 Funciones de la programación de acción (RT Professional).............................................1999
3.4.6.1 APActive (RT Professional)................................................................................................1999
3.4.6.2 APEndAct (RT Professional)..............................................................................................2001
3.4.6.3 APFreeResultStruct (RT Professional)..............................................................................2003
3.4.6.4 APInactive (RT Professional).............................................................................................2004
3.4.6.5 APStart (RT Professional)..................................................................................................2006
3.4.6.6 APTransact (RT Professional)...........................................................................................2008
3.4.7.1 Establish connection to script programming (RT Professional).........................................2010
3.5 Funciones de la administración de usuarios (RT Professional).........................................2012
3.5.2.1 PWGEN_GROUPINFO (RT Professional).........................................................................2015
3.5.2.2 PWGEN_LEVELINFO (RT Professional)...........................................................................2016
3.5.2.3 PWGEN_USERINFO (RT Professional)............................................................................2017
3.5.3.1 PWGENConnect (RT Professional)...................................................................................2018
3.5.3.2 PWGENDisconnect (RT Professional)...............................................................................2019
3.5.4 Funciones para editar usuarios (RT Professional).............................................................2021
3.5.4.1 PWGENAddUser (RT Professional)...................................................................................2021
3.5.4.2 PWGENAddUserEx (RT Professional)..............................................................................2022
3.5.4.3 PWGENChangePassword (RT Professional)....................................................................2024
3.5.4.4 PWGENCheckUser (RT Professional)...............................................................................2026
3.5.4.5 PWGENDeleteUser (RT Professional)...............................................................................2027
3.5.4.6 PWGENEnumUsers (RT Professional)..............................................................................2028
3.5.4.7 PWGEN_ENUM_USERS_CALLBACK (RT Professional).................................................2030
3.5.5 Funciones para editar grupos de usuarios (RT Professional)............................................2031
3.5.5.1 PWGENAddGroup (RT Professional)................................................................................2031
3.5.5.2 PWGENEnumGroups (RT Professional)...........................................................................2033
3.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK (RT Professional)..............................................2034
3.5.6 Funciones para editar autorizaciones (RT Professional)...................................................2036
3.5.6.1 PWGENAddPermLevel (RT Professional).........................................................................2036
3.5.6.2 PWGENCheckPermission (RT Professional).....................................................................2037

Índice
3.5.6.3 PWGENDeletePermLevel (RT Professional).....................................................................2038

3.5.6.4 PWGENEnumPermLevels (RT Professional)....................................................................2040
3.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK (RT Professional)................................................2041
3.5.6.6 PWGENReadUserPerm (RT Professional)........................................................................2042
3.5.6.7 PWRTCheckPermission (RT Professional)........................................................................2044
3.5.6.8 PWRTCheckPermissionOnPicture (RT Professional)........................................................2045
3.5.6.9 PWRTPermissionLevelDialog (RT Professional)...............................................................2046
3.5.6.10 PWRTPermissionLevelDialogEx (RT Professional)...........................................................2047
3.5.6.11 PWRTPermissionToString (RT Professional)....................................................................2048
3.5.7 Funciones para iniciar y cerrar sesión (RT Professional)..................................................2049
3.5.7.1 PWRTGetCurrentUser (RT Professional)..........................................................................2049
3.5.7.2 PWRTGetLoginPriority (RT Professional)..........................................................................2050
3.5.7.3 PWRTIsLoggedInByCard (RT Professional)......................................................................2051
3.5.7.4 PWRTLogin (RT Professional)...........................................................................................2052
3.5.7.5 PWRTLogout (RT Professional).........................................................................................2054
3.5.7.6 PWRTLogoutEx (RT Professional)....................................................................................2055
3.5.7.7 PWRTSilentLogin (RT Professional)..................................................................................2056
3.5.7.8 PWRTSilentLoginEx (RT Professional)..............................................................................2057
3.5.8.1 PWRT check permission (RT Professional).......................................................................2059
3.5.8.2 Checks admission of a certain level for a picture (RT Professional)..................................2060
3.5.8.3 Gets a string associated with the permission number (RT Professional)...........................2061
3.5.8.4 Permission level query through a dialog with specifying a possible error (RT
Professional)......................................................................................................................2062
3.5.8.5 Return the name of the current user (RT Professional).....................................................2063
3.5.8.6 Queries the current login priority (RT Professional)...........................................................2064
3.5.8.7 Checks for the user has been logged on by card (RT Professional)..................................2064
3.5.8.8 PWRT login - dialog provided by WinCC itself (RT Professional)......................................2066
3.5.8.9 PWRT logout (RT Professional).........................................................................................2067
3.5.8.10 Silent logout with priority level (RT Professional)...............................................................2068
3.5.8.11 Login without using a dialog (RT Professional)..................................................................2069
3.5.8.12 Silent login with priority level (RT Professional).................................................................2070
3.6 Funciones del sistema de texto (RT Professional).............................................................2071
3.6.1.3 Códigos de idioma (RT Professional)................................................................................2073
3.6.2.1 TXTCloseProject (RT Professional)...................................................................................2074
3.6.2.2 TXTGetMaxTextID (RT Professional)................................................................................2076
3.6.2.3 TXTOpenProject (RT Professional)...................................................................................2077
3.6.2.4 TXTRTConnect (RT Professional)....................................................................................2079
3.6.2.5 TXTRTDisconnect (RT Professional).................................................................................2080
3.6.3 Funciones para la edición de textos de ayuda (RT Professional)......................................2081
3.6.3.1 TXTEnumInfoText (RT Professional).................................................................................2081
3.6.3.2 TXT_ENUM_INFOTEXTS_PROC (RT Professional).........................................................2083
3.6.3.3 TXTUpdateRuntime (RT Professional)..............................................................................2084
3.6.3.4 TXTRTGetInfoText (RT Professional)................................................................................2086
3.6.3.5 TXTRTGetInfoTextMC (RT Professional)..........................................................................2087
3.6.4 Funciones para la edición de idiomas (RT Professional)...................................................2089
3.6.4.1 TXTEnumLanguages (RT Professional)............................................................................2089
3.6.4.2 TXT_ENUM_LANGUAGES_PROC (RT Professional).......................................................2091

Índice
3.6.4.3 TXTGetFont (RT Professional)..........................................................................................2092

3.6.4.4 TXTShowLanguagesDialog (RT Professional)..................................................................2094
3.6.4.5 TXTRTGetLanguageID (RT Professional).........................................................................2095
3.6.4.6 TXTRTSetLanguage (RT Professional).............................................................................2097
3.6.5.1 Obtener texto de ayuda (RT Professional).........................................................................2098
3.6.5.2 Enumerar textos de ayuda (RT Professional)....................................................................2100
3.7 Funciones del sistema de informes (RT Professional).......................................................2102
3.7.1.4 Lista de las propiedades de objeto (RT Professional).......................................................2106
3.7.1.5 Procedimiento general para editar propiedades de trabajos de impresión (Report
Designer) (RT Professional)...............................................................................................2111
3.7.2 Funciones para establecer una conexión (RT Professional).............................................2115
3.7.2.1 RPJAttach (RT Professional).............................................................................................2115
3.7.2.2 RPJDetach (RT Professional)............................................................................................2116
3.7.2.3 RPJMemFree (RT Professional)........................................................................................2117
3.7.3 Funciones para editar propiedades del proyecto (RT Professional)..................................2118
3.7.3.1 RPJGetNumProjectProperties (RT Professional)..............................................................2118
3.7.3.2 RPJGetProjectPropertyAt (RT Professional).....................................................................2119
3.7.3.3 RPJGetProjectProperty (RT Professional).........................................................................2120
3.7.3.4 RPJProjectLock (RT Professional).....................................................................................2121
3.7.3.5 RPJProjectUnlock (RT Professional).................................................................................2123
3.7.3.6 RPJProjectUnlockAll (RT Professional).............................................................................2124
3.7.4 Funciones para editar trabajos de impresión (RT Professional)........................................2125
3.7.4.1 RPJCreateJob (RT Professional).......................................................................................2125
3.7.4.2 RPJDeleteJob (RT Professional).......................................................................................2127
3.7.4.3 RPJCreatePropertyHandle (RT Professional)....................................................................2128
3.7.4.4 RPJDeletePropertyHandle (RT Professional)....................................................................2129
3.7.4.5 RPJGetJobNameAt (RT Professional)...............................................................................2131
3.7.4.6 RPJGetNumJobs (RT Professional)..................................................................................2132
3.7.4.7 RPJJobLock (RT Professional)..........................................................................................2133
3.7.4.8 RPJJobUnlock (RT Professional).......................................................................................2135
3.7.4.9 RPJJobUnlockAll (RT Professional)...................................................................................2136
3.7.5 Funciones para editar métodos de trabajos de impresión (RT Professional)....................2138
3.7.5.1 RPJCallJobMethod (RT Professional)...............................................................................2138
3.7.5.2 RPJGetJobMethodAt (RT Professional)............................................................................2139
3.7.5.3 RPJGetNumJobMethods (RT Professional)......................................................................2140
3.7.6 Funciones para editar propiedades de trabajo de impresión (RT Professional)................2141
3.7.6.1 RPJGetJobPropertyAt (RT Professional)...........................................................................2141
3.7.6.2 RPJGetJobProps (RT Professional)..................................................................................2143
3.7.6.3 RPJGetNumJobProperties (RT Professional)....................................................................2144
3.7.6.4 RPJGetProperty (RT Professional)....................................................................................2145
3.7.6.5 RPJPropertyClear (RT Professional).................................................................................2148
3.7.6.6 RPJSetProperty (RT Professional)....................................................................................2150
3.7.7.1 Obtener nombre de método del trabajo de impresión (RT Professional)...........................2153
3.7.7.2 Obtener nombres de trabajo de impresión (RT Professional)............................................2156
3.7.7.3 Obtener propiedades del trabajo de impresión (RT Professional).....................................2159
3.7.7.4 Modify print job properties (RT Professional).....................................................................2162

Índice
3.7.7.5 Show print job preview (RT Professional)..........................................................................2167

3.8 Funciones para variables y ficheros (RT Professional)......................................................2170
3.8.2.1 TLG_ARCHIV_STR (RT Professional)...............................................................................2184
3.8.2.2 TLG_ARCHIVDATARAW (RT Professional)......................................................................2187
3.8.2.3 TLG_BACKUP_TABLE_INFO (RT Professional)...............................................................2190
3.8.2.4 TLG_CURVESCALEX (RT Professional)...........................................................................2192
3.8.2.5 TLG_CURVESCALEY (RT Professional)...........................................................................2197
3.8.2.6 TLG_GETARCHIVDATA (RT Professional).......................................................................2201
3.8.2.7 TLG_IO_BACKUP_SELECT (RT Professional).................................................................2202
3.8.2.8 TLG_PROT_CURVE_INFOS (RT Professional)................................................................2203
3.8.2.9 TLG_SCAL_STR (RT Professional)...................................................................................2205
3.8.2.10 TLG_TABLE_INFO (RT Professional)................................................................................2206
3.8.2.11 TLG_TABLESCALE (RT Professional)..............................................................................2207
3.8.2.12 TLG_TEMPLATEITEM_INFO (RT Professional)...............................................................2210
3.8.2.13 TLG_TIME_STR (RT Professional)....................................................................................2212
3.8.2.14 TLG_TIMEDATA (RT Professional)...................................................................................2213
3.8.2.15 TLG_TPLITEM_CURVE (RT Professional)........................................................................2214
3.8.2.16 TLG_TPLITEM_INFO (RT Professional)............................................................................2215
3.8.2.17 TLG_TPLITEM_TABLE (RT Professional).........................................................................2216
3.8.2.18 TLG_VAR_STR (RT Professional).....................................................................................2217
3.8.2.19 TLG_VARIABLE_INFO (RT Professional).........................................................................2223
3.8.3.1 TLGCSConnect (RT Professional).....................................................................................2224
3.8.3.2 TLGCSConnectEx (RT Professional).................................................................................2225
3.8.3.3 TLGCSDisConnect (RT Professional)................................................................................2226
3.8.3.4 TLGChangeLanguage (RT Professional)...........................................................................2228
3.8.3.5 TLGConnect (RT Professional)..........................................................................................2229
3.8.3.6 TLGDisconnect (RT Professional).....................................................................................2230
3.8.4 Funciones de administración del proyecto (RT Professional)............................................2232
3.8.4.1 TLGCloseProject (RT Professional)...................................................................................2232
3.8.4.2 TLGOpenProject (RT Professional)...................................................................................2233
3.8.4.3 TLGEnumProject (RT Professional)...................................................................................2235
3.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK (RT Professional).......................................2236
3.8.5 Funciones para editar variables (RT Professional)............................................................2237
3.8.5.1 TLGEnumVariables (RT Professional)...............................................................................2237
3.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK (RT Professional).......................................2239
3.8.5.3 TLGEnumVariablesEx (RT Professional)...........................................................................2240
3.8.5.4 TLG_ENUMVARIABLES (RT Professional).......................................................................2242
3.8.5.5 TLGReadVariable (RT Professional).................................................................................2243
3.8.6 Funciones para editar ficheros (RT Professional)..............................................................2245
3.8.6.1 TLGEnumArchives (RT Professional)................................................................................2245
3.8.6.2 TLG_ENUM_ARCHIV_CALLBACK (RT Professional).......................................................2246
3.8.6.3 TLGEnumArchivs (RT Professional)..................................................................................2247
3.8.6.4 TLGEnumArchivsEx (RT Professional)..............................................................................2249
3.8.6.5 TLGEnumArchivsSel (RT Professional).............................................................................2251
3.8.6.6 TLG_ENUMTABLES (RT Professional).............................................................................2253

Índice
3.8.6.7 TLGFreeMemory (RT Professional)...................................................................................2255

3.8.6.8 TLGGetArchivData (RT Professional)................................................................................2256
3.8.6.9 TLG_GETARCHIVDATA_CALLBACK (RT Professional)..................................................2258
3.8.6.10 TLGGetArchivDataEx (RT Professional)............................................................................2259
3.8.6.11 TLGGetClosestTime (RT Professional).............................................................................2262
3.8.6.12 TLGGetClosestTimeEx (RT Professional).........................................................................2264
3.8.6.13 TLGInsertArchivData (RT Professional).............................................................................2266
3.8.6.14 TLGLockArchiv (RT Professional)......................................................................................2269
3.8.6.15 TLGLockVariable (RT Professional)..................................................................................2270
3.8.6.16 TLGReadArchiv (RT Professional).....................................................................................2271
3.8.7 Funciones para representación de curvas y tablas (RT Professional)...............................2273
3.8.7.1 TLGCloseWindow (RT Professional).................................................................................2273
3.8.7.2 TLGDrawCurvesInDC (RT Professional)...........................................................................2274
3.8.7.3 TLGInsertTemplateItem (RT Professional)........................................................................2275
3.8.7.4 TLGPressToolbarButton (RT Professional).......................................................................2277
3.8.7.5 TLGSetRulerWindowVisible (RT Professional)..................................................................2279
3.8.7.6 TLGShowWindow (RT Professional).................................................................................2280
3.8.8 Funciones para procesar sistemas de tiempo (RT Professional)......................................2281
3.8.8.1 TLGEnumTime (RT Professional)......................................................................................2281
3.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK (RT Professional)................................................2283
3.8.8.3 TLGEnumTimes (RT Professional)....................................................................................2284
3.8.8.4 TLG_ENUMTIMES_CALLBACK (RT Professional)...........................................................2285
3.8.8.5 TLGReadTime (RT Professional).......................................................................................2287
3.8.9 Funciones para proteger y restaurar (RT Professional).....................................................2288
3.8.9.1 TLGEnumBackupEntries (RT Professional).......................................................................2288
3.8.9.2 TLG_ENUMBACKUP_ENTRIES (RT Professional)...........................................................2289
3.8.9.3 TLGExport (RT Professional).............................................................................................2291
3.8.9.4 TLGGetBackupSize (RT Professional)..............................................................................2293
3.8.10.1 Edit curve template - Example 1 (RT Professional)...........................................................2295
3.8.10.2 Enum all acquisition and archiving times (RT Professional)..............................................2298
3.8.10.3 Enum archives (RT Professional)......................................................................................2301
3.8.10.4 Enum variables of an archive (RT Professional)................................................................2304
3.8.10.5 Enumerate archives (RT Professional)..............................................................................2306
3.8.10.6 Read archive (RT Professional).........................................................................................2308
3.8.10.7 Read parameters of time object (RT Professional)............................................................2312
3.9 Funciones para recetas (RT Professional).........................................................................2314
3.9.1.2 Estructura de las recetas (RT Professional)......................................................................2316
3.9.1.3 Dependencias de la secuencia de llamada de las funciones API (RT Professional).........2318
3.9.2.1 uaCONFIGARCHIVE (RT Professional)............................................................................2322
3.9.2.2 uaCONFIGFIELD (RT Professional)..................................................................................2324
3.9.3.1 uaGetLastError (RT Professional)......................................................................................2325
3.9.3.2 uaIsActive (RT Professional)..............................................................................................2327
3.9.3.3 uaUsers (RT Professional).................................................................................................2328
3.9.3.4 uaSetLocalEvents (RT Professional).................................................................................2329
3.9.4 Funciones para establecimiento de conexión (RT Professional).......................................2330

Índice
3.9.4.1 uaConnect (RT Professional).............................................................................................2330

3.9.4.2 uaDisconnect (RT Professional)........................................................................................2331
3.9.4.3 uaQueryArchive (RT Professional)....................................................................................2332
3.9.4.4 uaQueryArchiveByName (RT Professional).......................................................................2335
3.9.4.5 uaQueryConfiguration (RT Professional)...........................................................................2337
3.9.4.6 uaReleaseArchive (RT Professional).................................................................................2338
3.9.4.7 uaReleaseConfiguration (RT Professional)........................................................................2339
3.9.5 Funciones para la edición de recetas (RT Professional)...................................................2340
3.9.5.1 uaArchiveClose (RT Professional).....................................................................................2340
3.9.5.2 uaArchiveDelete (RT Professional)....................................................................................2342
3.9.5.3 uaArchiveExport (RT Professional)....................................................................................2343
3.9.5.4 uaArchiveGetID (RT Professional).....................................................................................2344
3.9.5.5 uaArchiveGetName (RT Professional)...............................................................................2345
3.9.5.6 uaArchiveGetSort (RT Professional)..................................................................................2346
3.9.5.7 uaArchiveImport (RT Professional)....................................................................................2348
3.9.5.8 uaArchiveOpen (RT Professional).....................................................................................2349
3.9.5.9 uaArchiveUpdate (RT Professional)...................................................................................2350
3.9.5.10 uaGetArchive (RT Professional)........................................................................................2351
3.9.5.11 uaGetNumArchives (RT Professional)...............................................................................2352
3.9.5.12 uaOpenArchives (RT Professional)....................................................................................2353
3.9.6 Funciones para la edición de elementos de receta (RT Professional)...............................2354
3.9.6.1 uaArchiveGetCount (RT Professional)...............................................................................2354
3.9.6.2 uaArchiveGetFilter (RT Professional)................................................................................2355
3.9.6.3 uaArchiveInsert (RT Professional).....................................................................................2357
3.9.6.4 uaArchiveMoveFirst (RT Professional)..............................................................................2358
3.9.6.5 uaArchiveMoveLast (RT Professional)...............................................................................2359
3.9.6.6 uaArchiveMoveNext (RT Professional)..............................................................................2360
3.9.6.7 uaArchiveMovePrevious (RT Professional).......................................................................2361
3.9.6.8 uaGetNumFields (RT Professional)...................................................................................2362
3.9.7 Funciones para la edición de campos (RT Professional)...................................................2363
3.9.7.1 uaArchiveGetFieldLength (RT Professional)......................................................................2363
3.9.7.2 uaArchiveGetFieldName (RT Professional).......................................................................2364
3.9.7.3 uaArchiveGetFields (RT Professional)...............................................................................2365
3.9.7.4 uaArchiveGetFieldType (RT Professional).........................................................................2366
3.9.7.5 uaArchiveGetFieldValueDate (RT Professional)................................................................2367
3.9.7.6 uaArchiveGetFieldValueDouble (RT Professional)............................................................2368
3.9.7.7 uaArchiveGetFieldValueLong (RT Professional)...............................................................2370
3.9.7.8 uaArchiveGetFieldValueString (RT Professional)..............................................................2371
3.9.7.9 uaArchiveSetFieldValueDate (RT Professional)................................................................2372
3.9.7.10 uaArchiveSetFieldValueDouble (RT Professional)............................................................2373
3.9.7.11 uaArchiveSetFieldValueLong (RT Professional)................................................................2374
3.9.7.12 uaArchiveSetFieldValueString (RT Professional)..............................................................2376
3.9.7.13 uaGetField (RT Professional).............................................................................................2377
3.9.8 Funciones para la filtración y clasificación (RT Professional)............................................2378
3.9.8.1 uaArchiveRequery (RT Professional).................................................................................2378
3.9.8.2 uaArchiveSetFilter (RT Professional).................................................................................2379
3.9.8.3 uaArchiveSetSort (RT Professional)..................................................................................2381
3.9.9 Funciones para la edición de vistas de receta (RT Professional)......................................2382
3.9.9.1 uaOpenViews (RT Professional)........................................................................................2382
3.9.10 Funciones para la edición de variables (RT Professional).................................................2383
3.9.10.1 uaArchiveReadTagValues (RT Professional)....................................................................2383
3.9.10.2 uaArchiveReadTagValuesByName (RT Professional).......................................................2384

Índice
3.9.10.3 uaArchiveWriteTagValues (RT Professional).....................................................................2385

3.9.10.4 uaArchiveWriteTagValuesByName (RT Professional).......................................................2387
3.10 Funciones para avisos (RT Professional)..........................................................................2388
3.10.2.1 MSG_RTCREATE_STRUCT_PLUS (RT Professional).....................................................2404
3.10.2.2 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (RT Professional)....................2406
3.10.2.3 MSG_FILTER_STRUCT_PLUS (RT Professional)............................................................2410
3.10.2.4 MSG_RTDATA_INSTANCE_STRUCT_PLUS (RT Professional)......................................2414
3.10.2.5 MSG_CLASS_STRUCT_PLUS (RT Professional).............................................................2417
3.10.2.6 MSG_CSDATA_STRUCT_PLUS (RT Professional)..........................................................2419
3.10.2.7 MSG_RTGROUPENUM_STRUCT_PLUS (RT Professional)............................................2422
3.10.2.8 MSG_RTGROUPSET_STRUCT_PLUS (RT Professional)................................................2423
3.10.2.9 MSG_COMMENT_INSTANCE_STRUCT_PLUS (RT Professional)..................................2424
3.10.2.10 MSG_INFOTEXT_STRUCT_PLUS (RT Professional).......................................................2425
3.10.2.11 MSG_BACKUP_STRUCT_PLUS (RT Professional)..........................................................2426
3.10.2.12 MSG_RTLOCK_STRUCT_PLUS (RT Professional)..........................................................2428
3.10.2.13 MSG_TEXTVAL256_STRUCT_PLUS (RT Professional)...................................................2429
3.10.2.14 MSGULONGLONG (RT Professional)...............................................................................2430
3.10.3.1 MSRTEnumArchivDataPlus (RT Professional)..................................................................2431
3.10.3.2 MSRTStartMsgServicePlus (RT Professional)...................................................................2433
3.10.3.3 MSRTStopMsgServicePlus (RT Professional)...................................................................2436
3.10.3.4 MSRTQuitHornPlus (RT Professional)...............................................................................2438
3.10.3.5 MSG_SERVICE_NOTIFY_PROC_PLUS (RT Professional)..............................................2439
3.10.3.6 MSRTWebClientPlus (RT Professional)............................................................................2442
3.10.4 Funciones para la edición de protocolos (RT Professional)..............................................2443
3.10.4.1 MSRTActivateMProtPlus (RT Professional).......................................................................2443
3.10.4.2 MSRTPrintMProtPlus (RT Professional)............................................................................2444
3.10.5 Funciones para la edición de avisos (RT Professional).....................................................2445
3.10.5.1 MSRTEnumArchivInstancePlus (RT Professional)............................................................2445
3.10.5.2 MSRTCreateMsgInstanceWithCommentPlus (RT Professional).......................................2446
3.10.5.3 MSRTCreateMsgInstancePlus (RT Professional)..............................................................2448
3.10.5.4 MSRTDialogMsgLockPlus (RT Professional)....................................................................2450
3.10.5.5 MSRTCreateMsgPlus (RT Professional)...........................................................................2451
3.10.5.6 MSRTEnumLockedMsgPlus (RT Professional).................................................................2453
3.10.5.7 MSRTEnumMsgRTDataPlus (RT Professional)................................................................2454
3.10.5.8 MSRTGetClassInfoPlus (RT Professional)........................................................................2455
3.10.5.9 MSRTGetMsgAttributesPlus (RT Professional).................................................................2457
3.10.5.10 MSRTGetLastMsgWithCommentPlus (RT Professional)...................................................2459
3.10.5.11 MSRTGetMsgActualPlus (RT Professional)......................................................................2461
3.10.5.12 MSRTGetMsgCSDataPlus (RT Professional)....................................................................2462
3.10.5.13 MSRTGetMsgPriorityPlus (RT Professional).....................................................................2465
3.10.5.14 MSRTGetMsgQuitPlus (RT Professional)..........................................................................2466
3.10.5.15 MSRTGetMsgTextPlus (RT Professional).........................................................................2468
3.10.5.16 MSRTGetSelectedMsgPlus (RT Professional)..................................................................2469
3.10.5.17 MSRTResetMsgPlus (RT Professional).............................................................................2471
3.10.5.18 MSRTLoopInAlarmPlus (RT Professional).........................................................................2473

Índice
3.10.6 Funciones para la edición de grupos de aviso (RT Professional)......................................2474

3.10.6.1 MSRTEnumGroupMsgPlus (RT Professional)...................................................................2474
3.10.6.2 MSRTLockGroupPlus (RT Professional)...........................................................................2476
3.10.6.3 MSRTQuitGroupPlus (RT Professional)............................................................................2477
3.10.7 Funciones para la edición de filtros de aviso (RT Professional)........................................2479
3.10.7.1 MSRTGetFilterDataPlus (RT Professional)........................................................................2479
3.10.7.2 MSRTCheckWinFilterPlus (RT Professional).....................................................................2480
3.10.7.3 MSRTSetMsgFilterPlus (RT Professional).........................................................................2482
3.10.7.4 MSRTSetMsgWinFilterPlus (RT Professional)...................................................................2483
3.10.8 Funciones para editar el visor de avisos (RT Professional)...............................................2485
3.10.8.1 MSRTMsgWinCommandPlus (RT Professional)...............................................................2485
3.10.9 Funciones para editar comentarios (RT Professional).......................................................2487
3.10.9.1 MSRTGetCommentInstancePlus (RT Professional)..........................................................2487
3.10.9.2 MSRTSetCommentInstancePlus (RT Professional)..........................................................2488
3.10.10 Funciones para la edición de textos de información (RT Professional).............................2490
3.10.10.1 MSRTGetInfotextPlus (RT Professional)...........................................................................2490
3.10.10.2 MSRTSetInfotextPlus (RT Professional)............................................................................2491
3.10.11 Funciones de archivo (RT Professional)............................................................................2493
3.10.11.1 MSRTEnumBackupListPlus (RT Professional)..................................................................2493
3.10.11.2 MSRTExportPlus (RT Professional)...................................................................................2494
3.11 Funciones para visualizar códigos PLC (RT Professional)................................................2496
3.11.1 Visualización en STEP 7 (RT Professional).......................................................................2496
3.11.1.1 Principios básicos (RT Professional).................................................................................2496
3.11.1.2 OpenTIAPortalProject (RT Professional)...........................................................................2497
3.11.1.3 OpenTIAPortalIECPLByCall (RT Professional)..................................................................2498
3.11.1.4 OpenTIAPortalIECPLByAssignment (RT Professional).....................................................2501
3.11.1.5 OpenTIAPortalS7GraphByBlock (RT Professional)...........................................................2503
3.11.1.6 Ejemplo: Integración en una función WinCC (RT Professional)........................................2506
3.11.2 Visualización en el visor de código PLC (RT Professional)...............................................2507
3.11.2.1 Principios básicos (RT Professional).................................................................................2507
3.11.2.2 OpenViewerS7GraphByBlock (RT Professional)...............................................................2508
3.11.2.3 OpenViewerIECPLByCall (RT Professional)......................................................................2510
3.11.2.4 OpenViewerIECPLByFCCall (RT Professional).................................................................2514
3.11.2.5 OpenViewerIECPLByAssignment (RT Professional).........................................................2517
3.11.2.6 IsJumpableProDiagAlarm (RT Professional).....................................................................2519
3.11.3 Tratamiento de errores (RT Professional)..........................................................................2521
3.12 Funciones para visualizar código PLC en una aplicación externa (RT Professional)........2523
3.12.2 Consulta de información estática de segmentos (RT Professional)..................................2525
3.12.2.1 Initialize (RT Professional).................................................................................................2525
3.12.2.2 SetLanguage (RT Professional).........................................................................................2525
3.12.2.3 RequestByAssignment (RT Professional)..........................................................................2526
3.12.2.4 RequestByCall (RT Professional)......................................................................................2527
3.12.2.5 CancelRequest (RT Professional)......................................................................................2529
3.12.2.6 Terminate (RT Professional)..............................................................................................2529
3.12.2.7 Estructura de los datos XML (RT Professional).................................................................2530
3.12.3 Consulta de información dinámica de segmentos (RT Professional)................................2533
3.12.3.1 StartDynamicDataSubscription (RT Professional).............................................................2533
3.12.3.2 StopDynamicSubscription (RT Professional).....................................................................2534
3.13 Tratamiento de errores (RT Professional)..........................................................................2535
3.13.1 CMN_ERROR (RT Professional).......................................................................................2535

Índice
3.13.2 CCStorageError.h (RT Professional).................................................................................2536

Índice alfabético......................................................................................................................................2549

Índice

VB Scripting 1
1.1 Funciones de sistema (Panels, Comfort Panels, RT Advanced)
1.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)
Descripción
Acusa todos los avisos seleccionados.
Utilice esta función de sistema si el panel de operador no tiene ninguna tecla de acuse o si
no debe emplearse la tecla integrada del visor de avisos.
Esta función de sistema sólo se puede utilizar para teclas de función.
Utilización en la lista de funciones

AcusarAviso
Utilización en funciones definidas por el usuario

AcknowledgeAlarm
Utilizable, siempre que el dispositivo configurado soporte funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del dispositivo".
Parámetros
--
1.1.2 ActivatePLCCodeView (Panels, Comfort Panels, RT Advanced)
Descripción
Efectúa un cambio de imagen para visualizar la imagen indicada con el visor de código PLC.
El visor de código PLC muestra el código de programa de la red en cuestión.
La función de sistema ActivarVisorCódigoPLC se configura para el evento "Hacer clic en el
botón Visor de código PLC" de una vista general de GRAPH, o para un evento de un botón.
Cambio de imagen desde la vista general de GRAPH
La función de sistema se configura para el evento "Hacer clic en el botón Visor de código PLC"
en una vista general de GRAPH para representar la cadena secuencial GRAPH en el visor

VB Scripting
de código PLC. Si no hay fallos presentes, en el visor de código PLC se mostrará la secuencia
de la cadena GRAPH.
Si se produce un error, en el visor de código PLC se mostrará la etapa errónea tras el salto.
Si se han producido varios errores, tras el salto se mostrará la primera etapa errónea de la
cadena secuencial. Si ha solucionado el error, en el visor se mostrará automáticamente la
siguiente etapa errónea. En la vista detallada, se mostrará según el tipo de error, la transición
o el enclavamiento (Interlock).
Cambio de imagen de un aviso
La función de sistema se puede configurar en un evento de un botón. Al pulsar el botón en
runtime, la función de sistema comprueba si el último aviso seleccionado en el visor de avisos
configurado es un aviso de supervisión o un aviso GRAPH. Si es posible el salto para este
aviso, se abre el visor de código PLC configurado con el código de programa correspondiente.
Es posible saltar desde un aviso del visor de avisos al visor de código PLC con los siguientes
avisos de supervisión:
● En supervisiones globales, solo con supervisiones de enclavamiento (Interlock)
● En supervisiones locales, con todas las supervisiones básicas de parámetros de entrada
Para más información sobre supervisiones, consulte el capítulo "Programación del PLC >
Supervisión de máquinas e instalaciones con ProDiag".
El salto al visor de código PLC es posible para todos los avisos GRAPH. Tras el salto, en el
visor de código PLC se muestran la cadena secuencial GRAPH y la etapa errónea.
Si hay presentes simultáneamente un aviso de supervisión y un aviso de enclavamiento para
la misma etapa, tras el disparo de la función de sistema, en el visor de código PLC se mostrará
siempre primero el segmento de enclavamiento, independientemente de si estaba
seleccionado el aviso de supervisión o el de enclavamiento.
Para saltar de un aviso de supervisión al visor de código PLC cuando se usan operandos
locales soportados en un bloque de función, el nombre de la instancia debe cumplir la siguiente
convención: <FB-Name>_DB.
Solo es posible saltar a una función o a un bloque de organización si se usan exclusivamente
operandos globales.
Nota
No se soporta el salto en combinación con el búfer de avisos o el fichero de avisos.

ActivarVisorCódigoPLC(Nombre de imagen, Objeto de imagen)

ActivatePLCCodeView Screen_name, Object_name

VB Scripting
Utilizable, siempre que el panel configurado admita funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del panel de operador".
Nota
Para entrar en la cadena secuencial GRAPH mediante la función de sistema
"ActivarVisorCódigoPLC", la versión del bloque GRAPH debe ser por lo menos V3.0.
Nota
El uso de la función de sistema "ActivarVisorCódigoPLC" en un script de VB no tiene ningún
efecto en la vista general de GRAPH.
Parámetros
Nombre de imagen
Nombre de la imagen que contiene el visor de código PLC.
Nota
No se soporta el cambio a una imagen emergente o a una imagen deslizable.
Objeto de imagen
Nombre de objeto del visor de código PLC.
1.1.3 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Cambia a la imagen que estaba activada antes de cambiar a la imagen actual. El cambio de
imagen no se ejecuta si antes no había ninguna imagen activa.
Se guardan las últimas 10 imágenes activadas. Si cambia a una imagen que ya no está
guardada, aparecerá un aviso del sistema.
Nota
Si desea utilizar la función de sistema, la imagen a la que desea cambiar deberá estar
contenida en la estructura de navegación.

VB Scripting

ActivarImagenAnterior

ActivatePreviousScreen
Parámetros
--
1.1.4 ActivateScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Efectúa un cambio de imagen para visualizar la imagen indicada.
Para pasar de la imagen raíz al área permanente o viceversa, utilice la función del sistema
"ActivarImagenConNúmero".

ActivarImagen (Nombre de imagen, Número del objeto)

ActivateScreen Screen_name, Object_number
Parámetros
Nombre de imagen
Nombre de la imagen a la que se cambia.
Número del objeto

Elemento de manejo que se resalta en la imagen indicada después del cambio de imagen. El
número del elemento de manejo se define mediante el orden de tabulación durante la
configuración.

VB Scripting
Si indica "0":
● Si al ejecutarse la función de sistema está enfocada el área permanente, esta permanecerá
enfocada.
● En cambio, si está resaltada la imagen raíz, se destacará el primer elemento de manejo
de la imagen indicada.
Nota
Si la función de sistema "ActivarImagen" se asocia al evento "Margen alcanzado", sólo se
admite el valor 0 para el parámetro "Número del objeto". El objeto activo no se establece
conforme al número de objeto, sino según la coordenada X del objeto activo antes del
cambio de imagen.
Ejemplo
El siguiente código de programa activa la imagen "Screen_2" con la función ActivateScreen,
p. ej., al pulsar un botón.
Sub ActivateScreen_2()
'Userdefined code
'' i. e. when pressing a button
ActivateScreen "Screen_2",0
1.1.5 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced)
Descripción
Dependiendo del valor de una variable, cambia a una imagen determinada.
La imagen se identifica por su número de imagen.

ActivarImagenConNúmero (Número de imagen, Número del objeto)

ActivateScreenByNumber Screen_number, Object_number

VB Scripting
Parámetros
Número de imagen
Variable que contiene el número de imagen a la que se cambia.
Si desea conmutar entre la imagen raíz y el área permanente, y viceversa, introduzca "0" o
"-1", respectivamente.
0 = Cambia de la imagen raíz al área permanente.
-1 = Cambia del área permanente a la imagen raíz.
Número del objeto

Número del objeto de imagen que se resalta en la imagen indicada después del cambio de
imagen. El número del elemento de manejo se define mediante el orden de tabulación durante
la configuración.
Si indica "0":
enfocada.
1.1.6 ActivateSystemDiagnosticsView (Panels, Comfort Panels, RT Advanced)
Descripción
Activa el visor de diagnóstico del sistema. El visor de diagnóstico del sistema muestra la vista
detallada del dispositivo afectado.

VisorDiagnósticoSistemaActivar(Nombre de imagen, Objeto de imagen)

ActivateSystemDiagnosticsView Screen_name, Object_name
Parámetros
Nombre de imagen
Nombre de la imagen que contiene el visor de diagnóstico del sistema.
Objeto de imagen
Nombre de objeto del visor de diagnóstico del sistema.

VB Scripting
1.1.7 ArchiveLogFile (Panels, Comfort Panels, RT Advanced)
Descripción
Esta función de sistema desplaza o copia un fichero para archivarlo a largo plazo en una
ubicación diferente.
Antes de"ArchivarArchivoDeInforme" ejecute siempre la función de sistema
"CerrarTodosLosFicheros".
Tras concluir esta función de sistema, ejecute la función de sistema "AbrirTodosLosFicheros".
En el modo "Copiar fichero", los ficheros se vuelven a abrir sólo tras haberse copiado
correctamente el fichero, o bien si se excede el tiempo previsto para la operación de copia.
En el modo "Desplazar fichero" se cambia el nombre de los ficheros a desplazar y se abren
de inmediato los nuevos ficheros. Para desplazar los ficheros cuyo nombre ha cambiado, se
lanza una petición que intenta desplazarlos cada 300 segundos en caso de que el directorio
de destino no esté disponible. Dicha petición permanece activa hasta ser ejecutada, incluso
después de un rearranque completo del runtime. Por tanto, antes de desplazar un fichero,
deberá comprobar si el directorio de destino está disponible.
Utilice en el caso de los Audit Trails siempre el modo "Desplazar (hmiMove)", puesto que de
lo contrario se infringirá la directiva FDA debido a la doble gestión de datos.

ArchivarArchivoDeInforme (Tipo de fichero, Fichero, Nombre del directorio, Modo)

ArchiveLogFile Log_type, Log, Directory_name, Mode
Parámetros
Tipo de fichero
Determina el tipo de fichero:
0 (hmiTagArchive) = Fichero de variables
1 (hmiAlarmArchive) = Fichero de avisos
2 (hmiAudittrailArchive)= Fichero Audit Trail disponible en proyectos conformes a GMP.
Encontrará más información en "Activar configuración conforme a GMP".
Fichero
Nombre del fichero a archivar.
Nombre del directorio

Ruta en la que se guarda el fichero.

VB Scripting
Modo
0 (hmiCopy) = Copiar fichero
1 (hmiMove) = Desplazar fichero
Ejemplo de aplicación
Hay que desplazar un fichero del medio de almacenamiento local al servidor con el fin de crear
una copia de seguridad en intervalos regulares.
Indicaciones relativas a la configuración
En el planificador de tareas, cree una tarea que se ejecute cada día a una hora determinada.
Asocie la lista de funciones siguiente a la tarea:
Proceso en el panel de operador

● Todos los ficheros abiertos se cierran.
● El fichero indicado se desplaza al servidor.
● Todos los ficheros cerrados se abren de nuevo.
1.1.8 BackupRAMFileSystem (Panels, Comfort Panels, RT Advanced)
Descripción
Guarda el sistema de archivos RAM en el soporte de memoria del panel de operador.
Tras reiniciar el panel de operador volverán a cargarse automáticamente los datos en el
sistema de archivos RAM.

VB Scripting
Las aplicaciones como el Internet Explorer guardan datos temporalmente en el sistema de

archivos DRAM del panel de operador (p.ej. las últimas páginas web llamadas).

CopiaSeguridadSistemaDeArchivosRAM

BackupRAMFileSystem
Parámetros
--
1.1.9 CalibrateTouchScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Ejecuta un programa para calibrar la pantalla táctil.
Durante la calibración se pedirá al operador que toque cinco posiciones en la pantalla táctil.
Para confirmar el proceso de calibración, toque la pantalla táctil en un intervalo de 30
segundos. Si no toca la pantalla táctil dentro de ese intervalo, los ajustes de calibrado se
rechazan. La guía del usuario está en inglés.
Utilice esta función de sistema al poner en marcha el panel de operador por primera vez.
Nota
Con la función de sistema se restablecen las teclas directas utilizadas.

CalibrarPantallaTáctil

CalibrateTouchScreen
Puede utilizarse siempre que el panel configurado soporte funciones definidas por el usuario.

VB Scripting
Parámetros
--
Nota
La función de sistema CalibrarPantallaTáctil no puede ser simulada.
1.1.10 ChangeConnection (Panels, Comfort Panels, RT Advanced)
Descripción
Deshace la conexión con el controlador que se está utilizando y establece una conexión con
un controlador con una dirección distinta. El controlador recién conectado debe pertenecer a
la misma clase de dispositivo (S7-300, S7-400, etc.).
Nota
Al cambiar a una dirección diferente, vigile que esta dirección no esté siendo utilizada por otro
panel de operador.
Se admiten los siguientes tipos de dirección:

● Dirección IP
● Dirección MPI
Se admiten los siguientes tipos de controlador:
● SIMATIC S7 300/400
● SIMATIC S7 200
● SIMATIC S7 1200 (versión de panel hasta V11)
● SIMATIC S7 LOGO!
● SIMATIC S7 NC
● SIMOTION

CambiarConexión (Conectar, Dirección, Slot, Rack)

ChangeConnection Connection, Address, Slot, Rack

VB Scripting
Parámetros
Conexión
Nombre de la conexión que se desconecta. El nombre se establece en el editor "Conexiones"
durante el proceso de configuración.
Dirección
Dirección MPI/PROFIBUS o IP del controlador con el que se establece la conexión.
Nota
La dirección se establece mediante una variable. La lista de objetos muestra variables de todo
los tipos. Seleccione exclusivamente variables de los siguientes tipos:
● Conexión Ethernet: Tipo de datos "String"
● Conexión MPI: Tipos de datos "Int"
Slot
Slot del controlador con el que se establece la conexión.
Rack
Rack del controlador con el que se establece la conexión.
Desea utilizar un panel de operador junto con varias máquinas. Para ello debe configurar un
controlador en el proyecto. Al cambiar de controlador se deshace la conexión con el
controlador utilizado actualmente. A continuación, la conexión se establece con el nuevo
controlador, utilizando parámetros de direccionamiento diferentes. A partir de ahora, todas las
variables de esta conexión se actualizarán desde el nuevo controlador.
Se utiliza por defecto el controlador especificado al crear el proyecto.
1. En el editor "Conexiones", indique el nombre y la dirección del controlador.
2. Configure un botón en la imagen del proceso.
3. Asocie el evento "Pulsar" a la función de sistema "CambiarConexión".
4. Introduzca como parámetros el nombre de la conexión y la dirección del controlador.
1.1.11 ChangeConnectionEIP (Panels, Comfort Panels, RT Advanced)
Descripción
Deshace la conexión con el controlador Allen Bradley que se está utilizando y establece una
conexión con otro controlador Allen Bradley en runtime. "EIP" son las siglas de "Ethernet/IP".
El controlador recién conectado debe pertenecer a la misma clase de dispositivo (Allen
Bradley).

VB Scripting
Para que se establezca la conexión, el tipo de CPU del controlador que se va a conectar debe
coincidir con el tipo de CPU del controlador ya conectado, p. ej., ambos controladores con el
tipo de CPU "SLC/Micrologix PLC".
Nota
Al cambiar a una dirección diferente, vigile que esta dirección no esté siendo utilizada por otro
panel de operador.
Se admiten los siguientes tipos de dirección:

● Dirección IP

CambiarConexiónEIP (Conectar, Dirección, Ruta de comunicación)

ChangeConnectionEIP Connection, Address, Communication_path
Parámetros
Conexión
Nombre de la conexión que se desconecta. El nombre se establece durante la configuración,
p. ej., en el editor "Conexiones".
Dirección
Dirección IP del controlador con el que se establece la conexión.
Nota
La dirección se establece mediante una variable. La lista de objetos muestra variables de todo
los tipos. Seleccione exclusivamente variables del tipo de datos "String".
Nota
La dirección IP guardada consiste en 4 números decimales comprendidos en un rango entre
0 y 255.
Ruta de comunicación
Ruta CIP desde el módulo Ethernet al controlador con el que se establece la conexión.
La ruta de comunicación se puede definir mediante una variable String o una variable HMI del
tipo de datos "String".

VB Scripting
Desea utilizar un panel de operador junto con varias máquinas. Para ello debe configurar un
controlador en el proyecto. Al cambiar de controlador se deshace la conexión con el
controlador utilizado actualmente. A continuación, la conexión se establece con el nuevo
controlador, utilizando parámetros de direccionamiento diferentes. A partir de ahora, todas las
variables de esta conexión se actualizarán desde el nuevo controlador.
1. En el editor "Conexiones", indique el nombre y la dirección del controlador.
2. Configure un botón en la imagen del proceso.
3. Asocie el evento "Pulsar" a la función de sistema "CambiarConexiónEIP".
4. Introduzca como parámetros el nombre de la conexión y la dirección del controlador.
1.1.12 ClearAlarmBuffer (Panels, Comfort Panels, RT Advanced)
Descripción
Borra avisos del búfer de avisos en el panel de operador.
Nota
Los avisos no acusados también se borran.

BorrarBúferDeAvisos (Número de categoría)

ClearAlarmBuffer Alarm_class_number
Parámetros
Número de categoría
Determina qué avisos se deben borrar del búfer de avisos:
0 (hmiAll) = todos los avisos
1 (hmiAlarms) = avisos de la categoría "Errores"
2 (hmiEvents) = avisos de la categoría "Advertencias"
3 (hmiSystem) = avisos de la categoría "Avisos de sistema"

VB Scripting
4 (hmiS7Diagnosis) = avisos de la categoría "Aviso de diagnóstico S7"
Nota
Dependencia del panel de operador
Los avisos de la categoría "Diagnosis Events" no están disponibles en Basic Panels.
1.1.13 ClearAlarmBufferProtool (Panels, Comfort Panels, RT Advanced)
Descripción
Esta función de sistema existe por motivos de compatibilidad.
Tiene la misma funcionalidad que la función de sistema "BorrarBúferDeAvisos" pero utiliza la
antigua numeración de ProTool.

BorrarBúferDeAvisosProtool (Número de categoría)

ClearAlarmBufferProtoolLegacy Alarm_class_number
Parámetros
Número de categoría
Número de la categoría cuyos avisos se borrarán:
-1 (hmiAllProtoolLegacy) = Todos los avisos
0 (hmiAlarmsProtoolLegacy) = Avisos de la categoría "Errors"
1 (hmiEventsProtoolLegacy) = Avisos de la categoría "Warnings"
2 (hmiSystemProtoolLegacy) = Avisos de la categoría "System"
3 (hmiS7DiagnosisProtoolLegacy) = Avisos de la categoría "Diagnosis Events"
Nota
Dependencia del panel de operador
Los avisos de la categoría "Diagnosis Events" no están disponibles en Basic Panels.

VB Scripting
1.1.14 ClearDataRecord (Panels, Comfort Panels, RT Advanced)
Descripción
Borra un registro de receta.
Es posible borrar varios registros en una o varias recetas.

BorrarRegistro (Número/Nombre de receta, Número/Nombre de registro, Confirmación, Emitir
aviso de estado, Estado de procesamiento)

ClearDataRecord
Utilizable, siempre que el panel configurado soporte funciones definidas por el usuario.
Parámetros
Número/nombre de receta
Número o nombre de la receta de la que se deben borrar los registros. Indique "0" si desea
borrar registros de todas las recetas disponibles.
Número/nombre de registro
Número o nombre del registro de receta que se borrará. Indique "0" si desea borrar todos los
registros de receta.
Confirmación
Determina si el operador debe confirmar el borrado:
0 (hmiOff) = Off: El proceso de borrado se inicia sin confirmación.
1 (hmiOn) = On: El inicio del proceso de borrado debe confirmarse.
Emitir aviso de estado

Determina si se debe emitir un aviso de estado una vez concluido el borrado:
0 (hmiOff) = Off: No emitir ningún aviso de estado.
1 (hmiOn) = On: Emitir un aviso de estado.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema solo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.

VB Scripting
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
1.1.15 ClearDataRecordMemory (Panels, Comfort Panels, RT Advanced)
Descripción
Borra todos los registros de receta del medio de almacenamiento indicado.

BorrarRegistroMemoria (Ubicación, Tras confirmar, Emitir aviso de estado, Estado de
procesamiento)

ClearDataRecordMemory Storage_location, Confirmation, Output_status_message,
Processing_status
Parámetros
Ubicación
Determina la ubicación:
0 (hmiFlashMemory) = Memoria flash: Memoria flash interna del panel de operador
1 (hmiStorageCard) = Storage Card
2 (hmiStorageCard2) = Storage Card 2
3 (hmiStorageCard3) = Storage Card MultiMediaCard
4 (hmiStorageCard4) = Storage Card USB
Tras confirmar
Determina si el operador debe confirmar el borrado:
0 (hmiOff) = Off: El proceso de borrado se inicia sin confirmación.
1 (hmiOn) = On: El inicio del proceso de borrado debe confirmarse.

Determina si se debe emitir un aviso de estado una vez concluido el borrado:

VB Scripting
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.,
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
1.1.16 ClearLog (Panels, Comfort Panels, RT Advanced)
Descripción
Borra todos los registros del fichero indicado.

BorrarFichero (Tipo de fichero, Fichero)

ClearLog Log_type, Log
Parámetros
Tipo de fichero
Determina el tipo de fichero.
2 (hmiAudittrailArchive) = Fichero Audit Trail. Disponible en proyectos conformes a GMP.
Encontrará más información en "Activar configuración conforme a GMP".
Fichero
Nombre del fichero del que se borrarán todas las entradas.
1.1.17 CloseAllLogs (Panels, Comfort Panels, RT Advanced)
Descripción
Deshace la conexión entre WinCC y todos los ficheros.

VB Scripting

CerrarTodosLosFicheros

CloseAllLogs
Parámetros
--
Desea cambiar en runtime el soporte de datos en el que se archivan los valores de proceso.
Asigne la función de sistema "CerrarTodosLosFicheros" al botón "Close Archive".
Configure las funciones de sistema "AbrirTodosLosFicheros" e "IniciarArchivación" y asócielas
al botón "Open Archive".
Transfiera como parámetro el nombre del fichero que se debe parar o iniciar, respectivamente.
Al pulsar el botón "Close Archive" se cerrarán los ficheros abiertos. A continuación podrá
cambiar el soporte de datos. Durante el cambio del soporte de datos se reanuda el archivado.
Se almacenan los valores de proceso que se archivarán. Con el botón "Open Archive" se
abren todos los ficheros. La archivación continúa en el fichero indicado. Los valores de proceso
almacenados se añaden al fichero.
1.1.18 ControlSmartServer (Panels, Comfort Panels, RT Advanced)
Descripción
Inicia o detiene el Sm@rtServer.

ControlarSmartServer (Modo)

ControlSmartServer Mode

VB Scripting
Parámetros
Modo
Determina si el Sm@rtServer se debe iniciar o detener.
-1 (hmiToggle) = Conmutar: Conmuta entre ambos estados.
0 (hmiStop) = Detener: Detener el Sm@rtServer
1 (hmiStart) = Iniciar: Iniciar el Sm@rtServer
1.1.19 ControlWebServer (Panels, Comfort Panels, RT Advanced)
Descripción
Inicia o detiene el servidor web.

ControlarServidorWeb (Modo)

ControlWebServer Mode
Parámetros
Modo
Determina si el servidor web se debe iniciar o detener.
0 (hmiStop) = Detener: El servidor web se detiene
1 (hmiStart) = Iniciar: El servidor web se inicia

VB Scripting
1.1.20 CopyLog (Panels, Comfort Panels, RT Advanced)
Descripción
Copia el contenido de un fichero en un fichero diferente. Los valores de variables sólo se
pueden copiar en otros ficheros de variables, en tanto que los avisos sólo se pueden copiar
en otros ficheros de avisos.
Nota
Al copiar un fichero con la función de sistema "CopiarFichero" puede suceder que las
aplicaciones de terceros no puedan leer los caracteres especiales contenidos en los textos
de los avisos archivados en la copia del fichero. WinCC Runtime no se ve afectado. WinCC
Runtime puede leer los ficheros copiados sin problema alguno.
Nota
Al copiar los ficheros circulares, se copia un 80% de las entradas del fichero. El 20% de las
entradas no se copia porque el espacio de memoria está reservado de forma estándar para
el desbordamiento del búfer.

CopiarFichero (Tipo de fichero, Fichero de destino, Fichero de origen, Modo, Borrar fichero
de origen)

CopyLog Log_type, Destination log, Source_log, Mode, Delete_source_log
Parámetros
Tipo de fichero
Fichero de destino
Nombre del fichero al que se copian las entradas (fichero de destino).
Fichero de origen
Nombre del fichero desde el que se copian las entradas (fichero de origen).

VB Scripting
Modo
Determina cómo se debe proceder con las entradas en el fichero de destino:
0 (hmiOverwrite) = Sobrescribir: Las entradas existentes se sobrescriben.
2 (hmiAppend) = Agregar: Las entradas se insertan al final del fichero de destino. Una vez
alcanzado el tamaño configurado del fichero de destino, éste se tratará como un fichero
circular.
Borrar fichero de origen

Determina si el fichero de origen se debe borrar tras finalizar la copia.
0 (hmiNo) = No: No borrar.
1 (hmiYes) = Sí: Borrar.
1.1.21 DecreaseTag (Panels, Comfort Panels, RT Advanced)
Descripción
Resta el valor indicado del valor de la variable.
X=X-a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le asigna un valor con la función de sistema "DefinirVariable".
Si asocia la función de sistema a eventos de un aviso y la variable no se utiliza en la imagen

actual, no se garantiza que el valor real de la variable se utilice en el controlador. Ello se puede
mejorar activando el modo de adquisición "Cíclico continuo".

DecrementarVariable (Variable, Valor)

DecreaseTag Tag, Value
Parámetros
Variable
Variable de la que se debe restar el valor indicado.

VB Scripting
Valor
Valor que se va a restar.
1.1.22 EditAlarm (Panels, Comfort Panels, RT Advanced)
Descripción
Dispara el evento "Editar" para el aviso seleccionado o, en caso de selección múltiple, para
el aviso seleccionado en último lugar. Si no ha acusado todavía los avisos que editar, el acuse
se efectuará automáticamente al ejecutarse esta función de sistema.
Esta función de sistema solo se puede utilizar para teclas de función.

EditarAviso

EditAlarm
Utilizable, siempre que el panel configurado permita funciones definidas por el usuario.
Parámetros
--
1.1.23 Encode (Panels, Comfort Panels, RT Advanced)
Descripción
Adapta el tipo de datos "String" de una variable para la transferencia al sistema de
automatización (AS). La variable del tipo de datos "String" de WinCC se convierte al tipo de
datos del AS "Array of Byte". El resultado se escribe en una variable.

Codificar (Matriz de bytes, Cadena de caracteres, Codificar)

Encode Byte_array, String, Encoding

VB Scripting
Parámetros
Matriz de bytes
Variable que contiene el valor convertido.
Nota
El tamaño de la matriz de bytes debe doblar la longitud de la cadena +2. Si la cadena tiene
una longitud de 120 caracteres, la matriz de bytes debe comprender 242 elementos.
Si el tamaño no es suficiente, se truncan algunos caracteres o no se convierten.
Cadena de caracteres
Variable del tipo de datos "String" que se debe convertir.
Codificar
0 (hmiEncodeUTF16LE) - String se codifica a UTF16LE (Unicode 16 Little Endian).
1.1.24 EncodeEx (Panels, Comfort Panels, RT Advanced)
Descripción
Adapta el tipo de datos "String" de una variable para la transferencia al sistema de
automatización (AS). La variable del tipo de datos "String" de WinCC se convierte al tipo de
datos del AS "Array of Byte". El resultado se escribe en una variable.
A diferencia de la función de sistema Codificar, es posible definir el parámetro Salto de línea.
El parámetro Salto de línea sirve para borrar los saltos de línea o reemplazarlos por caracteres
predefinidos.

CodificarEx (Matriz de bytes, Cadena de caracteres, Codificación, Salto de línea)

EncodeEx Byte_array, String, Encoding, Line_break

VB Scripting
Parámetros
Matriz de bytes
Variable que contiene el valor convertido.
Nota
El tamaño de la matriz de bytes debe doblar la longitud de la cadena +2. Si la cadena tiene
una longitud de 120 caracteres, la matriz de bytes debe comprender 242 elementos.
Si el tamaño no es suficiente, se truncan algunos caracteres o no se convierten.
Cadena de caracteres
Variable del tipo de datos "String" que se debe convertir.
Codificación
0 (hmiEncodeUTF16LE) - String se codifica a UTF16LE (Unicode 16 Little Endian).
Salto de línea
Todos los saltos de línea se borran o se reemplazan por caracteres predefinidos. El ajuste
estándar es que no se reemplacen los saltos de línea.
0 (reemplazar por "\r\n' (0x000D, 0x000A)) - los saltos de línea se reemplazan por "\r\n".
1 (reemplazar por "\n' (0x000A)) - los saltos de línea se reemplazan por "\n".
2 (no reemplazar) - los saltos de línea no se reemplazan.
3 (eliminar los saltos de línea) - los saltos de línea se borran.
1.1.25 ExportDataRecords (Panels, Comfort Panels, RT Advanced)
Descripción
Exporta uno o todos los registros de una receta a un archivo CSV o TXT.
Se crea un archivo para cada receta.

ExportarRegistros (Número/nombre de receta, Número/nombre de registro, Nombre de
archivo, Sobrescribir, Emitir aviso de estado, Estado de procesamiento)

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

VB Scripting
Parámetros
Número/nombre de la receta de la que se deben exportar los registros. Introduzca "0" si desea
exportar registros de todas las recetas disponibles.
Número/Nombre de registro
Número o nombre del registro de receta que se exportará. Introduzca "0" si desea exportar
todos los registros de receta.
Nombre de archivo
Nombre del archivo al que se exportan los registros de receta. Introduzca el nombre incluyendo
la ubicación y la extensión del archivo (*.csv o *.txt), p. ej., "C:\TEMP\Orange.csv". Si una
carpeta no existe, se creará al exportar.
Si no se introduce el nombre de archivo completo, el comportamiento dependerá del número
de recetas configuradas:
● Si hay varias recetas configuradas:
Si introduce solo un nombre de archivo sin ruta, el archivo se guardará en un directorio del
sistema, p. ej., "C:\Documents and Settings\[User]".
Si indica solo la ruta sin nombre de archivo, el nombre del archivo se genera
automáticamente a partir del nombre de la receta. Para ello, es imprescindible que esté
creada la carpeta indicada en la ruta, p. ej., "D:\Data\". Si la carpeta "D:\Data" no está
creada, se utilizará su nombre como prefijo para el nombre del archivo, p. ej.,
"Data_nombre_de_la_receta.csv".
● Si hay una sola receta configurada y se indica solo la ruta sin nombre de archivo:
Si la carpeta no existe, se crea un archivo con el nombre de la carpeta. Este archivo no
tendrá ninguna extensión.
Si la carpeta existe, la exportación se cancela con un mensaje de error.
Si utiliza una tarjeta de memoria como ubicación, defina la ruta del siguiente modo:
"\StorageCard\<Nombre>".
Para los Basic Panels, introduzca el nombre del archivo como sigue: "\USB_X60.1\<Nombre>"
Sobrescribir
Determina si se debe sobrescribir un archivo de exportación existente de igual nombre:
0 (hmiOverwriteForbidden) = No: El archivo de exportación no se sobrescribe. El proceso de
exportación no se ejecutará.
1 (hmiOverwriteAlways) = Sí: El archivo de exportación se sobrescribirá sin consulta previa.
2 (hmiOverwriteWithPrompting) = Tras confirmar: El archivo de exportación se sobrescribirá
tras haberse confirmado la consulta de seguridad.

Determina si se debe emitir un aviso de estado una vez concluida la exportación:

VB Scripting
Formato de exportación de los registros de receta

Si se selecciona la extensión ".csv" para el archivo de exportación, sólo se soportarán los
caracteres válidos del juego de caracteres ANSI. Esto también es aplicable a los separadores
de números decimales y de elementos de listas. Los separadores utilizados se establecen en
la configuración regional del sistema operativo del PC en el que se realiza la exportación.
Para la exportación también se pueden utilizar archivos de texto en formato "Unicode (".txt)".
Este formato de archivo admite todos los caracteres que se pueden utilizar en WinCC y WinCC
Runtime. Los separadores utilizados se establecen asimismo en la configuración regional del
sistema operativo del PC en el que se realiza la exportación. En este formato de archivo, el
separador de elementos de lista es siempre un tabulador.
La función correspondiente para importar los datos soporta también los formatos de archivo
".csv" y ".txt" (Unicode).
Desea exportar todos los objetos pulsando una tecla.
Configure la función de sistema "ExportarRegistros" asociada al evento "Pulsar" de la tecla
deseada. Transfiera los parámetros siguientes:
● Número/nombre de receta = 1
● Número/nombre de registro = 0
● Nombre de archivo = c:\temp\orange.csv (para Basic Panels "\USB_X60.1\orange.csv")
● Sobrescribir = 1
● Emitir aviso de estado = 1
Si lo desea, puede indicar variables en lugar de constantes. Dependiendo de la configuración,
el operador puede introducir los valores deseados en los campos E/S, o bien leerlos del
controlador. De este modo, el operador puede determinar qué registros de receta se
exportarán.
La función de sistema se ejecuta tras pulsar la tecla. Las constantes o las variables se evalúan.
Todos los registros de la receta 1 se exportan al archivo orange.csv. Si el archivo ya existe,
éste se sobrescribe.
Tras exportar los registros se visualiza un aviso del sistema.

VB Scripting
1.1.26 ExportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)
Descripción
Exporta uno o todos los registros de una receta a un archivo CSV y genera una suma de
verificación para cada fila del archivo.
Se crea un archivo para cada receta.

ExportarRegistrosConSumaDeVerificación (Número/nombre de receta, Número/nombre de
registro, Nombre de archivo, Sobrescribir, Emitir aviso de estado, Estado de procesamiento)

ExportDataRecordsWithChecksum Recipe_number_or_name, Data_record
number_or_name, File_name, Overwrite, Output_status_message, Processing_status
Parámetros
Número/nombre de la receta de la que se deben exportar los registros. Introduzca "0" si desea
exportar registros de todas las recetas disponibles.
Número o nombre del registro de receta que se exportará. Introduzca "0" si desea exportar
Nombre de archivo
Nombre del archivo CSV al que se deben exportar los registros de receta. Introduzca también
la ruta y la extensión del archivo, p. ej., "C:\TEMP\Orange.CSV".
Si utiliza una tarjeta de memoria como ubicación, introduzca la ubicación del siguiente modo:
"\StorageCard\<Nombre de archivo>".
Si define sólo un nombre de archivo y no una ruta, el archivo se guardará en el directorio
desde el que se inició el runtime. Si en el sistema operativo Windows 7 no se dispone de
derechos de escritura para este directorio, el archivo se guardará en el directorio de usuario,
en la carpeta "VirtualStore".
Si solo indica la ruta para la exportación, el nombre del archivo se genera automáticamente
a partir del nombre de la receta. Para ello se tiene que haber creado el directorio, p. ej. "D:
\Temp\". Si no se ha creado el directorio "D:\Temp", se utiliza el nombre del directorio como
prefijo del nombre del archivo,Temp_Nombre de receta.csv.
Sobrescribir
Determina si se debe sobrescribir un archivo CSV existente de igual nombre:

VB Scripting
0 (hmiOverwriteForbidden) = No: El archivo CSV no se sobrescribirá. El proceso de

exportación no se ejecutará.
1 (hmiOverwriteAlways) = Sí: El archivo CSV se sobrescribirá sin consulta previa.
2 (hmiOverwriteWithConfirmation) = Previa confirmación: El archivo CSV se sobrescribirá tras
haberse confirmado la consulta de seguridad.

Determina si se debe emitir un aviso de estado una vez concluida la exportación:
Formato de exportación de los registros de receta

Si se selecciona la extensión ".csv" para el archivo de exportación, sólo se soportarán los
caracteres válidos del juego de caracteres ANSI. Esto también es aplicable a los separadores
de números decimales y de elementos de listas. Los separadores utilizados se establecen en
la configuración regional del sistema operativo del PC en el que se realiza la exportación.
Para la exportación también se pueden utilizar archivos de texto en formato "Unicode (".txt)".
Este formato de archivo admite todos los caracteres que se pueden utilizar en WinCC y WinCC
Runtime. Los separadores utilizados se establecen asimismo en la configuración regional del
sistema operativo del PC en el que se realiza la exportación. En este formato de archivo, el
separador de elementos de lista es siempre un tabulador.
La función correspondiente para importar los datos soporta también los formatos de archivo
".csv" y ".txt" (Unicode).
Pulsando una tecla desea exportar todos los registros y asignarles una suma de verificación.
Configure la función de sistema "ExportarRegistrosConSumaDeVerificación" asociada al
evento "Pulsar" de la tecla deseada. Transfiera los parámetros siguientes:
● Número/nombre de receta = 1
● Número/nombre de registro = 0
● Nombre de archivo = c:\temp\orange.csv
● Sobrescribir = 1
● Emitir aviso de estado = 1

VB Scripting

controlador. De este modo, el operador puede determinar qué registros de receta se
exportarán.
La función de sistema se ejecuta tras pulsar la tecla. Las constantes o las variables se evalúan.
Todos los registros de la receta 1 se exportan al archivo orange.csv y se les asignan sumas
de verificación. Si el archivo ya existe, éste se sobrescribe.
Tras exportar los registros se visualiza un aviso del sistema.
1.1.27 ExportImportUserAdministration (Panels, Comfort Panels, RT Advanced)
Descripción
Exporta todos los usuarios de la administración de usuarios del proyecto activo en este
momento al archivo indicado, o bien importa los usuarios del archivo indicado al proyecto
activo en este momento.
En la administración de usuarios se guardan usuarios, sus contraseñas y permisos.
Durante la importación se sobrescriben todos los usuarios. Los usuarios importados son
válidos desde el primer momento.
Nota
En los paneles de operador con una versión de runtime anterior a V14 no se soporta la
exportación e importación de la administración de usuarios de V14.

ExportarImportarAdministraciónDeUsuarios (Nombre de archivo, Dirección)

ExportImportUserAdministration File_name, Direction

VB Scripting
Parámetros
Nombre de archivo
Nombre del archivo que contiene las contraseñas o en el que se guardarán las contraseñas.
Introduzca también la ruta y la extensión del archivo (*.txt), p. ej. "C:\TEMP\Passwords.txt".
Nota
Dirección
Determina si las contraseñas se exportarán o importarán:
0 (hmiExport) = Exportación: Las contraseñas se exportan.
1 (hmiImport) = Importación: Las contraseñas se importan.
1.1.28 GetBrightness (Panels, Comfort Panels, RT Advanced)
Descripción
Lee el valor del brillo.

LeerBrillo (Brillo)

GetBrightness Brightness
Parámetros
Brillo
Variable en la que se escribe el valor.

VB Scripting
1.1.29 GetDataRecordFromPLC (Panels, Comfort Panels, RT Advanced)
Descripción
Transfiere el registro de receta indicado del controlador al medio de almacenamiento del panel
de operador.

LeerRegistroDelControlador (Número/Nombre de receta, Número/Nombre de registro,
Sobrescribir, Emitir aviso de estado, Estado de procesamiento)

GetDataRecordFromPLC Recipe_number_or_name, Data_record_number_or_name,
Overwrite, Output_status_message, Processing_status
Parámetros
Número o nombre de la receta de la que se deben transferir los registros.
Número o nombre del registro de receta que se debe transferir del controlador al medio de
almacenamiento del panel de operador.
Sobrescribir
Determina si se debe sobrescribir un registro de receta existente de igual nombre:
0 (hmiOverwriteForbidden) = No: El registro de receta no se sobrescribe. El proceso de
transferencia no se ejecuta.
1 (hmiOverwriteAlways) = Sí: El registro de receta se sobrescribe sin consulta previa.
2 (hmiOverwriteWithPrompting) = Tras confirmar: El registro de receta se sobrescribe tras
haberse confirmado la consulta de seguridad.

Establece si se debe visualizar un aviso de estado una vez concluida la transferencia.

VB Scripting

Debe transferirse un registro del controlador al medio de almacenamiento del panel de
operador por medio de una tecla.
Configure la función de sistema "LeerRegistroDelControlador" asociada al evento "Pulsar" de
la tecla deseada. Transfiera los parámetros siguientes:
Número/nombre de receta = 1
Número/nombre de registro = 1
Sobrescribir = 1
Emitir aviso de estado = 1
controlador. De este modo, el operador puede determinar qué registro de receta se transferirá
del controlador.
La función de sistema se ejecuta tras pulsar la tecla. Las constantes o variables se evalúan
y el primer registro de la receta 1 se transfiere del controlador al medio de almacenamiento
del panel de operador. Si dicho registro ya existe, se sobrescribe.
Después de la transferencia se visualiza un aviso de sistema.
1.1.30 GetDataRecordName (Panels, Comfort Panels, RT Advanced)
Descripción
Escribe los nombres de la receta indicada y del registro de receta indicado en las variables
especificadas.
Nota
Si la receta o el registro de receta no existe, se escriben comodines ("###") en las variables.
Nota
Como variables, solo se soportan variables internas o externas.

VB Scripting

LeerNombreDelRegistro (Número de receta, Número de registro, Nombre de receta, Nombre
de registro, Estado de procesamiento)

GetDataRecordName Recipe_number, Data_record_number, Recipe_name,
Data_record_name, Processing_status
Parámetros
Número de receta
Número de la receta cuyo nombre se escribe en la variable indicada.
Número de registro
Número del registro de receta cuyo nombre se escribe en la variable indicada.
Nombre de receta
Variable en la que se escribe el nombre de la receta. La variable debe ser del tipo STRING.
Nombre de registro
Variable en la que se escribe el nombre del registro de receta. La variable debe ser del tipo
STRING.
Los nombres de la receta indicada y del registro de receta indicado se visualizan en el panel
de operador.
Configure las variables siguientes:
● "RecNumber" del tipo INTEGER
● "RecDataNumber" del tipo INTEGER
● "RecName" del tipo STRING
● "RecDataName" del tipo STRING

VB Scripting
Configure un visor de recetas con las variables "RecNumber" para el número de receta y
"RecDataNumber" para el número de registro.
Asocie la función de sistema "LeerNombreDelRegistro" al evento "Pulsar" de un botón y
transfiera los parámetros siguientes:
● Número de receta: RecNumber
● Número de registro: RecDataNumber
● Nombre de receta: RecName
● Nombre de registro: RecDataName
Configure dos campos de salida y asócielos a las variables "RecName" y "RecDataName".
Seleccione un número de receta y un número de registro en el visor de recetas. La función
de sistema se ejecutará en cuanto se pulse el botón y los nombres de la receta y del registro
de receta se visualizarán en los dos campos de salida.
1.1.31 GetDataRecordTagsFromPLC (Panels, Comfort Panels, RT Advanced)
Descripción
Transfiere a las variables de receta los valores del registro de receta cargado en el
controlador.
Utilice esta función de sistema p. ej. en el modo de aprendizaje (Teach-In) en una máquina.

LeerVariablesDeRegistroDelControlador (Número/Nombre de receta, Estado de
procesamiento)

GetDataRecordTagsFromPLC Recipe_number_or_name, Processing_status
Parámetros
Número o nombre del registro de receta cuyos valores se escriben del controlador a la variable.

VB Scripting

1.1.32 GetGroupNumber (Panels, Comfort Panels, RT Advanced)
Descripción
Lee el número del grupo al que pertenece el usuario registrado en el panel de operador y lo
escribe en la variable indicada.

LeerNúmeroDeGrupo (Variable)

GetGroupNumber Tag
Parámetros
Variable
Variable en la que se escribe el número del grupo.
1.1.33 GetPassword (Panels, Comfort Panels, RT Advanced)
Descripción
Lee la contraseña del usuario conectado al panel de operador y la escribe en la variable
indicada.
Nota
Asegúrese de que el valor de la variable indicada no aparece en ningún otro lugar del proyecto.
Nota
Las contraseñas de usuarios de SIMATIC Logon no se pueden leer.

VB Scripting
Nota
La función de sistema "LeerContraseña" no está disponible para dispositivos con versión
14.0.0.0 o superior.
Si esta función de sistema se había utilizado en un proyecto con una versión anterior a V14,
se eliminará tras la migración a V14. Esto invalidará el evento asociado a la función de sistema.
En la configuración, la función de sistema "LeerContraseña" se muestra como errónea. Al
compilar se emitirá una advertencia. En el proyecto runtime compilado ya no está incluida la
función de sistema "LeerContraseña".

LeerContraseña (Variable)

GetPassword Tag
Parámetros
Variable
Variable en la que se escribe la contraseña.
1.1.34 GetUserName (Panels, Comfort Panels, RT Advanced)
Descripción
Escribe el nombre del usuario conectado actualmente al panel de operador en la variable
indicada.
Si la variable indicada contiene una conexión con el controlador, el nombre del usuario también
estará disponible en el controlador. Con esta función de sistema se pueden p. ej. liberar
determinadas funciones para usuarios específicos.

LeerNombreDeUsuario (Variable)

GetUserName Tag

VB Scripting
Parámetros
Variable
Variable en la que se escribe el nombre del usuario.
1.1.35 GoToEnd (Panels, Comfort Panels, RT Advanced)
Descripción
Ejecuta la función de tecla <Fin> en el panel de operador.
Utilice esta función de sistema si la versión estándar del panel de operador no dispone de
esta funcionalidad.

IrAFin

GoToEnd
Parámetros
--
1.1.36 GoToHome (Panels, Comfort Panels, RT Advanced)
Descripción
Ejecuta la función de tecla <Inicio> en el panel de operador.
Utilice esta función de sistema si la versión estándar del panel de operador no dispone de
esta funcionalidad.

VB Scripting

IrAInicio

GoToHome
Parámetros
--
1.1.37 ImportDataRecords (Panels, Comfort Panels, RT Advanced)
Descripción
Importa uno o todos los registros de una receta de un archivo CSV o TXT.
Cuando se indica una ruta, se importan todos los archivos del directorio indicado.

ImportarRegistros (Nombre de archivo, Número/Nombre de registro, Sobrescribir, Emitir aviso
de estado, Estado de procesamiento)

ImportDataRecords File_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status
Parámetros
Nombre de archivo
Nombre del archivo del que se deben importar los registros de receta. Introduzca también la
ubicación y la extensión del archivo (*.csv o *.txt), p. ej., "C:\TEMP\Orange.csv".
Para los Basic Panels, introduzca el nombre del archivo como sigue: "\USB_X60.1\<Nombre>"
Para otros paneles se aplica lo siguiente: Si utiliza una tarjeta de memoria como ubicación,
introduzca esta última del siguiente modo: "\StorageCard\<Nombre>"

VB Scripting
Número o nombre del registro de receta que se importará. Introduzca "0" si desea importar
Sobrescribir
Determina si se deben sobrescribir los registros de receta existentes:
0 (hmiOverwriteForbidden) = No: Los registros de receta no se sobrescriben. El proceso de
importación no se ejecuta.
1 (hmiOverwriteAlways) = Sí: Los registros de receta se sobrescribirán sin consulta previa.
2 (hmiOverwriteWithPrompting) = Tras confirmar: Los registros de receta se sobrescribirán

Determina si se debe emitir un aviso de estado una vez concluida la importación:
Objetos configurables
Objeto Evento
Variable Modificación de valor
Límite superior excedido
Límite inferior excedido
Tecla de función (global) Soltar
Pulsar
Tecla de función (local) Soltar
Pulsar
Imagen Creada
Borrada

VB Scripting
Objeto Evento
Objeto de imagen Pulsar
Soltar
Hacer clic
Modificar (o conmutar con el interruptor)
Conectar
Desconectar
Activar
Desactivar
Planificador de tareas Tiempo agotado
1.1.38 ImportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)
Descripción
Importa uno o todos los registros de una receta de un archivo CSV con suma de verificación
y verifica ésta última.

ImportarRegistrosConSumaDeVerificación (Nombre de archivo, Número/nombre de registro,
Sobrescribir, Emitir aviso de estado, Estado de procesamiento, verificar suma de verificación)

ImportDataRecordsWithChecksum File_name, Data_record_number_or_name, Overwrite,
Output_status_message, Processing_status, Verify_checksum
Parámetros
Nombre de archivo
Nombre del archivo CSV del que se deben importar los registros de receta. Introduzca también
la ruta y la extensión del archivo, p. ej., "C:\TEMP\Orange.CSV".
Si utiliza una tarjeta de memoria como medio de almacenamiento, introduzca la ruta del
siguiente modo: "\StorageCard\<Nombre de archivo>".
Si se indica un directorio en lugar de un solo archivo CSV, se importarán todos los archivos
del directorio en cuestión.
Número o nombre del registro de receta que se importará. Introduzca "0" si desea importar

VB Scripting
Sobrescribir
Determina si se deben sobrescribir los registros de receta existentes:
0 (hmiOverwriteForbidden) = No: Los registros de receta no se sobrescriben. El proceso de
importación no se ejecuta.
1 (hmiOverwriteAlways) = Sí: Los registros de receta se sobrescribirán sin consulta previa.
2 (hmiOverwriteWithConfirmation) = Previa confirmación: Los registros de receta se
sobrescribirán tras haberse confirmado la consulta de seguridad.

Determina si se debe emitir un aviso de estado una vez concluida la importación:
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
Verificar suma de verificación

Determina si la suma de verificación debe verificarse al realizar la importación:
0 (hmiFalse) = No: La suma de verificación no se verifica.
1 (hmiTrue) = Sí: La suma de verificación se verifica.
1.1.39 IncreaseTag (Panels, Comfort Panels, RT Advanced)
Descripción
Suma el valor indicado al valor de la variable.
X=X+a
Nota
A la variable auxiliar se le puede asignar un valor con la función de sistema "DefinirVariable".
Si asocia la función de sistema a eventos de un aviso y la variable no se utiliza en la imagen


VB Scripting

IncrementarVariable (Variable, Valor)

IncreaseTag Tag, Value
Parámetros
Variable
Variable a la que se debe agregar el valor indicado.
Valor
Valor que se suma.
1.1.40 InverseLinearScaling (Panels, Comfort Panels, RT Advanced)
Descripción
Asigna a la variable X un valor que se calcula a partir del valor de la variable Y indicada
mediante la función lineal X = (Y - b) / a.
Las variables X e Y no pueden ser idénticas. Esta función de sistema es la función inversa de
"EscalaLineal".
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.

InvertirEscalaLineal (X, Y, b, a)

InverseLinearScaling X, Y, b, a

VB Scripting
Parámetros
X
Variable a la que se asigna el valor calculado en la ecuación lineal.
Y
Variable cuyo valor se utiliza para el cálculo.
b
a
Valor por el que se divide.
Ejemplo
El siguiente código de programa asigna un valor a la variable varX con la función
InverseLinearScaling.
{
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);

...
}
El valor de retorno guardado puede procesarse en el código subsiguiente.
1.1.41 InvertBit (Panels, Comfort Panels, RT Advanced)
Descripción
Invierte el valor de la variable indicada del tipo "Bool".
● Si la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).

InvertirBit (Variable)

VB Scripting

InvertBit Tag
Parámetros
Variable
Variable cuyo bit se debe ajustar.
Ejemplo
El siguiente código de programa invierte el valor de la variable booleana bStatus y muestra
el resultado junto con el valor original bSaved.
'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);
...
}

VB Scripting
1.1.42 InvertBitInTag (Panels, Comfort Panels, RT Advanced)
Descripción
Invierte un bit en la variable indicada:
● Si el bit de la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si el bit de la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "InvertirBit".

InvertirBitEnVariable (Variable, Bit)

InvertBitInTag Tag, Bit
Parámetros
Variable
Variable en la que se debe ajustar el bit indicado.
Bit
Número del bit a ajustar.
Si utiliza esta función de sistema en un script de usuario, los bits de una variable se cuentan
de derecha a izquierda. El contaje comienza a partir de "0".

VB Scripting
Ejemplo
El siguiente código de programa invierte un bit en la posición indicada bitposition de la variable
bStatusWord y muestra el resultado junto con el valor original bSaved.
Dim myTag
Dim myOutputField
Dim bValue, bSaved, bitposition, strResult
Set myTag = SmartTags("bStatusWord")

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue
'Invert Bit in position

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

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

InvertBitInTag (bStatusWord, bitposition);
printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bsaved);
...
}
1.1.43 LinearScaling (Panels, Comfort Panels, RT Advanced)
Descripción
Asigna a la variable Y un valor que se calcula a partir del valor de las variables X indicadas
mediante la función lineal Y = (a * X) + b.

VB Scripting
La función inversa es la función de sistema "InvertirEscalaLineal".
Nota

EscalaLineal (Y, a, X, b)

LinearScaling Y, a, X, b
Parámetros
Y
a
Valor con el que se multiplica.
X
b
Valor que se suma.

VB Scripting
Ejemplo
El siguiente código de programa asigna con la función LinearScaling un valor a la variable
Yvar.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling
LinearScaling ( Yvar, avalue, Xvalue, bvalue);
printf ("Yvar = %d\r\n, Yvar);

...
}
1.1.44 LoadDataRecord (Panels, Comfort Panels, RT Advanced)
Descripción
Carga el registro de receta indicado del medio de almacenamiento del panel de operador a
la variable de receta. Utilice esta función de sistema por ejemplo para visualizar un registro
de receta en la imagen de receta.
Active en la configuración para sincronizar la receta la opción "Sincronizar visor de recetas y
variables de recetas". Si la opción está desactivada, la función de sistema no tiene ningún
efecto.

CargarRegistro (Número/Nombre de receta, Número/Nombre de registro, Estado de
procesamiento)

LoadDataRecord Recipe_number_or_name, Data_record_number_or_name, Confirmation,
Parámetros
Número o nombre de la receta desde la que se cargará un registro.

VB Scripting
Número o nombre del registro de receta que se cargará.
1.1.45 Logoff (Panels, Comfort Panels, RT Advanced)
Descripción
Cierra la sesión del usuario actual en el panel de operador.

CerrarSesión

Logoff
Parámetros
--
1.1.46 Logon (Panels, Comfort Panels, RT Advanced)
Descripción
Inicia la sesión del usuario actual en el panel de operador.

IniciarSesión (Contraseña, Nombre de usuario)

VB Scripting

Logon Password, User_name
Parámetros
Contraseña
La variable de la cual se lee la contraseña del usuario que va a iniciar la sesión. Si el usuario
ha iniciado la sesión, se borra la contraseña de la variable.
Nombre de usuario
La variable de la cual se lee el Nombre de usuario que va a iniciar la sesión.
1.1.47 LookupText (Panels, Comfort Panels, RT Advanced)
Descripción
Lee el registro de una lista de textos. El resultado depende del valor y del idioma de runtime
seleccionado. El resultado se guarda en una variable del tipo "String".

Consultar texto (Texto de salida, Índice, Idioma, Lista de textos)

LookupText Output_text, Index, Language, Text_list
Parámetros
Texto de salida
Variable en la que se escribe el resultado.
Índice
Variable que determina el valor del registro de la lista.

VB Scripting
Idioma
Determina en qué idioma de runtime se debe leer el registro de la lista.
● Idioma de runtime
Abreviatura de idioma conforme a la referencia VBScript, p. ej. "de-DE" para alemán
(Alemania) o "en-ES" para inglés (EE UU). La selección depende de los idiomas runtime
activados.
● Variable
Variable que contiene el idioma. El idioma de runtime se introduce en forma de valor
decimal del indicador de país, p. ej. 1031 para alemán estándar, 1033 para inglés de
EE UU. Encontrará más información al respecto en los conceptos básicos de VBScript bajo
el tema "Cuadro de ID de configuración regional (LCID)".
● Número entero
El número que corresponde al orden de los idiomas de runtime en el cambio de idioma.
La selección depende de los idiomas de runtime activados, p. ej., "0" para el idioma que
aparece al iniciar runtime por primera vez. Encontrará más información al respecto en el
apartado "Idiomas en runtime".
Lista de textos
Establece la lista de textos. El registro se lee de la lista de textos.
1.1.48 NotifyUserAction (Panels, Comfort Panels, RT Advanced)
Descripción
Esta función de sistema registra en el Audit Trail las acciones del usuario que no se registran
automáticamente en el Audit Trail. Además, con esta función se puede exigir que el usuario
acuse una acción, o bien que la confirme con su firma electrónica y que introduzca un
comentario al respecto. Para poder utilizar la función de sistema es imprescindible que se
active la configuración conforme a las GMP en "Configuración de runtime > GMP".
Si en una función utiliza la función de sistema "NotificarAcciónDeUsuario" y termina la entrada
con el botón "Cancelar" se puede llamar el depurador. Para controlar este comportamiento,
se puede utilizar en una función la instrucción "On Error Resume Next". Esta instrucción hace
que se ejecute la instrucción siguiente tras un error de runtime. Si utiliza la instrucción "On
Error Resume Next" se suprime también la salida de avisos de sistema.

RegistrarAcciónDeUsuario (Tipo de confirmación, Comentario obligatorio, Categoría, Nombre
del objeto, Descripción)

NotifyUserAction Confirmation_type, Mandatory_commenting, Category, Object_name,
Description

VB Scripting
Parámetros
Tipo de confirmación
Determina cómo debe confirmarse la acción
0 = (None): no se requiere confirmación; se crea una entrada en el Audit Trail
1 = (Acknowledgement): acuse, el usuario tiene que reconocer la acción; se crea una entrada
en el Audit Trail
2 = (Digital Signature): firma electrónica, aparece un cuadro de diálogo en el que el usuario
debe introducir su firma electrónica; se crea una entrada en el Audit Trail
Comentario obligatorio
Determina si el usuario debe introducir un comentario. El comentario se archiva en el Audit
Trail.
0 = (True): verdadero, aparece un cuadro de diálogo en el que el usuario debe introducir un
comentario
1 = (False): falso; no se requiere ningún comentario
Categoría
Categoría o nombre de clase del objeto modificado
Nombre del objeto

Nombre del objeto modificado
Descripción
Texto que describe la acción de usuario que se debe archivar.
1.1.49 OpenAllLogs (Panels, Comfort Panels, RT Advanced)
Descripción
Restablece la conexión entre WinCC y los ficheros. La archivación puede continuar.
Nota
Para reiniciar el proceso de archivar, ejecute la función de sistema "IniciarArchivación".

AbrirTodosLosFicheros

VB Scripting

OpenAllLogs
Parámetros
--
Configure las funciones de sistema "PararArchivación" y "CerrarTodosLosFicheros" y
asócielas al botón "Close Archive".
Cuando pulse el botón "Close Archive" se parará el fichero indicado y se cerrarán todos los
ficheros abiertos. A continuación podrá cambiar el soporte de datos. Con el botón "Open
Archive" se abren todos los ficheros. Se sigue archivando en el fichero indicado.
1.1.50 OpenCommandPrompt (Panels, Comfort Panels, RT Advanced)
Descripción
Abre una ventana de comando de Windows.
Utilice esta función de sistema si, p. ej., desea copiar archivos o llamar otra aplicación.

AbrirVentanaDeSímboloDelSistema
Utilización en scripts de usuario

OpenCommandPrompt
Utilizable, siempre que el dispositivo configurado soporte scripts de usuario. Encontrará más
información al respecto en "Dependencia del dispositivo".

VB Scripting
Parámetros
--
1.1.51 OpenControlPanel (Panels, Comfort Panels, RT Advanced)
Descripción
Abre un cuadro de diálogo en el que se pueden modificar ajustes seleccionados del Panel de
control.
Con esta función de sistema se ajusta en el panel de operador, entre otras cosas, lo siguiente:
● Propiedades y valor de la dirección IP
● Identificación del usuario en la red
● WinCC Internet Settings
Nota
Seguridad en el proyecto
Con la función de sistema "AbrirDiálogoControlPanel" se omite el SecureMode en el panel de
operador. Tome las medidas preventivas necesarias para garantizar la seguridad de su
proyecto.

AbrirDiálogoControlPanel (cuadro de diálogo)

-
Parámetros
Cuadro de diálogo
Define el diálogo que se abre en el Panel de control.
● PROFINET_X1: ajuste de la dirección IP y de los parámetros de Ethernet.
● PROFINET_X3: ajuste de la dirección IP y de los parámetros de Ethernet, solo con Comfort
Panel KP 1500, TP 1500, TP1900, TP2200.
● WinCC Internet Settings: ajuste de servidor web, notificación por correo electrónico, si el
panel de operador soporta esta función.
● ID de red: ajuste para la identificación en la red, si el panel de operador soporta estas
funciones.

VB Scripting
1.1.52 OpenInternetExplorer (Panels, Comfort Panels, RT Advanced)
Descripción
Abre Internet Explorer en el panel de operador.
Si Internet Explorer ya está abierto, al llamar esta función de sistema se cerrará y volverá a
abrirse.
Nota
Internet Explorer guarda datos temporalmente en el sistema de archivos DRAM del panel de
operador (p.ej. las últimas páginas web llamadas).
Es posible guardar dichos datos con la función de sistema
"CopiaSeguridadSistemaDeArchivosRAM" para que sigan estando disponibles tras un reinicio
del panel de operador.

AbrirInternetExplorer (Página de inicio)

OpenInternetExplorer Start_page
Parámetros
Página inicial
Página que se abre cuando se llama Internet Explorer, p. ej. "www.siemens.com".
1.1.53 OpenScreenKeyboard (Panels, Comfort Panels, RT Advanced)
Descripción
Muestra u oculta el teclado de pantalla.
El teclado de pantalla se mantiene abierto hasta que se cierra expresamente. De este modo
también es posible utilizarlo en otras aplicaciones.

AbrirTecladoDePantalla (Representación)

VB Scripting

OpenScreenKeyboard Display_mode
Parámetros
Representación
Determina si la ventana con el teclado de pantalla se abre minimizada o maximizada:
0 (hmiScreenKeyboardMinimized) = Minimizada
1 (hmiScreenKeyboardMaximized) = Maximizada
1.1.54 OpenTaskManager (Panels, Comfort Panels, RT Advanced)
Descripción
Muestra el administrador de tareas.
El administrador de tareas permite cambiar a otras aplicaciones abiertas en el panel de
operador.
Nota
El aspecto del administrador de tareas depende del sistema operativo instalado.

AbrirAdministradorDeTareas

OpenTaskManager
Parámetros
--

VB Scripting
1.1.55 PageDown (Panels, Comfort Panels, RT Advanced)
Descripción
Ejecuta la función de tecla <Av Pág> en el panel de operador.

AvanzarPágina

PageDown
Parámetros
-
1.1.56 PageUp (Panels, Comfort Panels, RT Advanced)
Descripción
Ejecuta la función de tecla <RePág> en el panel de operador.
Esta función de sistema sólo se puede utilizar para teclas de función y para tareas con
disparador temporal.

RetrocederPágina

PageUp
Parámetros
-

VB Scripting
1.1.57 PrintReport (Panels, Comfort Panels, RT Advanced)
Descripción
Imprime el informe indicado en la impresora conectada al panel de operador. El informe se
imprime en el idioma ajustado en el panel de operador.
Nota
Si runtime se cierra mientras se están imprimiendo datos de fichero con la ayuda de la función
del sistema, entonces el protocolo no recibe más datos a partir del momento en que se finaliza
runtime.

ImprimirInforme (Informe)

PrintReport Report
Parámetros
Informe
Nombre del informe a imprimir.
Nota
Si crea un nuevo informe para la función "ImprimirInforme" en el cuadro de diálogo "Lista de
funciones", aparecerá la siguiente advertencia durante la compilación: "El informe "Informe_1"
no contiene páginas de impresión."
Para eliminar la advertencia, abra el "Informe_1" en la ventana del proyecto y vuelva a compilar
el proyecto.
1.1.58 PrintScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Imprime la imagen visualizada actualmente en el panel de operador en la impresora conectada
a éste último.

VB Scripting
Las ventanas abiertas también se imprimen.
Nota
Los ajustes de la impresora se adoptan de los ajustes actuales del sistema operativo Windows.

ImprimirImagen

PrintScreen
Parámetros
--
1.1.59 ResetBit (Panels, Comfort Panels, RT Advanced)
Descripción
Pone a 0 (FALSE) el valor de una variable del tipo "Bool".

DesactivarBit (Variable)

ResetBit Tag
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "0" (FALSE).

VB Scripting
Ejemplo
El siguiente código de programa pone a 0 el valor de la variable booleana bStatus con la
función ResetBit y muestra el resultado junto con el valor original bSaved.
Dim myTag
Dim myOutputField

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

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

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

...
}
1.1.60 ResetBitInTag (Panels, Comfort Panels, RT Advanced)
Descripción
Pone un bit a 0 (FALSE) en las variables indicadas.

VB Scripting
Nota
la función de sistema "DesactivarBit".

DesactivarBitEnVariable (Variable, Bit)

ResetBitInTag Tag, Bit
Parámetros
Variable
Variable en la que un bit se ajusta a "0" (FALSE).
Bit
Número del bit que se ajusta a "0" (FALSE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".

VB Scripting
Ejemplo
El siguiente código de programa pone a 0 un bit en la posición indicada bitposition de la
variable bStatusWord y muestra el resultado junto con el valor original bSaved.
Dim myTag
Dim myOutputField

'Save current value

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

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

ResetBitInTag ("bStatusWord", bitposition);

printf ("Current value: %d\r\n, Saved value: %d\r\n",GetTagByte("bStatusWord"), bSaved);
...
}
1.1.61 SafelyRemoveHardware (Panels, Comfort Panels)
Descripción
Comprueba si se llevan a cabo accesos de escritura o lectura al medio de almacenamiento
externo. Si no se realizan accesos, el medio de almacenamiento externo puede retirarse sin
perder datos.

VB Scripting

RetirarHardwareConSeguridad(Ruta, Resultado)

SafelyRemoveHardware Path, Result
Parámetros
Resultado
Variable en la que se registra el resultado.
TRUE: El medio de almacenamiento puede retirarse con seguridad. Se visualiza un aviso de
sistema al efecto.
FALSE: El medio de almacenamiento no puede retirarse. Se visualiza un aviso de sistema al
efecto.
Ruta
Ruta del medio de almacenamiento, p. ej., \Storage Card USB\
1.1.62 SaveDataRecord (Panels, Comfort Panels, RT Advanced)
Descripción
Guarda los valores actuales de las variables de receta como registro en el soporte de memoria
del panel de operador.
Utilice esta función de sistema por ejemplo para guardar un registro de receta en la imagen
de recetas.

GuardarRegistro (Número/Nombre de receta, Número/Nombre de registro, Sobrescribir,
Emitir aviso de estado, Estado de procesamiento)

SaveDataRecord Recipe_number_or_name, Data_record_number_or_name, Overwrite,

VB Scripting
Parámetros
Número o nombre de la receta en la que se deben almacenar los registros.
Número o nombre del registro de la receta que se almacena. Si en la receta no existe ningún
registro con este número o nombre, se creará un nuevo registro independientemente del valor
del parámetro "Sobrescribir".
Sobrescribir
Determina si se debe sobrescribir un registro de receta existente.
0 (hmiOverwriteForbidden) = No: El registro de receta no se sobrescribirá ni tampoco se
guardará.
1 (hmiOverwriteAlways) = Sí: El registro de receta se sobrescribirá sin consulta previa.
2 (hmiOverwriteWithConfirmation) = Previa confirmación: El registro de receta se sobrescribirá

Determina si se debe visualizar un aviso de estado después de guardar.
1.1.63 SendEMail (Panels, Comfort Panels, RT Advanced)
Descripción
Envía un correo electrónico desde el panel de operador al destinatario indicado.
Utilice esta función de sistema si p.ej. en caso de mantenimiento o reparación desea transferir
el aviso directamente a los técnicos responsables.
Nota
Para enviar los avisos adicionalmente en forma de correo electrónico, el sistema HMI debe
disponer de un cliente de correo electrónico.

VB Scripting

EnviarCorreoElectronico (Dirección, Asunto, Texto, Dirección de respuesta)

SendEMail Address, Subject, Text, Return_address
Parámetros
Dirección
Dirección de correo electrónico del destinatario.
Asunto
Línea de asunto del mensaje de correo electrónico.
Texto
Texto que se envía en el mensaje de correo electrónico.
Dirección de respuesta
Dirección de correo electrónico a la que el destinatario debe enviar la respuesta.
1.1.64 SetAcousticSignal (Panels, Comfort Panels, RT Advanced)
Descripción
Configura la notificación acústica del panel de operador al manejar la pantalla táctil.
Nota
Cuando rearranque el panel de operador se restablecerá la configuración que estaba ajustada
al apagarlo.

ConfigurarSeñalAcústica (Volumen)

SetAcousticSignal Volume

VB Scripting
Parámetros
Volumen
Determina si se debe emitir una señal acústica, así como su volumen.
-1 (hmiToggle) = Conmutar: Conmuta el volumen de salida de la señal acústica como se indica
a continuación: Silenciada > Baja > Alta.
0 (hmiMuted) = Silenciada: Sin señal acústica
1 (hmiQuiet) = Baja: Señal acústica a bajo volumen
2 (hmiLoud) = Alta: Señal acústica a alto volumen
1.1.65 SetAlarmReportMode (Panels, Comfort Panels, RT Advanced)
Descripción
Activa o desactiva la generación automática de informes para avisos en la impresora.

ActivarModoDeInformeAviso (Modo)

SetAlarmReportMode Mode
Parámetros
Modo
Determina si los avisos se deben imprimir automáticamente en la impresora:
0 (hmiDisablePrinting) = Inhibir impresión: Los informes no se imprimen automáticamente.
1 (hmiEnablePrinting) = Habilitar impresión: Los informes se imprimen automáticamente.
1.1.66 SetBit (Panels, Comfort Panels, RT Advanced)
Descripción
Ajusta a "1" (TRUE) el valor de una variable del tipo "Bool".

VB Scripting

ActivarBit (Variable)

SetBit Tag
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "1" (TRUE).
Ejemplo
función SetBit y muestra el resultado junto con el valor original bSaved.
Dim myTag
Dim myOutputField

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

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


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

...
}
1.1.67 SetBitInTag (Panels, Comfort Panels, RT Advanced)
Descripción
Ajusta un bit a "1" (TRUE) en la variable indicada.
Nota
la función de sistema "ActivarBit".

ActivarBitDeVariable (Variable, Bit)

SetBitInTag Tag, Bit
Parámetros
Variable
Variable en la que un bit se ajusta a "1" (TRUE).

VB Scripting
Bit
Número del bit que se ajusta a "1" (TRUE).
Nota
Para garantizar una funcionalidad fiable es imprescindible una actualización garantizada de
las variables utilizadas con los valores de proceso actuales. Por tanto, configure la variable
en un campo E/S, o bien asocie la función de sistema a un objeto de imagen (p. ej. un botón).
Si asocia la función de sistema a un evento breve (p. ej. aparición de un mensaje), los valores
de proceso actuales sólo se alcanzarán si la variable puede leerse de forma permanente.
Ejemplo
Dim myTag
Dim myOutputField

'Save current value

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

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

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

VB Scripting
{
BYTE bSaved;

SetBitInTag ("bStatusWord", bitposition);

1.1.68 SetBrightness (Panels, Comfort Panels, RT Advanced)
Descripción
Define el brillo de la pantalla.
Nota
Al reiniciar el panel de operador se restablece la configuración que estaba ajustada en el
Control Panel/Start Center.
Es aplicable a Basic Panels 2nd Generation, Mobile Panels y Comfort Panels:

El valor de la función de sistema "EstablecerBrillo" puede ajustarse entre 0 % y 100 %. El
valor ajustado se transfiere al panel de operador. Los ajustes de brillo en el panel de operador
pueden verse y editarse en "Start Center > Settings > Display". Los paneles de operador
soportan un ajuste de brillo entre 10 % y 100 %.
Si se asigna un valor de 0 % a la función de sistema "EstablecerBrillo", la pantalla del panel
de operador estará desconectada por defecto en runtime. Cuando el operador toca la pantalla,
esta cambia al ajuste de brillo anterior.
Si se asigna un valor entre 1 % y 10 % a la función de sistema "EstablecerBrillo" y el operador
abre el ajuste de la pantalla en el Start Center, el brillo cambiará al 10 %.

EstablecerBrillo (Valor)

SetBrightness Value

VB Scripting
Parámetros
Valor
Valor nuevo del brillo.
1.1.69 SetConnectionMode (Panels, Comfort Panels, RT Advanced)
Descripción
Establece o desconecta la conexión indicada.
Nota
Solo puede establecerse una conexión con el controlador si el panel de operador funciona en
modo "online". Utilice para ello la función de sistema "EstablecerModoDeOperaciónPanel".
Si la conexión se ha cargado en el modo "offline", cada vez que se cambie el modo de
operación "offline" se deshará la conexión. Para restablecer la conexión después de volver a
cambiar el modo de operación "online", pase de nuevo la conexión al modo "online".

EstablecerModoDeConexión (Modo, Conexión)

SetConnectionMode Mode, Connection
Parámetros
Modo
Determina si la conexión con el controlador se debe establecer o desconectar. En equipos
con Windows CE y en Runtime Advanced no es posible asignar un valor a este parámetro
con una variable del tipo de datos BOOL.
0 (hmiOnline) = Online: Se establece la conexión.
1 (hmiOffline) = Offline: Se deshace la conexión.

VB Scripting
Conexión
Controlador que se debe conectar con el panel de operador. El nombre del controlador se
establece en el editor de conexiones.
Utilización múltiple de la función de sistema en un script de usuario

Si utiliza la función de sistema "EstablecerModoDeConexión" para diferentes conexiones,
puede suceder que no todas las funciones de sistema se ejecuten correctamente. Para evitar
este problema, proceda del siguiente modo:
1. Cree una variable con el valor inicial "0".
2. Asocie la función de sistema "EstablecerModoDeConexión" al evento "Modificación de
valor" de la variable HMI. Si desea deshacer p. ej. 3 conexiones, deberá configurar la
función de sistema tres veces.
3. En el script de usuario, aplique a la variable HMI la función de sistema "InvertirBit".
A continuación se indican dos ejemplos de aplicación típicos de esta función de sistema:
● Test
Mientras que no haya ningún controlador conectado al panel de operador, durante el test
no se indicarán mensajes de error en el panel de operador. Si el panel de operador está
conectado a un controlador, podrá establecer la conexión con éste último pulsando una
tecla.
● Puesta en servicio
Se deben configurar varios controladores para una instalación. Configure primero todos
los controladores "offline", exceptuando uno de ellos. Tras poner en marcha el primer
controlador, establezca la conexión con todos los demás, pulsando para ello la tecla
correspondiente. Así podrá poner en marcha los demás controladores uno tras otro.
1.1.70 SetDataRecordTagsToPLC (Panels, Comfort Panels, RT Advanced)
Descripción
Transfiere los valores de las variables de receta al controlador. Las variables de receta
contienen los valores del registro que se visualiza en el panel de operador.

EscribirVariableDeRegistroEnControlador (Número/Nombre de receta, Estado de
procesamiento)

SetDataRecordTagsToPLC Recipe_ number_or_name, Processing_status

VB Scripting
Parámetros
Número o nombre de la receta desde la que se debe transferir un registro al controlador.
1.1.71 SetDataRecordToPLC (Panels, Comfort Panels, RT Advanced)
Descripción
Transfiere el registro de receta indicado directamente desde el soporte de datos del panel de
operador al controlador conectado con el panel de operador.
Nota
A este efecto no es necesario que los valores del registro de receta se visualicen en el panel
de operador.

EscribirRegistroEnControlador (Número/Nombre de receta, Número/Nombre de registro,
Emitir aviso de estado, Estado de procesamiento)

SetDataRecordToPLC Recipe_number_or_name, Data_record_number_or_name,
Parámetros
Número o nombre de la receta desde la que se debe transferir un registro al controlador.

VB Scripting
Número o nombre del registro de receta que se debe transferir al controlador.

Establece si se debe visualizar un aviso de estado una vez concluida la transferencia.
1.1.72 SetDaylightSavingTime (Panels, Comfort Panels, RT Advanced)
Descripción
La función de sistema "AjustarHorarioVerano" cambia la hora del panel de operador a horario
de verano o invierno.
El cambio de horario se efectúa inmediatamente después de ejecutar la función de sistema.
Nota
La función "AjustarHorarioVerano" no soporta zonas horarias sin horario de verano.
Nota
Windows 7
La función de sistema "AjustarHorarioVerano" no se soporta en paneles de operador basados
en PC con Windows 7.

AjustarHorarioVerano(Horario de verano)

SetDaylightSavingTime Daylight_saving_time

VB Scripting
Parámetros
Horario de verano
Determina si se activa el horario de verano en el panel de operador:
0 = Horario de verano no activado
1 = Horario de verano activado
1.1.73 SetDeviceMode (Panels, Comfort Panels, RT Advanced)
Descripción
Cambia el modo de operación en el panel de operador. Se dispone de los modos de operación
siguientes: "Online", "Offline" y "Cargar".

EstablecerModoDeOperaciónPanel (Modo de operación)

SetDeviceMode Operating_mode
Parámetros
Modo de operación
Determina el modo de operación del panel de operador. En equipos con Windows CE no se
puede asignar un valor a este parámetro por medio de una variable del tipo de datos BOOL.
0 (hmiOnline) = Online: Se establece la conexión con el controlador. Al hacerlo, siempre se
ajusta el estado de conexión configurado. No se tienen en cuenta los estados que se utilizaron
por última vez en runtime.
1 (hmiOffline) = Offline: Se deshace la conexión con el controlador.
2 (hmiTransfer) = cargar: Permite transferir proyectos desde el equipo de configuración al
panel de operador.
Nota
Si utiliza un PC como panel de operador, al conmutar al modo de operación "Cargar" se cierra
el software runtime.

VB Scripting
1.1.74 SetDisplayMode (Panels, Comfort Panels, RT Advanced)
Descripción
Cambia la configuración de la ventana en la que se ejecuta el software runtime.
Por defecto, el software runtime se ejecuta en modo de pantalla completa. La posibilidad de
conmutar entre las aplicaciones de Windows está desactivada.

ConfigurarModoDeVisualización (Modo de visualización)

SetDisplayMode Display_mode
Parámetros
Representación
Determina la configuración de la ventana en la que se ejecuta el software runtime.
1 (hmiScreenFull): Pantalla completa: La barra de título de la ventana no se visualiza.
2 (hmiScreenMaximized): Maximizado
3 (hmiScreenRestore): Restaurar: Se utiliza la configuración de ventana que se ha utilizado
de último. Este modo de visualización sólo se puede utilizar si la ventana aparece minimizada
o maximizada.
4 (hmiScreenMinimized): Minimizado
5 (hmiScreenAutoAdjust): Automático: El tamaño de la ventana se ajusta de manera que se
visualicen todos los objetos de imagen que contiene.
6 (hmiScreenOnTop): Primer plano; en función de la configuración de Windows aparecerá la
ventana en primer plano o bien el símbolo del programa en cuestión parpadeará en la barra
de tareas. La configuración puede modificarse en Windows y es válida para todas las
aplicaciones de Windows.
1.1.75 SetLanguage (Panels, Comfort Panels, RT Advanced)
Descripción
Cambia el idioma del panel de operador. Todos los textos y avisos del sistema configurados
aparecerán en el panel de operador en el idioma recién ajustado.

VB Scripting

EstablecerIdioma (Idioma)

SetLanguage Language
Parámetros
Idioma
Determina qué idioma se debe ajustar en el panel de operador. Se pueden realizar los
siguientes ajustes:
● -1 (hmiToggle) = Conmutar: Cambia al siguiente idioma. El orden se establece en el editor
"Idiomas del proyecto" durante el proceso de configuración.
● Número que se ha especificado en "Idioma y fuente" en el editor "Configuración de
runtime". Cambia al idioma con el número indicado.
● Idioma que se ha especificado en "Idioma y fuente" en el editor "Configuración de runtime".
● Abreviatura del idioma conforme a la referencia VBScript5: Cambia al idioma
correspondiente a la abreviatura indicada, p. ej. "de-DE" para alemán (Alemania) o "en-
US" para inglés (EE.UU.).
En el tema "Cuadro de Id. de configuración regional (LCID)" que forma parte de los
principios básicos de VBScript encontrará una lista de todas las abreviaturas de idioma.
1.1.76 SetPLCDateTime (Panels, Comfort Panels, RT Advanced)
Descripción
Modifica la fecha y la hora del controlador conectado.
La función de sistema "AjustarFechaHoraPLC" solo se puede configurar para los siguientes
controladores:
● SIMATIC S7-1200
● SIMATIC S7-1500

AjustarFechaHoraPLC (conexión, tiempo)

-

VB Scripting
Parámetros
Conexión
Conexión de controlador y panel de operador.
Tiempo
Transfiere la fecha y la hora del panel de operador al controlador. El controlador aplica la fecha
y la hora del panel de operador.
1.1.77 SetRecipeTags (Panels, Comfort Panels, RT Advanced)
Descripción
Modifica el estado de las variables de receta de "online" a "offline" y viceversa.
Utilice esta función de sistema si p.ej. desea realizar un ajuste fino de los valores de los
registros de receta al poner en marcha una máquina.

DefinirEstadoVariableDeReceta (Número/nombre de receta, Estado, Emitir aviso de estado,
Estado de procesamiento)

SetRecipeTags Recipe_number_or_name, Status, Output_status_message,
Processing_status
Parámetros
Número o nombre de la receta en la que está almacenado el registro.
Estado
Determina el estado de las variables de la receta:
0 (hmiOnline) = Online: Los cambios de valores en las variables de receta se transfieren de
inmediato al controlador conectado con el panel de operador.
1 (hmiOffline) = Offline: Los cambios de valores en las variables de la receta se transfieren al
controlador conectado con el panel de operador inmediatamente después de ejecutar p.ej. la
función de sistema "EscribirVariablesDeRegistroEnControlador".

Determina si se debe visualizar un aviso de estado después de guardar.

VB Scripting

1.1.78 SetScreenKeyboardMode (Panels, Comfort Panels, RT Advanced)
Descripción
Activa o desactiva la visualización automática del teclado de la pantalla en el panel de
operador.
Utilice esta función de sistema si desea impedir que aparezca el teclado de pantalla por
ejemplo porque dispone de un teclado externo conectado al panel de operador.
Nota
Si utiliza la función de sistema "EstablecerModoTecladoDePantalla"
("SetScreenKeyboardMode") en un panel de operador que carezca de pantalla táctil, en la
configuración del panel deberá activar la opción "Utilizar teclado pantalla" en el área
"Configuración de runtime".

EstablecerModoTecladoDePantalla (Modo)

SetScreenKeyboardMode Mode
Parámetros
Modo
Determina si el teclado de la pantalla se debe mostrar u ocultar.
0 (hmiOff) = Off: Ocultar el teclado de la pantalla
1 (hmiOn) = On: Mostrar el teclado de la pantalla

VB Scripting
1.1.79 SetTag (Panels, Comfort Panels, RT Advanced)
Descripción
Asigna un valor nuevo a la variable indicada.
Nota
Dependiendo del tipo de variable, con esta función de sistema puede asignar cadenas de
caracteres y números.

DefinirVariable (Variable, Valor)

SetTag Tag, Value
Parámetros
Variable
Variable a la que se debe asignar el valor indicado.
Valor
Valor que se asigna a la variable indicada.
Nota
La función de sistema "DefinirVariable" se ejecuta únicamente tras establecer una conexión.

VB Scripting
Ejemplo
El siguiente código de programa ajusta con la función SetTag el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok.
{
BOOL ok;
BOOL bvalue;
//Set the tag to true

ok = SetTag("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
bvalue = GetTagBit("gs_tag_bit");
printf ("Value of gs_tag_bit: %d\r\n", bvalue);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}
1.1.80 ShiftAndMask (Panels, Comfort Panels, RT Advanced)
Descripción
La función de sistema convierte la configuración binaria de entrada de la variable de origen
en una configuración binaria de salida de la variable de destino. Durante este proceso se
desplazan y se enmascaran bits.
Nota
Si las variables de origen y destino tienen un número de bits diferente, la aplicación de la
función de sistema en la variable de destino no puede causar un rebase del rango de valores.

DesplazarYEnmascarar (Variable de origen, Variable de destino, Bits a desplazar, Bits a
enmascarar)

VB Scripting

ShiftAndMask Source_tag, Target_tag, Bits_to_shift, Bits_to_mask
Parámetros
Variable de origen
La variable contiene la configuración binaria de entrada. Se admiten variables de números
enteros, p. ej. "Byte", "Char", "Int", "UInt", "Long" y "ULong".
Ejemplo: La variable de origen del tipo "16 Bit Integer" tiene el valor 72: 0000000001001000.
Variable de destino
En la variable se guarda la configuración binaria de salida. Se admiten variables de tipo entero,
p. ej. "Byte", "Char", "Int", "UInt", "Long" y "ULong".
Ejemplo: La configuración binaria de entrada desplazada se multiplica con la máscara de bits,
bit por bit con la operación lógica Y: 0000000000001001. El resultado tiene el valor decimal
"8" y se guarda en la variable de destino.
Tenga en cuenta lo siguiente:
● Las variables de origen y destino tienen el mismo número de bits.
● La cantidad de bits a desplazar es menor que la cantidad de bits de las variables de origen
y de destino.
● "Bits a enmascarar" no contiene más bits que las variables de origen y destino.
Bits a desplazar
Cantidad de bits según la que se debe desplazar hacia la derecha la configuración binaria de
entrada. Un valor negativo desplaza la configuración binaria de entrada hacia la izquierda.
Ejemplo: "Bits a desplazar" tiene el valor "+3". Al llamar la función de sistema, la configuración
binaria de entrada se desplaza 3 bits hacia la derecha: 0000000000001001.
El lado izquierdo se rellena con "0". En el lado derecho se truncan 3 bits. El nuevo valor decimal
es "9".
Nota
Si la variable de origen tiene un tipo de datos Integer con el signo "-", el bit izquierdo será "1".
Al desplazar hacia la derecha, este bit de signo se rellena con "0". El signo se conmuta a "+".
Bits a enmascarar
Un número del tipo Integer sirve de máscara de bits Con su configuración binaria se multiplica
la configuración binaria de entrada desplazada. Ejemplo: número "2478" con la configuración
binaria "0000100110101110".

VB Scripting
La máscara de bits se puede indicar de 3 maneras distintas:

● Hexadecimal: Introduzca primero "0h" o "0H" como prefijo, seguido de un espacio en blanco
opcional para una mejor legibilidad. Seguidamente agrupe la configuración binaria en
bloques de cuatro bits (0000)(1001)(1010)(1110) y represente cada bloque en el sistema
hexadecimal. (0)(9)(A)(E). Sólo se admite la entrada de los caracteres 0-9, A-F, a-f: "0h
09AE".
● Binario: Introduzca primero "0b" o "0B" como prefijo, seguido de un espacio en blanco
opcional para una mejor legibilidad. Para comprobarlo, agrupe después la configuración
binaria en bloques 0000 1001 1010 1110 separados por espacios en blanco. Sólo se admite
la entrada de los caracteres "0" ó "1": "0b 0000 1001 1010 1110".
● Decimal: Introduzca directamente el valor "2478" sin prefijo.
Nota
Si cambia la versión del panel de operador de destino después de la configuración (p. ej., de
"13.1.0" a "13.0.0" o a la inversa), deberá comprobar los parámetros de esta función de
sistema.
Los tipos de datos "Char" y "Word" pueden utilizarse para los parámetros "Variable de origen"
y "Variable de destino" a partir de la versión de panel 13.1.0. En las versiones de panel
anteriores a la 13.1.0, estos parámetros deben asignarse a otros tipos de datos:
● En lugar de "Char", debe utilizarse "SInt"
● En lugar de "Word", debe utilizarse "Int"
De lo contrario pueden producirse efectos indeseados, p. ej., comportamiento erróneo o
inesperado de las funciones de sistema configuradas.
1.1.81 ShowAlarmWindow (Panels, Comfort Panels, RT Advanced)
Descripción
Muestra u oculta la ventana de avisos en el panel de operador.

MostrarVentanaDeAvisos (Nombre del objeto, Representación)

ShowAlarmWindow Object_name, Display_mode

VB Scripting
Parámetros
Nombre del objeto

Nombre del visor de avisos que se debe mostrar u ocultar.
Representación
Determina si la ventana de avisos se debe mostrar u ocultar.
0 (hmiOff) = Off: Ocultar el visor de avisos
1 (hmiOn) = On: Mostrar el visor de avisos
1.1.82 ShowOperatorNotes (Panels, Comfort Panels, RT Advanced)
Utilización
Muestra el tooltip configurado para el objeto seleccionado.
Si la función de sistema se ha asociado a una tecla de función, se mostrará el tooltip
correspondiente al objeto de imagen resaltado en ese momento. Si al mismo tiempo se ha
configurado un tooltip para la imagen, será posible conmutar a ésta bien sea pulsando la tecla
<Intro> o bien haciendo doble clic en la ventana de ayuda.
Si la función de sistema se ha asociado a un botón, se mostrará sólo el tooltip de la imagen
actual. Si se ha configurado también un tooltip asociado al botón, se mostrará primero dicho
texto. Pulsando la tecla <Intro> o haciendo doble clic en la ventana de ayuda se conmuta al
tooltip de la imagen actual.
Nota
Mientras esté abierta la ventana de ayuda, no se podrá operar ningún otro objeto de imagen.
Para operar los objetos de imagen, cierre la ventana de ayuda.
Cerrar la ventana de ayuda

La ventana de ayuda se puede cerrar de las maneras siguientes:
En paneles de operador con teclado:
● Pulsando de nuevo la tecla <HELP>
● Pulsando la tecla <HELP>
En paneles de operador con pantalla táctil:
● Tocando el botón

MostrarTextoDeAyuda (Representación)

VB Scripting

ShowOperatorNotes Display_mode
Parámetros
Representación
Determina si el tooltip configurado se debe mostrar u ocultar:
0 (hmiOff) = Off: ocultar el tooltip configurado
1 (hmiOn) = On: mostrar el tooltip configurado
1.1.83 ShowPopUpScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Llama la imagen emergente, p. ej. al pulsar un botón.
Como coordenadas puede indicar un valor constante o asignar una variable.
Si la imagen emergente configurada no es visible o solo lo es parcialmente, las coordenadas
se ajustan a 0.0.
Sea cual sea el tamaño del área permanente, la posición inicial de las coordenadas es siempre
0.0.

MostrarImagenEmergente (nombre de la imagen, coordenada X, coordenada Y, modo de
visualización, animación, velocidad de la animación)

ShowPopupScreen Screen_name, X_coordinate, Y_coordinate, Display_mode, Animation,
Animation_speed
Parámetros
Nombre de la imagen
Define el nombre de la imagen emergente que aparece en runtime al pulsar el botón.
Coordenada X
Posición de la imagen emergente en el eje X de la imagen actual

VB Scripting
Coordenada Y
Posición de la imagen emergente en el eje Y de la imagen actual
Modo de visualización
Define el modo de la imagen emergente:
Conmutar
Off
On
Animación
Determina la dirección en la que aparece la imagen emergente:
Off
Izquierda
Arriba
Derecha
Abajo
Velocidad de la animación
Determina la velocidad con que aparece la imagen emergente:
Lenta
Media
Rápida
1.1.84 ShowPopupScreenSizable (Panels, Comfort Panels, RT Advanced)
Descripción
Llama la imagen emergente con un tamaño definido. Con esta función de sistema se puede
abrir una imagen emergente en otro tamaño, y para navegar por el contenido de la imagen
emergente se muestran las barras de desplazamiento.
Como coordenadas puede indicar un valor constante o asignar una variable. Si la imagen
emergente configurada no es visible o solo lo es parcialmente, las coordenadas se ajustan a
0.0. Sea cual sea el tamaño del área permanente, la posición inicial de las coordenadas es
siempre 0.0.

VB Scripting
Además, se definen la anchura y la altura visualizadas de la imagen emergente, que pueden

no coincidir con los tamaños de la imagen emergente configurada. En tal caso se visualizan
las barras de desplazamiento en la imagen emergente.
Nota
Manejo en paneles de operador con teclas
Para desplazarse por las imágenes emergentes, utilice la combinación de teclas <ALT>
+<tecla de flecha>.
Mostrar solo una barra de desplazamiento

Si en los parámetros de la función del sistema se indica únicamente un tamaño menor que el
tamaño de la imagen emergente configurada, se visualizan las dos barras de desplazamiento
en la imagen emergente. Existen dos posibilidades para configurar solo una barra de
desplazamiento en la imagen emergente:
● Reduzca la anchura/altura de la imagen emergente configurada en el equivalente al
tamaño de la barra de desplazamiento específica del dispositivo.
● Defina, para un parámetro de tamaño, el valor que coincida con el tamaño real de la imagen
emergente, y añádale el tamaño de la barra de desplazamiento específica del panel. Defina
el valor del otro tamaño según sus necesidades.
Ejemplo:
Desea llamar una imagen emergente con un tamaño configurado de 500 x 420 en el tamaño
500 x 300 con una barra de desplazamiento vertical. Asigne al parámetro Anchura el valor
534, que equivale a la anchura real de la imagen emergente configurada más el tamaño
de la barra de desplazamiento (34). Introduzca el valor 300 para la Altura. En runtime, la
imagen emergente se llamará en el tamaño 500 x 300 y solo se visualizará la barra de
desplazamiento vertical.
Tipo de panel (versión V14) Anchura Altura

Paneles de operador con un tamaño de pantalla de 4" 25 25
Comfort Panels con un tamaño de pantalla de 19''
Runtime Advanced
Comfort Panels con un tamaño de pantalla de 15"
Comfort Panels con un tamaño de pantalla de 22"
Paneles de operador con un tamaño de pantalla de 12"

MostrarImagenEmergenteTamañoModificable (nombre de la imagen, coordenada X,
coordenada Y, ancho, altura, modo de visualización, animación, velocidad de la animación)

VB Scripting

ShowPopupScreenSizable Screen_name, X_coordinate, Y_coordinate, Width, Height,
Display_mode, Animation, Animation_speed
Parámetros
Nombre de la imagen
Define el nombre de la imagen emergente que aparece en runtime al pulsar el botón.
Coordenada X
Posición de la imagen emergente en el eje X de la imagen actual
Coordenada Y
Posición de la imagen emergente en el eje Y de la imagen actual
Anchura
Determina la anchura de la imagen emergente. La anchura máxima no debe exceder la
anchura de la pantalla del panel de operador configurado.
Altura
Determina la altura de la imagen emergente. La altura máxima no debe rebasar la altura de
imagen del panel de operador configurado.
Modo de visualización
Define el modo de la imagen emergente:
Conmutar
Off
On
Animación
Determina la dirección en la que aparece la imagen emergente:
Off
Izquierda
Arriba
Derecha
Abajo
Velocidad de la animación
Determina la velocidad con que aparece la imagen emergente:
Lenta
Media
Rápida

VB Scripting
1.1.85 ShowSlideInScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Llama la imagen deslizable, p. ej., al pulsar un botón.

MostrarImagenDeslizable (nombre de imagen, modo)

ShowSlideInScreen SlideInScreen_name, Mode
Parámetros
Nombre de imagen
Define la imagen deslizable que aparece en runtime al pulsar el botón:
Imagen deslizable arriba
Imagen deslizable abajo
Imagen deslizable a la izquierda
Imagen deslizable a la derecha
Modo
Define el modo para la imagen deslizable:
Conmutar
Off
On
1.1.86 ShowSoftwareVersion (Panels, Comfort Panels, RT Advanced)
Descripción
Muestra u oculta el número de versión del software runtime.
Utilice esta función de sistema por ejemplo si en caso de reparación o mantenimiento necesita
saber la versión del software runtime utilizado.

VB Scripting

MostrarVersiónDeSoftware (Representación)

ShowSoftwareVersion Display_mode
Parámetros
Representación
Determina si el número de versión se debe mostrar u ocultar:
0 (hmiOff) = Off: Ocultar el número de versión
1 (hmiOn) = On: Mostrar el número de versión
1.1.87 ShowSystemAlarm (Panels, Comfort Panels, RT Advanced)
Descripción
Muestra el valor del parámetro transferido como aviso del sistema en el panel de operador.

MostrarAvisoDeSistema (Texto/valor)

ShowSystemAlarm Text_or_value
Parámetros
Texto/valor
Texto o valor a emitir como aviso del sistema.

VB Scripting
1.1.88 ShowSystemDiagnosticsWindow (Panels, Comfort Panels)
Descripción
Muestra u oculta la ventana de diagnóstico del sistema en el panel de operador. La ventana
de diagnóstico del sistema sólo está disponible en la imagen general para Comfort Panels y
WinCC Runtime Advanced.

MostrarVentanaDeDiagnósticoDelSistema (Objeto de imagen)

ShowSystemDiagnosticsWindow Object_name
Parámetros
Objeto de imagen
Nombre de la ventana de diagnóstico del sistema que se debe mostrar u ocultar.
1.1.89 StartLogging (Panels, Comfort Panels, RT Advanced)
Descripción
Inicia la archivación de valores de proceso o avisos en el fichero indicado. La función también
puede aplicarse a los Audit Trails.
La archivación se puede cancelar en runtime utilizando la función de sistema
"PararArchivación".

IniciarArchivación (Tipo de fichero, Fichero)

StartLogging Log_type, Log

VB Scripting
Parámetros
Tipo de fichero
2 (hmiAudittrailArchive) = Audit Trail
Fichero
Nombre del fichero a iniciar.
1.1.90 StartNextLog (Panels, Comfort Panels, RT Advanced)
Descripción
Detiene la archivación de valores de proceso o avisos en el fichero indicado.
La archivación continúa en el siguiente fichero del fichero circular segmentado para el que
haya configurado el fichero indicado.
Si no ha configurado ningún fichero circular segmentado para el fichero indicado, esta función
de sistema no tendrá ningún efecto.

IniciarFicheroSiguiente (Tipo de fichero, Fichero)

StartNextLog Log_type, Log
Parámetros
Tipo de fichero
Fichero
Nombre del fichero para el que se ha detenido la archivación y que continuará en el fichero
siguiente.

VB Scripting
1.1.91 StartProgram (Panels, Comfort Panels, RT Advanced)
Descripción
Inicia el programa indicado en el panel de operador.
El software runtime se sigue ejecutando en segundo plano. Los avisos se siguen visualizando
y los valores de proceso se siguen actualizando.
Si finaliza la aplicación indicada, en el panel de operador se visualizará la imagen que estaba
activada al ejecutar la función de sistema.
Utilice esta función de sistema por ejemplo para editar registros de receta en el panel de
operador en MS Excel.
Nota
Si Windows CE está instalado en el panel de operador, compruebe durante la configuración
si la aplicación deseada se puede iniciar con esta función de sistema.
Utilizando esta función de sistema podrá iniciar todas las aplicaciones que se pueden iniciar
en el cuadro de diálogo "Ejecutar" de Windows CE.
La aplicación que desea abrir debe estar instalada en el panel de operador.
Nota
Si una aplicación no se puede ejecutar en un Mobile Panel o Comfort Panel con la función de
sistema "IniciarPrograma", compruebe la ruta indicada en la función de sistema. Los Mobile
Panels y los Comfort Panels incluyen algunas aplicaciones en la carpeta "\flash\addons".

IniciarPrograma (Nombre del programa, Parámetros del programa, Representación, Esperar
fin de programa)

StartProgram Program_name, Program_parameters, Display_mode,
Wait_for_program_to_end

VB Scripting
Parámetros
Nombre del programa

Nombre y ruta del programa a iniciar. En este parámetro se distingue entre mayúsculas y
minúsculas.
Nota
Si la ruta contiene un espacio en blanco, el programa sólo se iniciará correctamente si la ruta
se indica entre comillas, p. ej. "C:\Program Files\START\start.exe".
Parámetros del programa

Parámetros a transferir al iniciar el programa, p.ej. un archivo que se deba abrir tras el inicio
del programa.
Los parámetros necesarios se describen en la documentación del programa a iniciar.
Representación
Determina cómo se debe visualizar la ventana del programa en el panel de operador:
0 (hmiShowNormal) = Normal
1 (hmiShowMinimized) = Minimizada
2 (hmiShowMaximized) = Maximizada
3 (hmiShowMinimizedAndInactive) = Minimizada e inactiva
Esperar fin de programa

Determina si se debe regresar al proyecto al finalizar el programa:
0 (hmiNo) = No: No regresar al proyecto.
1 (hmiYes) = Sí: Regresar al proyecto.
Nota
El parámetro "Esperar fin de programa" sólo está disponible en Runtime Advanced y Panels.
1.1.92 StopLogging (Panels, Comfort Panels, RT Advanced)
Descripción
Detiene la archivación de valores de proceso o avisos en el fichero indicado. La función
también puede aplicarse a los Audit Trails.

VB Scripting
La archivación se puede reiniciar en runtime utilizando la función de sistema

"IniciarArchivación".
Nota
Cuando se detiene la archivación permanece establecida la conexión entre WinCC y los
archivos comprimidos o la base de datos de ficheros. Para deshacer esta conexión, utilice la
función de sistema "CerrarTodosLosFicheros".

PararArchivar (Tipo de fichero, Fichero)

StopLogging Log_type, Log
Parámetros
Tipo de fichero
2 (hmiAudittrailArchive) = Audit Trail
Fichero
Nombre del fichero a detener.
Configure las funciones de sistema "PararArchivación" y "CerrarTodosLosFicheros" y
asócielas al botón "Close Archive".
Cuando pulse el botón "Close Archive" se parará el fichero indicado y se cerrarán todos los
ficheros abiertos. A continuación podrá cambiar el soporte de datos. Si pulsa el botón "Open

VB Scripting
Archive" se abrirán de nuevo todos los ficheros, pudiendo continuar con la archivación en el
fichero indicado.
1.1.93 StopRuntime (Panels, Comfort Panels, RT Advanced)
Descripción
Sale del software runtime y, con ello, del proyecto que se está ejecutando en el panel de
operador.

PararRuntime (Modo)

StopRuntime Mode
Parámetros
Modo
Determina si al finalizar el software runtime también se debe cerrar el sistema operativo.
0 (hmiStopRuntime) = Runtime: No cerrar el sistema operativo
1 (hmiStopRuntimeAndOperatingSystem) = Runtime y sistema operativo: Cerrar el sistema
operativo (no en Windows CE)
Ejemplo
El siguiente código de programa cierra Runtime y el sistema operativo.
//Stop runtime and shutdown

StopRuntime (hmiStopRuntimeAndOperationSystem);

VB Scripting
1.2 Funciones de sistema (RT Professional)
1.1.94 TerminatePROFIsafe (Panels, Comfort Panels, RT Advanced)
Descripción
Deshace la conexión PROFIsafe para el modo de seguridad positiva entre un KTP Mobile
Panel y el controlador.
Tras ejecutar la función de sistema "DesconectarPROFIsafe", el conector del KTP Mobile
Panel puede desenchufarse del controlador sin que la instalación notifique un error.

DesconectarPROFIsafe

TerminatePROFIsafe
Puede utilizarse siempre que el dispositivo configurado soporte funciones definidas por el
usuario. Encontrará más información al respecto en "Dependencia del panel de operador".
Parámetros
--
1.2.1 ActivateScreen (RT Professional)
Descripción



VB Scripting
Parámetros
Nombre de imagen
Número del objeto

configuración.
Si indica "0":
enfocada.
Nota
cambio de imagen.
Ejemplo
'Userdefined code
1.2.2 ActivateScreenInScreenWindow (RT Professional)
Descripción
Efectúa un cambio de imagen en la ventana indicada para visualizar la imagen indicada.

ActivarImagenEnVentana (Nombre de imagen, Ventana de imagen, Nuevo nombre de imagen)

VB Scripting

ActivateScreenInScreenWindow Screen_name, Screen_window, New_screen_name
Encontrará más información en "AUTOHOTSPOT".
Parámetros
Nombre de imagen
Nombre de la imagen que se muestra en la ventana de imagen.
Ventana de imagen
Nombre de la ventana de imagen en la que se muestra la nueva imagen.
Nuevo nombre de imagen

Nombre de la nueva imagen que se muestra en la ventana de imagen.
Ejemplo
El siguiente código del programa activa la imagen "Screen_2" con la función
ActivateScreenInScreenWindow al pulsar cualquier tecla.
{
// User defined code
// i.e. when pressing a button
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
1.2.3 DecreaseTag (RT Professional)
Descripción
X=X-a
Nota

VB Scripting
Si se asocia la función de sistema a eventos de un aviso y la variable no se utiliza en la imagen



Parámetros
Variable
Valor
Ejemplo
El siguiente código de programa reduce el valor de la variable varX la cantidad que indica la
variable value. El valor introducido se guarda en la variable old_value y se muestra junto con
el nuevo valor varX.
{
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);
...
}

VB Scripting
1.2.4 ExportImportUserAdministration (RT Professional)
Descripción
Exporta todos los usuarios de la administración de usuarios del proyecto activo en este
momento al archivo indicado, o bien importa los usuarios del archivo indicado al proyecto
activo en este momento.
En la administración de usuarios se guardan usuarios, sus contraseñas y permisos.
Durante la importación se sobrescriben todos los usuarios. Los usuarios importados son
válidos desde el primer momento.
Nota
En los paneles de operador con una versión de runtime anterior a V14 no se soporta la
exportación e importación de la administración de usuarios de V14.

ExportarImportarAdministraciónDeUsuarios (Nombre de archivo, Dirección)

ExportImportUserAdministration File_name, Direction
Parámetros
Nombre de archivo
Nombre del archivo que contiene las contraseñas o en el que se guardarán las contraseñas.
Introduzca también la ruta y la extensión del archivo (*.txt), p. ej. "C:\TEMP\Passwords.txt".
Nota
Dirección
Determina si las contraseñas se exportarán o importarán:
0 (hmiExport) = Exportación: Las contraseñas se exportan.
1 (hmiImport) = Importación: Las contraseñas se importan.

VB Scripting
1.2.5 GetParentScreen (RT Professional)
Descripción
La función determina el nombre de la imagen superior a partir de una ruta dada.

LeerImagenSuperior (imagen)

GetParentScreen Screen
Parámetros
Imagen
El parámetro transferido Imagen debe tener la misma estructura que las rutas de imagen en
el sistema gráfico:
<nombre de imagen>.<nombre de ventana de imagen>:<nombre de imagen>.<nombre de
ventana de imagen>:<nombre de imagen>...
Si en la lista de funciones utiliza la lista de objetos para definir el parámetro, no se introducirá
la ruta, sino solo el nombre de la imagen.
Nota
El signo "." se utiliza para diferenciar el nombre de la imagen del objeto de imagen. El signo
":" se utiliza para la estructura jerárquica. Por tanto, para los nombres se deben utilizar
exclusivamente los separadores "-" y "_".
Valor de retorno
Nombre de la imagen superior
Principio
En una imagen "Screen_1" hay una ventana de imagen "Screenwindow_1". En la ventana de
imagen está la imagen "Screen_2" con la ventana de imagen "Screenwindow_2" etc.
Ruta de la imagen: Screen_1.Screenwindow_1:Screen_2.Screenwindow_2:Screen_3
GetParentScreen devuelve:
● "Screen_2", cuando la función de sistema se llama en la imagen "Screen_3"

VB Scripting
GetParentScreenwindow devuelve:
● "Screenwindow_2", cuando la función de sistema se llama en la imagen "Screen_3"
1.2.6 GetParentScreenWindow (RT Professional)
Descripción
La función determina el nombre de la ventana de imagen superior a partir de una ruta dada.

LeerVentanaDeImagenSuperior (imagen)

GetParentScreenWindow Screen
Parámetros
Imagen
El parámetro transferido Imagen debe tener la misma estructura que las rutas de imagen en
el sistema gráfico:
Si en la lista de funciones utiliza la lista de objetos para definir el parámetro, no se introducirá
la ruta, sino solo el nombre de la imagen.
Nota
El signo "." se utiliza para diferenciar el nombre de la imagen del objeto de imagen. El signo
":" se utiliza para la estructura jerárquica. Por tanto, para los nombres se deben utilizar
Valor de retorno
Nombre de la ventana de imagen superior

VB Scripting
Principio
1.2.7 IncreaseTag (RT Professional)
Descripción
X=X+a
Nota



Parámetros
Variable

VB Scripting
Valor
Valor que se suma.
Ejemplo
El siguiente código de programa aumenta el valor de la variable varX la cantidad que indica
la variable value. El valor introducido se guarda en la variable old_value y se muestra junto
con el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
//Increase tag
IncreaseTag(varX, value);

printf ("User input: %i\r\n, Result of function IncreaseTag: %i\r\n", old_value, varX);
...
}
1.2.8 InverseLinearScaling (RT Professional)
Descripción
"EscalaLineal".
Nota


VB Scripting

Parámetros
X
Y
b
a
Ejemplo
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;


...
}

VB Scripting
1.2.9 InvertBit (RT Professional)
Descripción


InvertBit Tag
Parámetros
Variable

VB Scripting
Ejemplo
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

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

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

...
}
1.2.10 InvertBitInTag (RT Professional)
Descripción

VB Scripting
Nota


Parámetros
Variable
Bit

VB Scripting
Ejemplo
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue

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

{
BYTE bStatusWord;

...
}
1.2.11 LinearScaling (RT Professional)
Descripción

VB Scripting
Nota


Parámetros
Y
a
X
b
Valor que se suma.

VB Scripting
Ejemplo
Yvar.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling

...
}
1.2.12 LookupText (RT Professional)
Descripción
Lee el registro de una lista de textos. El resultado depende del valor y del idioma de runtime
seleccionado. El resultado se guarda en una variable del tipo "String".

Consultar texto (Texto de salida, Índice, Idioma, Lista de textos)

LookupText Output_text, Index, Language, Text_list
Parámetros
Texto de salida
Variable en la que se escribe el resultado.
Índice
Variable que determina el valor del registro de la lista.

VB Scripting
Idioma
Determina en qué idioma de runtime se debe leer el registro de la lista.
● Idioma de runtime
Abreviatura de idioma conforme a la referencia VBScript, p. ej. "de-DE" para alemán
(Alemania) o "en-ES" para inglés (EE UU). La selección depende de los idiomas runtime
activados.
● Variable
Variable que contiene el idioma. El idioma de runtime se introduce en forma de valor
decimal del indicador de país, p. ej. 1031 para alemán estándar, 1033 para inglés de
EE UU. Encontrará más información al respecto en los conceptos básicos de VBScript bajo
el tema "Cuadro de ID de configuración regional (LCID)".
● Número entero
El número que corresponde al orden de los idiomas de runtime en el cambio de idioma.
La selección depende de los idiomas de runtime activados, p. ej., "0" para el idioma que
aparece al iniciar runtime por primera vez. Encontrará más información al respecto en el
apartado "Idiomas en runtime".
Lista de textos
Establece la lista de textos. El registro se lee de la lista de textos.
1.2.13 ResetBit (RT Professional)
Descripción


ResetBit Tag
Parámetros
Variable

VB Scripting
Ejemplo
Dim myTag
Dim myOutputField

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

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

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

...
}
1.2.14 ResetBitInTag (RT Professional)
Descripción

VB Scripting
Nota


Parámetros
Variable
Bit

VB Scripting
Ejemplo
Dim myTag
Dim myOutputField

'Save current value

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

{
BYTE bStatusWord;
BYTE bSaved = bStatusWord;

ResetBitInTag (bStatusWord, bitposition);

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


VB Scripting

SetBit Tag
Parámetros
Variable
Ejemplo
Dim myTag
Dim myOutputField

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

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


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

...
}
1.2.16 SetBitInTag (RT Professional)
Descripción
Nota


Parámetros
Variable

VB Scripting
Bit
Nota
Ejemplo
Dim myTag
Dim myOutputField

'Save current value

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

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


VB Scripting
{
BYTE bStatusWord;
BYTE bSaved = bStatusWord;

SetBitInTag (bStatusWord, bitposition);

printf ("Current value: %d\r\n, Saved value: %d\r\n",bStatusWord, bSaved);
...
}
1.2.17 SetLanguage
Descripción
Cambia el idioma del panel de operador. Todos los textos y avisos del sistema configurados
aparecerán en el panel de operador en el idioma recién ajustado.

EstablecerIdioma (Idioma)

SetLanguage Language
Parámetros
Idioma
Determina qué idioma se debe ajustar en el panel de operador. Se pueden realizar los
siguientes ajustes:
● -1 (hmiToggle) = Conmutar: Cambia al siguiente idioma. El orden se establece en el editor
"Idiomas del proyecto" durante el proceso de configuración.
● Número que se ha especificado en "Idioma y fuente" en el editor "Configuración de
runtime". Cambia al idioma con el número indicado.

VB Scripting
● Idioma que se ha especificado en "Idioma y fuente" en el editor "Configuración de runtime".

● Abreviatura del idioma conforme a la referencia VBScript5: Cambia al idioma
correspondiente a la abreviatura indicada, p. ej. "de-DE" para alemán (Alemania) o "en-
US" para inglés (EE.UU.).
En el tema "Cuadro de Id. de configuración regional (LCID)" que forma parte de los
principios básicos de VBScript encontrará una lista de todas las abreviaturas de idioma.
1.2.18 SetPropertyByConstant (RT Professional)
Descripción
Define el valor de una propiedad de objeto como cadena de caracteres.

DefinirPropiedadVíaConstante (nombre de imagen, objeto de imagen, nombre de la
propiedad, valor)

SetPropertyByConstant Screen_name, Screen_object, Property_name, Value
Si desea modificar la propiedad de una imagen, el parámetro "Objeto" debe estar vacío. Utilice
para ello, p. ej., la sintaxis siguiente:
SetPropertyByConstant ("<nombre de imagen>","","<nombre de propiedad>","<valor>")
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto de imagen
Nombre del objeto cuya propiedad se modifica.
Nombre de la propiedad
Nombre de la propiedad que se modifica.
Valor
Valor que se asigna a la propiedad.

VB Scripting
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByConstant: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick"
del objeto incluido "Control_1" al valor 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

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

...
}
Ejemplo: modificar una propiedad de imagen

El siguiente código de programa modifica una propiedad de una imagen con la función
SetPropertyByConstant: en la imagen "Trends" se ajusta la propiedad "Backcolor" al valor 255.

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

...

VB Scripting
{
SetPropertyByConstant ("Trends", "Trends", "Backcolor", "255");

...
}
Como alternativa, puede utilizar en lugar del segundo parámetro (Objeto) la contraseña NULL
o bien un string de espacios en blanco.
1.2.19 SetPropertyByProperty (RT Professional)
Descripción
Define el valor de una propiedad de objeto por medio de otra propiedad de objeto.

DefinirPropiedadVíaPropiedad (Nombre de imagen, Objeto, Nombre de la propiedad, Destino-
Nombre de imagen, Destino-Objeto de imagen, Destino Nombre de propiedad)

SetPropertyByProperty Screen_name, Screen_object, Property_name,
Source_screen_name, Source_screen_object, Source_property_name
Si desea definir una propiedad de una imagen mediante otra propiedad de imagen, los
parámetros "Objeto" y "Objeto de destino" deben estar vacíos. Utilice para ello, p. ej., la sintaxis
siguiente:
SetPropertyByProperty ("<nombre de imagen>","","<nombre de propiedad>","<nombre de
imagen de destino>","","<nombre de propiedad de destino>")
Parámetros
Nombre de imagen
Objeto
Nombre del objeto del que se transfiere una propiedad al objeto de destino.

VB Scripting
Nombre de la propiedad cuyo valor se transfiere al objeto de destino.
Nombre de imagen de destino

Nombre de la imagen en el que está contenido el objeto de destino.
Destino-Objeto de imagen
Nombre del objeto de destino del que se modifica una propiedad.
Nombre de la propiedad de destino

Ejemplo
El siguiente código de programa transfiere con la función SetPropertyByProperty la propiedad
"ToolbarButtonClick" del objeto "Control_1" en la imagen de salida "Trend_1" a la propiedad
correspondiente de la imagen de destino"Trend_2".

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

"Control_2", "ToolbarButtonClick"
'User defined code

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

"Control_2", "ToolbarButtonClick");

...
}

VB Scripting
1.2.20 SetPropertyByTag (RT Professional)
Descripción
Define el valor de una propiedad de objeto por medio de un valor de variable.

DefinirPropiedadVíaVariable (nombre de imagen, objeto de imagen, nombre de la propiedad,
nombre de la variable)

SetPropertyByTag Screen_name, Screen_object, Property_name, Tag_name
Si desea definir la propiedad de una imagen mediante un valor de variable, el parámetro
"Objeto" debe estar vacío. Utilice para ello, p. ej., la sintaxis siguiente:
SetPropertyByTag ("<nombre de imagen>","","<nombre de propiedad>","<nombre de
variable>")
Parámetros
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad se activa por medio del valor de variable.
Nombre de la propiedad que se activa por medio del valor de variable.
Nombre de variable
Nombre de la variable que contiene el valor de la propiedad.

VB Scripting
Ejemplo
SetPropertyByTag: Al hacer clic sobre el objeto se transfieren el nombre del objeto y la imagen
en la que se encuentra el objeto. El título CaptionText de la ventana de imagen contiene el
valor de la variable HMI_value_1.

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

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

...
}
Ejemplo
SetPropertyByTag: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick" del
objeto incluido "Control_1" al valor 26.

'User defined code

...
{

...
}

VB Scripting
1.2.21 SetPropertyByTagIndirect (RT Professional)
Descripción
Escribe el nombre de una variable direccionada indirectamente en una propiedad de objeto.
La variable transferida como parámetro contiene el nombre de una segunda variable, cuyo
valor se lee.

DefinirPropiedadVíaVariableIndirectamente (nombre de imagen, objeto de imagen, nombre
de la propiedad, nombre de la variable)

SetPropertyByTagIndirect Screen_name, Screen_object, Property_name, Tag_name
Si desea definir la propiedad de una imagen indirectamente mediante una variable, el
parámetro "Objeto" debe estar vacío. Utilice para ello, p. ej., la sintaxis siguiente:
SetPropertyByTagIndirect ("<nombre de imagen>","","<nombre de propiedad>","<nombre de
variable>")
Parámetros
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad se debe modificar.
Nombre de la propiedad que se debe modificar.
Nombre de variable
Nombre de la variable que, a su vez, contiene el nombre de la variable cuyo valor se lee.

VB Scripting
Ejemplo
SetPropertyByTagIndirect:

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

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

...
}
1.2.22 SetTag (RT Professional)
Descripción
Nota


SetTag Tag, Value

VB Scripting
Parámetros
Variable
Valor
Nota
Ejemplo
{
BOOL ok;
BOOL bvalue;

//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}
1.2.23 SetTagByProperty (RT Professional)
Descripción
Define un valor de variable por medio del valor de una propiedad de objeto. La modificación
se registra adicionalmente en el sistema de avisos.

VB Scripting

DefinirVariableVíaPropiedad (nombre de variable, nombre de imagen, objeto de imagen,
nombre de la propiedad, con o sin aviso de operador)

SetTagByProperty Tag_name, Screen_name, Screen_object, Property_name,
With_or_without_operator_event
Parámetros
Nombre de variable
Nombre de la variable cuyo valor se define por medio de la propiedad de objeto.
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad proporciona el valor de variable.
Nombre de la propiedad que proporciona el valor de variable.
Con o sin aviso de operador

0 (hmiWithoutOperatorEvent) = Sin aviso de operador
1 (hmiWithOperatorEvent) = Con aviso de operador
Ejemplo
El siguiente código de programa devuelve el valor del texto seleccionado al hacer clic en un
cuadro combinado.
{
char* rt_value;
SetTagByProperty (rt_value, screenName, objectName, "SelectedText",

hmiWithoutOperatorEvent);
...
}

VB Scripting
1.2.24 SetTagByTagIndirect (RT Professional)
Descripción
Escribe el valor de una variable direccionada indirectamente en una variable. La variable
transferida como parámetro contiene el nombre de una segunda variable, cuyo valor se lee.
Mediante un aviso de operador se puede documentar la modificación en el sistema de avisos.

DefinirVariableVíaVariableIndirecta (nombre de variable, nombre de variable, con o sin aviso
de operador)

SetTagByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parámetros
Nombre de la variable
Nombre de la variable cuyo valor debe modificarse.
Nombre de variable
Nombre de una variable de string que contiene el nombre de una variable que devuelve el
valor de la variable.

Ejemplo
El siguiente código de programa escribe el valor de la variable Tag4 en la variable Tag1.
{
SetTag ("IndirectRead", "Tag4");
SetTagByTagIndirect ("Tag1", "IndirectRead", hmiWithoutOperatorEvent);
...
}

VB Scripting
1.2.25 SetTagIndirect (RT Professional)
Descripción
Escribe un valor en una variable direccionada indirectamente. La variable transferida como
parámetro de salida contiene el nombre de una segunda variable, cuyo valor es modificado
por la función. Mediante un aviso de operador se puede documentar la modificación en el
sistema de avisos.

DefinirVariableIndirectamente (variable, valor, con o sin aviso de operador)

SetTagIndirect Tag_name, Value, With_or_without_operator_event
Parámetros
Nombre de variable
Nombre de una variable de string que contiene el nombre de una variable cuyo valor debe
modificarse.
Valor
Valor que se debe escribir.

Ejemplo
El siguiente código de programa escribe el valor "value" en la variable Tag3.
{
int value;
SetTag ("IndirectWrite", "Tag3");

SetTagIndirect ("IndirectWrite", "value", hmiWithoutOperatorEvent);
...
}

VB Scripting
1.2.26 SetTagIndirectByProperty (RT Professional)
Descripción
Escribe el valor de una propiedad de objeto en una variable direccionada indirectamente. La
variable transferida como parámetro de salida contiene el nombre de una segunda variable,
cuyo valor es modificado por la función. Mediante un aviso de operador se puede documentar
la modificación en el sistema de avisos.

DefinirVariableIndirectamenteVíaPropiedad (Nombre de variable, Nombre de imagen, Objeto
de imagen, Nombre de la propiedad, Con o sin aviso de operador)

SetTagIndirectByProperty Tag_name, Screen_name, Screen_object, Property_name,
Parámetros
Nombre de variable
modificarse.
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad devuelve el valor.
Nombre de la propiedad que devuelve el valor.


VB Scripting
Ejemplo
El siguiente código de programa escribe el valor de la propiedad de objeto "Color de fondo"
en la variable Tag2.
{
SetTagIndirectByProperty ("IndirectWrite", screenName, objectName, "BackColor",
...
}
1.2.27 SetTagIndirectByTagIndirect (RT Professional)
Descripción
Escribe el valor de una variable direccionada indirectamente en una variable direccionada
indirectamente. La variable transferida como parámetro de salida contiene el nombre de una
segunda variable, cuyo valor es modificado por la función. La variable transferida como
parámetro contiene el nombre de una segunda variable, cuyo valor se lee. Mediante un aviso
de operador se puede documentar la modificación en el sistema de avisos.

DefinirVariableIndirectaVíaVariableIndirecta (Nombre de variable, Nombre de variable, Con
o sin aviso de operador)

SetTagIndirectByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parámetros
Nombre de variable
modificarse.
Nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.


VB Scripting
Ejemplo
El siguiente código de programa escribe el valor de la variable "Tag4" en la variable "Tag2".
{
SetTagIndirectByTagIndirect ("IndirectWrite", "IndirectRead");
...
}
1.2.28 SetTagWithOperatorEvent (RT Professional)
Descripción
Define el valor de una variable. La modificación se registra adicionalmente en el sistema de
avisos.

DefinirVariableConAvisoDeOperador (nombre de la variable, valor)

SetTagWithOperatorEvent Tag_name, Value
Parámetros
Nombre de la variable cuyo valor se define.
Valor
El valor que se escribe la variable.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.

SetTagWithOperatorEvent result, value
...

VB Scripting
{
SetTagWithOperatorEvent ("result", "value");
...
}
1.2.29 ShowBlockInTIAPortalFromAlarm (RT Professional)
Descripción
Realiza un cambio del visor de avisos al código de programa relevante del proyecto
seleccionado en el Engineering System. El cambio del visor de avisos al proyecto en el TIA
Portal permite seguir analizando el código de programa, p. ej., para buscar un contacto que
falta en el interlock.
Esta función del sistema se configura en un objeto de imagen, p. ej., un botón, o en un botón
de la barra de herramientas de un visor de avisos. Al hacer clic en el botón, el sistema tendrá
en cuenta el contexto necesario y, tras saltar al Engineering System, se mostrará
automáticamente el punto en cuestión del código de programa. Con el parámetro Protección
contra escritura se establece el nivel de permiso con el que se podrá activar el cambio al
Engineering System.
Si se ha configurado la función del sistema en un botón, el TIA Portal se iniciará en el modo
establecido mediante el parámetro Protección contra escritura. Para poder usar distintos
niveles de seguridad para el acceso, configure los botones con dos permisos distintos:
● Para el primer botón, configure el permiso de acceso sin restricciones ajustando el
parámetro Protección contra escritura a FALSE.
● para el segundo botón, configure el permiso de acceso sin derecho a modificar datos
ajustando el parámetro Protección contra escritura a TRUE.

MostrarBloqueEnTIAPortalDelAviso (protección contra escritura, modo offline, ruta del
proyecto en TIA Portal, nombre de imagen del visor de avisos, nombre del visor de avisos)

ShowBlockInTIAPortalFromAlarm ReadOnly, Offline_mode, TiaPortalProject_path,
AlarmScreen_name, AlarmView_name, Error_tag
Encontrará más información en "Funciones del sistema para Runtime Professional".

VB Scripting
Parámetros
Protección contra escritura

Determina si el proyecto se abrirá en modo de solo lectura.
TRUE (estándar): TIA Portal se abre en modo de lectura, y el usuario no puede realizar
cambios.
FALSE: TIA Portal se abre con permiso de lectura y escritura.
Modo offline
Determina si el proyecto se abrirá en modo offline.
TRUE: después de abrirse el bloque, el TIA Portal no pasa al modo online.
FALSE (estándar): después de abrirse el bloque se inicia el modo online.
Ruta de proyecto en TIA Portal

Ruta y nombre de archivo del proyecto en TIA Portal al que se cambiará desde el visor de
avisos.
Nombre de imagen del visor de avisos

Nombre de la imagen que contiene el visor de avisos.
Nombre del visor de avisos

Nombre de objeto del visor de avisos desde el que se cambiará a TIA Portal.
Variable de error
En caso de fallo se muestra información sobre el error que se ha producido mediante la
variable de error.
1.2.30 ShowLogonDialog (RT Professional)
Descripción
Abre un cuadro de diálogo en el panel de operador con el que el usuario puede iniciar una
sesión en el panel de operador.

MostrarDiálogoInicioSesión
Utilización en scripts de usuario

ShowLogonDialog
Utilizable, siempre que el dispositivo configurado soporte scripts de usuario. Encontrará más
información en "AUTOHOTSPOT".

VB Scripting
Parámetros
--
1.2.31 ShowPLCCodeViewFromAlarm (RT Professional)
Descripción
Cambia del visor de avisos con el aviso ProDiag o GRAPH seleccionado al visor de código
PLC con el segmento en cuestión. La imagen que contiene visor de código PLC se abre en
una imagen raíz o en una ventana de imagen.

MostrarVisorAvisosCódigoPLC (nombre de imagen del aviso, nombre del visor de avisos,
nombre de la imagen raíz, nombre de la ventana de imagen, nombre de imagen del visor de
código PLC, nombre del visor de código PLC, variable de error)

ShowPLCCodeViewFromAlarm Screen_name, Alarmview_name, Screen_name,
Screen_window_name, Screen_name, PLCCodeView_name, Error_tag
Encontrará más información en "Funciones del sistema para Runtime Professional".
Parámetros
Nombre de imagen del aviso

Nombre de la imagen que contiene el visor de avisos.
Nombre del visor de avisos

Nombre de objeto del visor de avisos desde el que se transmitirá el aviso seleccionado.
Nombre de la imagen raíz

Nombre de la imagen que contiene una ventana de imagen en la que puede representarse la
imagen.
Nombre de la ventana de imagen

Nombre de la ventana en la que puede representarse la imagen con el visor de código PLC.
Nombre de imagen del visor de código PLC

Nombre de la imagen que contiene el visor de código PLC.
Nombre del visor de código PLC

Nombre de objeto del visor de código PLC.

VB Scripting
Variable de error
En caso de fallo se muestra información sobre el error que se ha producido mediante la
variable de error.
Mensajes de error
La variable de error devuelve los siguientes errores:
KOPAPI_E_TPSF_ALGCTRL_NOTSELECTED Debe estar seleccionado un solo aviso

KOPAPI_E_TPSF_ONLYONLINELISTALLOWED Seleccionar solo avisos de la lista de avisos
del visor de avisos
KOPAPI_E_TPSF_ONALARMWRONGPRODUCERID No se ha seleccionado ningún aviso de
GRAPH/ProDiag.
KOPAPI_E_TPSF_ONALARMNOSD0JUMPFLAG No es posible saltar desde este aviso de
GRAPH/ProDiag.
Es posible saltar desde un aviso del visor
de avisos al visor de código PLC con los
siguientes avisos de supervisión:
● En supervisiones globales, solo con
supervisiones de enclavamiento
(Interlock)
● En supervisiones locales, con todas las
supervisiones básicas de parámetros
de entrada
1.2.32 StopRuntime (RT Professional)
Descripción
operador.

PararRuntime (Modo)

StopRuntime Mode

VB Scripting
1.3 VBScript para Windows (Panels, Comfort Panels, RT Advanced, RT Professional)
Parámetros
Modo
Ejemplo

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

Professional)
1.3.1 VBScript para Windows (Panels, Comfort Panels, RT Advanced, RT Professional)
VBScript
Si ya conoce Visual Basic o Visual Basic para aplicaciones, VBScript le resultará familiar. Y
si no conoce Visual Basic y empieza a trabajar con él, aprenderá al mismo tiempo el
funcionamiento de todos los lenguajes de programación Visual Basic. Encontrará una buena
introducción a la programación en los libros Step by Step de Microsoft Press.
En la página web de Microsoft encontrará también información básica relacionada con los
detalles de VBScript para los elementos del lenguaje.
http://msdn.microsoft.com/en-us/library/t0aew7h6.aspx
ID de configuración regional (LCID)

Encontrará un resumen de las abreviaturas de todos los idiomas en la página web de Microsoft:
http://msdn.microsoft.com/en-us/goglobal/bb964664

VB Scripting
1.4 VBScript para Windows CE (Panels, Comfort Panels)
1.4.1 VBScript para Windows CE (Panels, Comfort Panels)
VBScript para Windows CE

A excepción de los elementos de control para acceder a archivos, en paneles con Windows
CE puede utilizar el alcance funcional completo de VBScript.
En un panel con Windows CE, los elementos de control "File" y "FileSystem" y la función
CreateObject permiten acceder a archivos y al sistema de archivos.
En la página web de Microsoft encontrará también información básica relacionada con los
detalles de VBScript para los elementos del lenguaje.
http://msdn.microsoft.com/en-us/library/t0aew7h6.aspx
ID de configuración regional (LCID)

Encontrará un resumen de las abreviaturas de todos los idiomas en la página web de Microsoft:
http://msdn.microsoft.com/en-us/goglobal/bb964664
1.4.2 CreateObject (Panels, Comfort Panels)
Función
Esta función genera una referencia a un objeto de automatización.
Sintaxis
CreateObject (objeto)
Parámetros
Objeto
Un string que contiene la ProgID del objeto que debe generarse.
Valor de retorno
Emite una referencia a un objeto de automatización.

VB Scripting
Notas
Utilice la función CreateObject para generar controles ActiveX invisibles en runtime.
CreateObject no puede utilizarse para generar objetos gráficos como, por ejemplo, control
TreeView o control ListView. Los objetos generados con CreateObjekt no responden a
eventos. Si desea generar objetos que respondan a eventos, utilice la función
CreateObjectWithEvents. La siguiente tabla contiene las ProgID para controles ActiveX sin
eventos:
Control ProgID
Microsoft CE File control 6.0 .file
Microsoft CE FileSystem control 6.0 .filesystem
Microsoft CE ImageList control 6.0 CEimageList.imagelistctrl
Ejemplo
Dim f, fwModeAppend
Set f = CreateObject("FileCtl.File")
fwModeAppend=8
f.Open "\Storage Card\testfile.txt", fwModeAppend
f.Close
1.4.3 Elementos de control (Panels, Comfort Panels)
Elementos de control para accesos a archivos

En un panel con Windows CE, los elementos de control "File" y "FileSystem" permiten acceder
a archivos y al sistema de archivos. Estos elementos de control solo pueden utilizarse con el
Windows CE Toolkit for Visual Basic 6.0.
Library
FILECTLdtl
DLL
Mscefile.dll
Elemento de control File

El elemento de control File soporta las siguientes propiedades:
● Attr
● EOF
● Loc

VB Scripting
● LOF
● Seek
El elemento de control File soporta los siguientes métodos:
● Close (File)
● Get
● Input
● InputB
● InputFields
● LineInputString
● LinePrint
● Open
● Put
● WriteFields
Elemento de control FileSystem

El elemento de control FileSystem soporta los siguientes métodos:
● Dir
● FileCopy
● FileDateTime
● FileLen
● GetAttr
● Kill
● MkDir
● MoveFile
● RmDir
● SetAttr
1.4.4 Propiedades (Panels, Comfort Panels)
1.4.4.1 Attr (Panels, Comfort Panels)
Función
Esta propiedad devuelve un número que identifica el modo de archivo que se utilizó para abrir
el archivo.

VB Scripting
Sintaxis
File.Attr
Parámetros
File
Referencia a un elemento de control "File".
Valores de retorno
Los valores de la siguiente tabla muestran el modo de acceso. Si el valor de retorno es 0, el
archivo está cerrado.
Constante Valor
None 0
fsModeInput 1
fsModeOutput 2
fsModeRandom 4
fsModeAppend 8
fsModeBinary 32
Notas
"Attr" es una propiedad de solo lectura. Utilice el método Open del elemento de control "File"
para determinar el modo de archivo.
1.4.4.2 EOF (Panels, Comfort Panels)
Función
Esta propiedad emite True cuando se alcanza el final de un archivo que se abrió para una
entrada aleatoria o secuencial.
Sintaxis
File.EOF
Parámetros
File

VB Scripting
Notas
Utilice la propiedad EOF para evitar errores que se producen por leer después del final de un
archivo.
La propiedad EOF devuelve False hasta que se alcanza el final del archivo. Con archivos que
se abrieron con fsModeRandom o fsModeBinary, se devuelve False hasta que la última
instrucción Get ejecutada no devuelva un registro completo.
En archivos que se abrieron en modo fsModeBinary, se intenta leer el archivo con la función
Input hasta que EOF devuelva True y se genere un error. Si desea leer datos binarios con
Input, utilice las propiedades LOF y LOC en vez de EOF, o utilice Get junto con EOF. En
archivos que se abrieron con fsModeOutput, EOF devuelve siempre True.
1.4.4.3 Loc (Panels, Comfort Panels)
Función
Esta propiedad devuelve un número que da nombre a la posición de lectura/escritura actual.
Sintaxis
File.Loc
Parámetros
File
Notas
Con archivos que se abrieron con fsModeRandom, Loc devuelve como número la última
entrada que se leyó o escribió. Con archivos que se abrieron en los demás modos, Loc
devuelve la posición del último byte leído o escrito.
1.4.4.4 LOF (Panels, Comfort Panels)
Función
Esta propiedad emite el tamaño de un archivo en bytes como número.
Sintaxis
File.LOF

VB Scripting
Parámetros
File
Notas
Para asegurarse de que la operación de lectura no excede el final de un archivo, puede
utilizarse la propiedad LOF en combinación con la propiedad Loc.
1.4.4.5 Seek (Panels, Comfort Panels)
Función
Esta propiedad determina la siguiente posición en un archivo que debe leerse o escribirse, y
la devuelve.
Sintaxis
File.Seek [= Position]
Parámetros
File
Posición
Dirección numérica que describe la posición en un archivo.
Notas
La propiedad Seek describe la posición de archivo siguiente, mientras que la propiedad Loc
describe la posición de archivo actual. El número emitido para Seek será siempre uno más
que el de Loc. La única excepción se da cuando un archivo se abre por primera vez; en ese
caso, tanto Seek como Loc devuelven uno.
Si Seek da un valor negativo o cero, se emite un error.

VB Scripting
1.4.5 Métodos (Panels, Comfort Panels)
1.4.5.1 Close (Panels, Comfort Panels)
Función
Este método cierra un elemento de control "File" abierto.
Sintaxis
File.Close
Parámetros
File
Valores de salida
Ninguno.
Notas
Utilice el método Open para abrir un archivo.
1.4.5.2 Dir (Panels, Comfort Panels)
Función
Este método emite el nombre de un archivo o un directorio que se adapta a un patrón
determinado o contiene un atributo determinado.
Sintaxis
FileSystem.Dir (Pathname,[Attributs])
Parámetros
File
Referencia a un elemento de control "FileSystem".
Pathname
Opcionalmente: una expresión de cadena de caracteres que describe el nombre del archivo
o la ruta.

VB Scripting
Attributs
Opcionalmente: Una expresión numérica cuya suma describe los atributos del archivo.
Cuando se omite, se devuelven todos los archivos de la correspondiente ruta.
La tabla siguiente muestra los ajustes de parámetros de los atributos.
Constante Valor Descripción

fsAttrNormal 0 Normal
fsAttrReadOnly 1 Solo lectura
fsAttrHidden 2 Oculto
fsAttrSystem 4 Archivo de sistema
fsAttrVolume 8 Etiqueta de volumen. Si se ha definido, se ignoran los demás
atributos.
fsAttrDirectory 16 Directorio
fsAttrArchive 32 Fichero
Valores de salida
String. Un nombre de archivo compuesto por el nombre de ruta y los atributos. Dir devuelve
un string de longitud cero ("") cuando no se encuentra el nombre de ruta.
Notas
Dir soporta el uso de comodines de cadena de caracteres (*) y de carácter (?) para describir
archivos repetidos. La primera vez que utilice el método Dir deberá indicar el nombre de ruta.
Si indica atributos, deberá incluir además el nombre de ruta.
El método Dir devuelve el primer nombre de archivo que se adecua al nombre de ruta. Si
desea obtener otros nombres de archivo que se adecuen al nombre de ruta, ejecute Dir de
nuevo sin parámetros. Si no se encuentran más nombres de archivo adecuados, Dir devuelve
un string de longitud cero (""). Si se emite un string de longitud cero, indique el nombre de la
ruta haciendo una nueva llamada.
1.4.5.3 FileCopy (Panels, Comfort Panels)
Función
Este método copia el contenido de un archivo en otro archivo.
Sintaxis
FileSystem.FileCopy PathName, NewPathName

VB Scripting
Parámetros
FileSystem
PathName
Cadena de caracteres que contiene la ruta y el nombre del archivo.
NewPathName
Cadena de caracteres que contiene el nombre de archivo y la ruta del archivo nuevo.
Valores de salida
Ninguno.
Notas
FileCopy notifica un error si el nuevo archivo no existe.
1.4.5.4 FileDateTime (Panels, Comfort Panels)
Función
Este método emite una variante (Date) que contiene la fecha y la hora en que se creó o se
editó por última vez el archivo.
Sintaxis
FileSystem.FileDateTime(Pathname)
Parámetros
Filesystem
Pathname
Expresión de cadena de caracteres que da nombre al archivo. El nombre de ruta puede incluir
un directorio.
Valor de salida
Devuelve la fecha en que se modificó el archivo por última vez.

VB Scripting
Notas
Si no existe un archivo nuevo, FileDateTime notifica un error.
1.4.5.5 FileLen (Panels, Comfort Panels)
Función
Este método emite un valor que describe la longitud de un archivo en bytes.
Sintaxis
FileSystem.FileLen(Pathname)
Parámetros
Filesystem
Pathname
Cadena de caracteres que describe el nombre del archivo. El nombre de ruta puede incluir
un directorio.
Valores de salida
Devuelve la cantidad de bytes de un archivo.
Notas
Si ya está abierto el archivo indicado cuando se llama FileLen, el valor da el tamaño del archivo
antes de que este se abra.
1.4.5.6 Get (Panels, Comfort Panels)
Función
Este método lee datos desde un archivo abierto a una variable.
Sintaxis
File.Get Data, [Recnumber]

VB Scripting
Parámetros
File
Data
Variable de la variante en la que se leen los datos.
Recnumber
Opcionalmente: Número con el que empieza el proceso de lectura. En archivos que se
abrieron en modo binario, Recnumber define la posición del byte.
Valores de salida
Ninguno.
Notas
Los datos que se leen con el método Get suelen escribirse en el archivo con el método Put.
El primer registro o el primer byte de un archivo se encuentra en la posición 1; el segundo, en
la posición 2, etc. Si omite Recnumber, se lee el siguiente registro o el siguiente byte después
del último método Get o Put (o aquel al cual se remitió a través del método Seek).
Las siguientes reglas son válidas para archivos que se abrieron en el modo aleatorio:
● Si la longitud de los datos leídos es inferior a la longitud definida en la cláusula de longitud
del método Open, Get lee los siguientes registros en la longitud del límite del registro. El
espacio entre el final del registro y el principio del siguiente registro se llena con el contenido
del búfer del archivo. Como no puede determinarse con exactitud el alcance de los datos
rellenados, se recomienda que la longitud de los registros se corresponda con la longitud
de los datos leídos.
● Si los datos son una variante de tipo numérica, Get lee 2 bytes para determinar el VarType
de la variante y, a continuación, lee los datos que se escriben en la variable. Por ejemplo,
si una variante del tipo VarType3 lee 6 bytes con Get, 2 bytes identifican la variante como
VarType 3 (Long) y 4 bytes contienen los datos Long. La longitud del registro se define en
la cláusula de longitud. Al utilizar el método Open, esta debe ser como mínimo 2 bytes
mayor que el número de bytes necesarios para guardar la variable.
● Puede utilizarse el método Get para leer una matriz de variantes de la memoria; sin
embargo, no puede utilizarse para leer una variante escalar que contenga una matriz. Con
Get no pueden leerse objetos de la memoria.
● Si la variante que va a leerse pertenece al tipo VarType 8 (string), Get lee 2 bytes e identifica
la variante como VarType 8, otros 2 bytes definen la longitud del string y, por último, se
leen los datos del string. La longitud del registro del método Open que se ha definido por
la cláusula de longitud debe ser como mínimo 4 bytes mayor que la longitud del string.
● Si la variable que va a leerse es una matriz dinámica, Get lee el descriptor cuya longitud
corresponde a 2 más 8 veces el número de dimensiones (2 + 8 * NumberOfDimensions).
La longitud del registro del método Open definida por la cláusula de longitud debe ser
mayor o igual a la suma de bytes necesarios para leer los datos de la matriz y el descriptor
de la matriz.

VB Scripting
En archivos que se abrieron en modo binario, la cláusula de longitud del método Open no
tiene efecto. Get lee todas las variables juntas de la memoria sin relleno entre los
archivos.
1.4.5.7 GetAttr (Panels, Comfort Panels)
Función
Este método emite un valor que describe los atributos de un archivo o de una carpeta.
Sintaxis
FileSystem.GetAttr(Pfadname)
Parámetros
FileSystem
Pathname
Cadena de caracteres que describe el nombre del archivo o de la carpeta. El nombre de ruta
puede incluir un directorio.
Valores de salida
Una expresión numérica cuya suma describe los atributos de un archivo o de una carpeta. La
tabla siguiente muestra los valores posibles.

vbNormal 0 Normal
VbReadOnly 1 Solo lectura
VbHidden 2 Oculto
VbSystem 4 Sistema
VbDirectory 16 Directorio
VbArchive 32 El archivo se ha modificado desde la última copia de se‐
guridad
Notas
Para determinar los atributos ajustados, utilice el operando And para comparar bit a bit los
valores devueltos por GetAttr y los valores del atributo que ha seleccionado usted.

VB Scripting
1.4.5.8 Input (Panels, Comfort Panels)
Función
Este método emite un string que contiene caracteres de un archivo abierto en el modo de
entrada o el modo binario.
Sintaxis
File.Input(Number)
Parámetros
File
Number
Expresión numérica que define el número de caracteres de salida.
Valores de salida
Una cadena de caracteres que consta de caracteres leídos del archivo.
Notas
Los datos que se leen con el método Input suelen haberse escrito en el archivo con el método
LinePrint o Put. Utilice este método solo para archivos que se abrieron en el modo de entrada
o en el modo binario.
A diferencia del método LineInputString, el método Input emite todos los caracteres leídos,
por ejemplo, también comas, retornos de carro, avances de línea, comillas y espacios en
blanco iniciales.
En caso de archivos abiertos para acceso binario, se produce un error al intentar leer el archivo
con el método Input antes de que la función EOF emita "True". Para evitar este error, en vez
de EOF, utilice las funciones LOF y Loc para leer archivos binarios con el método Input, o
utilice Get junto con la función EOF.
1.4.5.9 InputB (Panels, Comfort Panels)
Función
Este método emite bytes de un archivo abierto en el modo de entrada o el binario.

VB Scripting
Sintaxis
File.InputB(Number)
Parámetros
File
Number
Cualquier expresión numérica válida que define el número de bytes devueltos.
Valores de salida
Una matriz que contiene los bytes leídos del archivo.
Notas
Los archivos que se leen con el método InputIB suelen escribirse con los métodos LinePrint
o Put. Utilice este método solo para archivos que se abrieron en el modo de entrada o en el
binario.
1.4.5.10 InputFields (Panels, Comfort Panels)
Función
El método lee datos de un archivo secuencial abierto y emite un campo de datos de variables
unidimensional.
Sintaxis
File.InputFields(Number)
Parámetros
File
Number
Número de campos delimitados por coma que deben leerse de un archivo.
Valores de salida
Una matriz que contiene los campos leídos del archivo.

VB Scripting
Notas
Los datos que se leen con el método InputFields suelen escribirse con WriteFields. Utilice
este método solo en archivos abiertos en el modo binario o de entrada. InputFields lee strings
estándar o datos numéricos sin modificaciones. La siguiente tabla muestra cómo InputFields
lee otros datos de entrada:
Datos Contenido de las variables asignadas

Delimitación por comas o fila vacía Vacío
#NULL# Cero
#TRUE# or #FALSE# Verdadero o falso
#yyyy-mm-dd hh:mm:ss# Fecha y/u hora como expresión
Las comillas dobles ("") con datos de entrada se descartan.

Si alcanza el final del archivo al agregar un objeto de archivo, los datos agregados se borran
y se devuelve un error.
Para leer datos de un archivo como variables que utilizan InputFields, utilice el método
WriteFields en vez del método LinePrint para escribir los datos en archivos. El uso de
WriteFields garantiza que cada campo de datos está limitado con exactitud.
1.4.5.11 Kill (Panels, Comfort Panels)
Función
Este método borra archivos y carpetas del disco duro.
Sintaxis
FileSystem.Kill Pathname
Parámetros
FileSystem
Pathname
Cadena de caracteres que da nombre a uno o varios archivos que deben borrarse. El nombre
de la ruta puede contener una carpeta.
Valores de salida
Ninguno.

VB Scripting
Notas
El método Kill soporta comodines de cadena de caracteres (*) y de carácter (?) para denominar
varios archivos.
Si intenta borrar un archivo abierto con el método Kill, se notifica un error.
1.4.5.12 LineInputString (Panels, Comfort Panels)
Función
Este método lee una fila concreta de un archivo secuencial abierto y la vincula con una variable
de string.
Sintaxis
File.LineInputString
Parámetros
File
Valores de salida
Ninguno.
Notas
Los datos que se leen con LineInputString normalmente se han escrito en un archivo con
LinePrint.
El método LineInputString lee un archivo carácter por carácter hasta que alcanza una
secuencia de retorno de carro (Chr(13)) o retorno de carro/salto de línea (Chr(13) + Chr(10)).
Las secuencias de retorno de carro y salto de línea se omiten en lugar de adjuntarse a la
cadena de caracteres.
1.4.5.13 LinePrint (Panels, Comfort Panels)
Función
Este método escribe una línea concreta en un archivo secuencial abierto.
Sintaxis
File.LinePrint Output

VB Scripting
Parámetros
File
Output
Una cadena de caracteres que se escribe en el archivo.
Valores de salida
Ninguno
Notas
Los datos que se escriben en un archivo con LinePrint normalmente se leen con
LineInputString.
Se adjunta una secuencia de retorno de carro (Chr(13) + Chr(10)) al final del string.
1.4.5.14 MkDir (Panels, Comfort Panels)
Función
Este método crea una carpeta nueva.
Sintaxis
FileSystem.MkDir Pathname
Parámetros
FileSystem
Pathname
Una cadena de caracteres que contiene el nombre de la carpeta.
Valores de salida
Ninguno.
Notas
Si el directorio ya existe, MkDir notifica un error.

VB Scripting
1.4.5.15 MoveFile (Panels, Comfort Panels)
Función
El método cambia el nombre de un archivo existente o de un directorio y todos los
subdirectorios.
Sintaxis
FileSystem.MoveFile PathName, NewPathName
Parámetros
FileSystem
PathName
Una cadena de caracteres que contiene el nombre del archivo.
NewPathName
Una cadena de caracteres que contiene el nombre del archivo que se va a copiar.
Valores de salida
Ninguno.
1.4.5.16 Open (Panels, Comfort Panels)
Función
Este método abre un archivo. Pueden usarse los siguientes modos de archivo: entrada (1),
salida (2), aleatorio (4), añadir (8) o binario (32).
Sintaxis
File.Open Pathname, Mode, [Access], [Lock], [Reclength]
Parámetros
File

VB Scripting
Pathname
Mode
Determina el modo de archivo: entrada (1), salida (2), aleatorio (4), añadir (8) o binario (32).
Access
Opcionalmente: No permitido en archivo abierto: Read, Write o ReadWrite [Default]. (1, 2, 3)
Lock
Opcionalmente: Las acciones en el archivo abierto están bloqueadas por otros procesos:
Shared, LockRead, LockWrite [Default] y LockReadWrite. (1, 2, 3, 0).
Reclength
Opcionalmente: Un número en bytes que es inferior a 32.767. En archivos que se abrieron
con acceso aleatorio, este valor corresponde a la longitud del registro. En archivos
secuenciales, este valor es el número de caracteres en búfer.
Valores de salida
Ninguno.
Nota
En modo binario se ignora el parámetro Reclength. Si se abrió un archivo en modo aleatorio,
deberá definir un tamaño de archivo que sea mayor que cero; de lo contrario, se devuelve un
error.
1.4.5.17 Put (Panels, Comfort Panels)
Función
Este método escribe datos de una variable en un archivo.
Sintaxis
File.Put Data, [Recnumber]
Parámetros
Data
Una variable Variant que contiene datos que deben escribirse en el archivo.
Recnumber
Opcional. Variante (Long). Número del registor (archivos en modo aleatorio) o número de byte
(archivos en modo binario) a partir del cual comienza el proceso de escritura.

VB Scripting
Valores de salida
Ninguno.
Notas
Los datos que se escriben con Put suelen leerse de un archivo con Get.
El primer registro o el primer byte de un archivo se encuentra en la posición 1; el segundo, en
la posición 2, etc. Si omite Recnumber, se leerá el siguiente registro o el siguiente byte después
del último método Get o Put (o al cual se remitió a través del método Seek).
Las siguientes reglas son válidas para archivos que se abrieron en el modo aleatorio:
● Si la longitud de los datos que van a escribirse es inferior a la longitud definida en la cláusula
de longitud del método Mopen, Put escribe los siguientes registros en la longitud del límite
del registro. El espacio entre el final del juego de datos y el principio del siguiente registro
se llena con el contenido del búfer del archivo. Como no puede determinarse con exactitud
la longitud de los datos rellenados, se recomienda que la longitud de los registros se
corresponda con la longitud de los datos que van a escribirse. Si la longitud de los datos
que van a escribirse es mayor que la longitud definida en la cláusula de longitud del método
Open, se notifica un error.
● Si la variable que va a escribirse es una variante de tipo numérico, Put escribe primero 2
bytes para la declaración como VarType de la variante y luego se escribe la variable. Por
ejemplo, si se escribe una variante del tipo VarType 3, Put escribe 6 bytes: 2 bytes
identifican a la variante como VarType 3 (Long) y 4 bytes contienen los datos Long. La
longitud del registro definida en la cláusula de longitud del método Open debe ser como
mínimo 2 bytes mayor que el número de bytes necesarios para guardar la variable.
● Puede utilizarse el método Pet para escribir una matriz de variante en la memoria; sin
embargo, no puede utilizarse para escribir una variante escalar que contenga una matriz.
Con Put no pueden escribirse objetos en el disco duro.
● Si la variante que va a escribirse pertenece al tipo VarType 8 (String), Put escribe 2 bytes
e identifica la variante como VarType 8, otros 2 bytes definen la longitud del string y, por
último, se escriben los datos del string. La longitud del registro del método Open que se
ha definido por la cláusula de longitud debe ser como mínimo 4 bytes mayor que la longitud
del string.
● Si la variable que va a escribirse es una matriz dinámica, Put escribe el descriptor cuya
longitud corresponde a 2 más 8 veces el número de dimensiones (2 + 8 *
NumberOfDimensions). La longitud del registro del método Open definida por la cláusula
de longitud debe ser mayor o igual a la suma de bytes necesarios para escribir los datos
de la matriz y del descriptor de la matriz.
En archivos que se abrieron en modo binario, la cláusula de longitud del método Open no
tiene efecto. Put escribe todas las variables juntas en la memoria sin relleno entre los archivos.
1.4.5.18 RmDir (Panels, Comfort Panels)
Función
Este método borra un directorio vacío.

VB Scripting
Sintaxis
FileSystem.RmDir Pathname
Parámetros
FileSystem
PathName
Una cadena de caracteres que contiene el nombre de la ruta.
Valores de salida
Ninguno.
Notas
El directorio debe estar vacío para poderse borrar. Debe indicar una ruta completa.
1.4.5.19 SetAttr (Panels, Comfort Panels)
Función
Este método ajusta los datos de atributo de un archivo.
Sintaxis
FileSystem.SetAttr Pathname, Attributes
Parámetros
FileSystem
Referencia a un control FileSystem.
Pathname
Attributes
Una expresión numérica que contiene la suma de los atributos del archivo. La tabla siguiente
muestra los valores posibles.

vbNormal 0 Normal (predeterminado)
vbReadOnly 1 Solo lectura

VB Scripting

vbHidden 2 Oculto
VbSystem 4 Archivo de sistema
VbArchive 32 El archivo se ha modificado desde la última copia de se‐
guridad
Valores de salida
Ninguno.
Notas
Si intenta ajustar los atributos de un archivo abierto, se produce un error de runtime.
1.4.5.20 WriteFields (Panels, Comfort Panels)
Función
Este método escribe datos en un archivo secuencial.
Sintaxis
File.WriteFields [Data]
Parámetros
File
Data
Opcionalmente: Variante que va a escribirse en un archivo o matriz de variante de un string
numérico o una expresión de string.
Valores de salida
Ninguno.
Notas
Los datos que se escriben con WriteFields normalmente se leen del archivo con InputFiles.
Si omite datos, en el archivo se escribe una línea en blanco.
● En los datos numéricos, el punto hace de separador decimal.
● En los datos booleanos se emite #TRUE# o #FALSE#. Las palabras clave True y False no
se traducen, independientemente del país en que se encuentre.

VB Scripting
● Los datos de tiempo se escriben en el archivo en formato de fecha universal. Si faltan la

fecha o la hora o estas son igual a cero, solo se escribirá la información disponible en el
archivo.
● Si los datos están vacíos, en el archivo no se escribe nada.
● Si los datos son igual a cero, en el archivo se escribe #NULL#.
El método WriteFields añade comas entre los objetos y comillas al principio y al final de strings
que se escriben en el archivo. No deben agregarse separadores en la lista. WriteFields añade
un avance de línea en forma de retorno de carro/salto de línea (Chr(13) + Chr(10)) después
de escribir el último carácter de los datos en el archivo.

VB Scripting
1.5 Modelo de objetos VBS (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5 Modelo de objetos VBS (Panels, Comfort Panels, RT Advanced, RT

Professional)
1.5.1 Modelo de objeto VBS (RT Professional)
El modelo de objeto VBS en WinCC

La figura siguiente muestra el modelo de objeto VBS en WinCC:

VB Scripting
$FWLYH3URMHFW
$FWLYH6FUHHQ
'DWD6HW
'DWD,WHP
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
$ODUPV 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
6FUHHQV
6FUHHQ $FWLYH6FUHHQ,WHP
'DWD6HW
'DWD,WHP
/D\HUV
/D\HU
6FUHHQ,WHPV
6FUHHQ,WHP
7DJV 7DJ6HW
7DJ 7DJ
Por medio del modelo de objeto WinCC del sistema runtime gráfico se accede a objetos y
variables en runtime.

VB Scripting
Objetos
A través de los objetos y listados Ud. recibe acceso a todos los objetos del sistema gráfico
Runtime:
● Objetos de indicación y control
● Imágenes
● Niveles
● Variables
Propiedades
Por medio de las propiedades de los objetos individuales se modifican selectivamente objetos
de indicación y control y variables en runtime. Por ejemplo, se habilita un botón con un clic o
se desencadena un cambio de color al cambiar el valor de una variable.
Métodos
Con los métodos que se aplican en los objetos individuales, p. ej., es posible leer valores de
variables para su procesamiento ulterior o visualizar avisos en runtime.
1.5.2 Objetos (Panels, Comfort Panels, RT Advanced)
1.5.2.1 HMIRuntime (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV 6PDUW7DJV
6FUHHQ 6PDUW7DJ

VB Scripting
Representa el sistema runtime gráfico.

El objeto "HMIRuntime" contiene propiedades y métodos que retornan objetos del nivel
principal; así, p. ej., la propiedad ActiveScreen retorna un objeto Screen.
Utilización
El objeto "HMIRuntime" se utiliza del siguiente modo, p. ej.:
● leer o definir el idioma actual de runtime (propiedad "Language")
● Leer el nombre de la imagen raíz actual o provocar un cambio de imagen básica definiendo
un nuevo nombre de imagen (propiedad "BaseScreenName")
● Acceder a variables (lista "SmartTags")
● Finalizar runtime (método "Stop")
● Visualizar informaciones sobre el seguimiento del proceso (método "Trace")
● Direccionar las imágenes visualizadas en runtime (lista "Screens")
Consulte también
ActiveScreen (Página 504)
1.5.2.2 Screens (lista) (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Esta lista contiene los objetos "Screen".

VB Scripting
La lista contiene dos elementos, a saber:

● El 1er. elemento (índice 0) representa el área permanente.
● El 2.º elemento (índice 1) representa la imagen raíz.
Estos dos elementos se pueden direccionar también con sus nombres, concretamente del
siguiente modo:
● Área permanente: "Permanent area"
● Imagen raíz: nombre de la imagen visualizada en la imagen raíz
Si no se representa la imagen indicada, se presentará un error durante el acceso.
El área permanente "Permanent area" se visualiza en la lista de objetos y con la función de
autocompletar.
Nota
La ventana de avisos y el indicador de avisos no están contenidos en la lista "Screens", aunque
estén marcados en runtime.
Utilización
Utilice la propiedad "Screens" para retornar la lista "Screens". En el ejemplo siguiente, el color
de fondo se cambia de negro a verde:
Utilice el nombre del objeto en calidad de índice.
'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen
Nota
Al cambiar de imagen, dejan de ser válidas todas las referencias abiertas a la imagen que ya
no existe. Por tanto, no podrá seguir utilizando dichas referencias.

VB Scripting
1.5.2.3 Screen (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Representa el sinóptico visualizado actualmente en el panel de operador, o bien el área

permanente en runtime. El objeto "Screen" se retorna como resultado del acceso a la lista
"Screens".
Además, el objeto "Screen" incorpora una lista de todos los objetos gráficos contenidos en la
imagen direccionada a los que se puede acceder mediante la lista "ScreenItems".
Utilización
El objeto "Screen" permite:
● Leer el ancho y la altura de una imagen (propiedades "Width" y "Height").
● Modificar el color de fondo (propiedad "BackColor").
En el ejemplo siguiente, el color de fondo se cambia de negro a verde:
Consulte también
ScreenItem (Página 194)

VB Scripting
1.5.2.4 ScreenItem (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa un objeto en la imagen indicada. El objeto "ScreenItem" forma parte de la lista

"ScreenItems".
Utilización
En función de determinados eventos, el objeto "ScreenItem" sirve para acceder a las
propiedades de los objetos gráficos contenidos en una imagen.
El objeto "ScreenItem" se utiliza del siguiente modo, p. ej.:
● Propiedad "Visible"
Activar o desactivar la visibilidad de un objeto
● Propiedades "Height" y "Width"
Averiguar el ancho y la altura de un objeto
● Propiedades "Top" y "Left"
Modificar la posición de un objeto
● Propiedad "ObjectName"
Leer el nombre de un objeto gráfico
● Propiedad "Parent"
Crear una referencia con la imagen de orden superior
Utilice la propiedad "ScreenItems" para retornar un objeto de la imagen. Utilice el nombre del
objeto en calidad de índice.

VB Scripting
Ejemplo
En el ejemplo siguiente, el color de fondo del círculo "myCircle" de la imagen "RootScreen"
se ajusta a "verde".
'VBS_Example_ScreenItems
Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen
Nota
Para ahorrar espacio de memoria en el panel de operador, al cargar el proyecto no se
transfieren nombres de objetos. No obstante, si desea transferir también los nombres, abra
en WinCC la configuración de runtime para el panel de operador en cuestión. En "General"
podrá modificar los ajustes deseados. Los nombres de los objetos se necesitan si desea
acceder a ellos a través de su nombre, o bien para depurar un proyecto.
Dependiendo de su apariencia, el objeto "ScreenItem" tiene distintas propiedades. Todo objeto

"ScreenItem" tiene las propiedades siguientes:
● Enabled
● Height
● Left
● ObjectName
● Parent
● Top
● Type
● Visible
● Width
Si desea direccionar un tipo de objeto en particular, a las propiedades estándar se añadirán
otras propiedades adicionales. Para más información acerca de las propiedades adicionales,
consulte la descripción del tipo de objeto en cuestión.

VB Scripting
1.5.2.5 ScreenItems (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Esta lista contiene los objetos "ScreenItem", es decir, todos los objetos de imagen que
conforman la imagen de proceso indicada. La lista tiene una propiedad "Parent". Esta
propiedad sirve para indicar la imagen de proceso en la que se encuentra el objeto de imagen.
Utilización
La lista "ScreenItems" permite
● Indicar o editar todos los objetos contenidos en la lista (es decir, todos los objetos de una
imagen)
● Contar los objetos de una imagen (propiedad "Count").
● Editar un objeto determinado de la lista (método "Item").
Utilice la propiedad "ScreenItems" para retornar un objeto de la imagen de proceso. Utilice el
nombre del objeto en calidad de índice.
Dim objCircle

VB Scripting
1.5.2.6 SmartTags (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Esta lista contiene los objetos "SmartTag" que representan todas las variables en WinCC
Runtime.
Nota
La lista "SmartTags" tiene una funcionalidad limitada. Para acceder a un objeto SmartTag sólo
se puede utilizar el nombre de la variable correspondiente. No es posible acceder a través del
índice ni utilizar la instrucción "For-Each".
Nota
Si desea acceder a una variable que todavía no está creada en el proyecto con la lista
SmartTags, no se devolverá ningún valor. No se realizará ninguna asignación a una variable
que no exista:
Dim intVar
intVar = SmartTags("FillLevel")
"intVar" permanece vacío si la variable "FillLevel" no está creada.

VB Scripting
Nota
Comportamiento actual del sistema cuando se produce un acceso dinámico a elementos de
un tipo de datos de usuario
Si se componen dinámicamente en runtime nombres de variables de un elemento de un tipo
de datos de usuario, el nombre de variable compuesto no se reconocerá si se da la siguiente
condición:
● Hay creada una variable del mismo tipo que el tipo de datos de usuario.
● La variable no se utiliza, p. ej., en un campo E/S.
Ejemplo:
Ha configurado un tipo de datos de usuario "Motor" con los elementos "RPM" (Int), "On" (Bool)
y "Off" (Bool). En el proyecto ha configurado la variable "Motor1 como instancia del tipo de
datos de usuario. Quiere mostrar los valores de los elementos en runtime en un único campo
E/S. Para la entrada del nombre del elemento, ha configurado un campo E/S adicional. El
valor introducido se guarda en la variable interna "strElementName". Con el siguiente script
se muestra el valor de un elemento en el campo E/S "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
Solución:
Configure, p. ej., en una imagen adicional, un campo E/S propio para cada elemento de tipo
de datos de usuario. Interconecte el "Valor de proceso" con el correspondiente elemento de
tipo de datos de usuario.
Nota
Dinamizar un faceplate
Para acceder a una variable interconectada a una interfaz de faceplate ("Properties"), utilice
la siguiente sintaxis:
Smarttags("Properties\int_input1_tag")

VB Scripting
Utilización
Utilice la lista "SmartTags" para retornar un objeto SmartTag. Utilice el nombre de la variable
para crear una referencia con el objeto SmartTag:
'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
En Runtime Advanced y Panels, la variable se direcciona directamente por el nombre. Si el

nombre de la variable cumple con las convenciones para nombres VBS, no es necesario que
utilice la lista "SmartTags". Tenga en cuenta el ejemplo siguiente:
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(AirPressure)
1.5.2.7 SmartTag (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Representa el valor de las variables de proceso indicadas. El objeto SmartTag forma parte
de la lista "SmartTags".

VB Scripting
Utilización
El objeto SmartTag permite leer y escribir el valor de la variable de proceso indicada. El objeto
SmartTag no retorna una referencia de objeto. Utilice la lista "SmartTags" para retornar el
valor de una variable de proceso. Utilice el nombre de la variable en calidad de índice.
Nota
Con el ajuste "SmartTags lee valores del cache", los valores no se leen directamente del
controlador, sino de la memoria imagen de proceso (cache).
El objeto SmartTag también puede leer valores directamente del controlador. Sin embargo,
en tal caso hay que contar con una carga por comunicaciones mucho mayor entre el dispositivo
HMI y el controlador.
Ejemplo
Dim strAirPressure
Nota
que no exista:
Dim intVar
Nota
Si desea retornar el tipo de datos de un objeto SmartTag con la función de VBS "TypeName",
utilice la sintaxis siguiente:
TypeName(SmartTags("FillLevel").value)
Para acceder al valor de un elemento de matriz, utilice "SmartTags("<Variable>[Índice]")".

Establezca en "Índice" el número del elemento de matriz deseado, p. ej.,
"SmartTags("AirPressure[2]")".

VB Scripting
1.5.3 Objetos (RT Professional)
1.5.3.1 Alarm (RT Professional)
Descripción
+0,5XQWLPH
Alarms 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
El objeto Alarm se utiliza para acceder al listado de objetos Alarm.
Nota
Las propiedades del objeto Alarm no se actualizan automáticamente si cambian los valores
de las mismas.

VB Scripting
1.5.3.2 Alarms (lista) (RT Professional)
Descripción
+0,5XQWLPH
Alarms 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
El objeto Alarm permite activar avisos disponibles.
Utilización
Con el listado "Alarms" Ud. puede:
● Acceder a un mensaje del listado (método Item)
● Generar un nuevo objeto de alarma (método Create)
● Leer el AlarmID del mensaje (propiedad AlarmID)
● Leer el estado de un mensaje (propiedad State)
● Leer el AlarmID del mensaje (propiedad AlarmID)
● Crear una instancia del objeto Alarm (propiedad Instance)
● Leer el nombre del ordenador en el que ha aparecido el mensaje (propiedad
ComputerName)
● Leer o fijar el nombre del usuario que ha emitido el mensaje (propiedad UserName)
● Leer o fijar los nombres de los bloques de valores de proceso (propiedad ProcessValues)
● Leer o fijar el comentario del mensaje (propiedad Comment)
● Leer o fijar el prefijo de servidor del mensaje (propiedad Context)

VB Scripting
Ejemplo
En el siguiente ejemplo se activa el aviso configurado en el editor "Avisos HMI" con el número
de aviso "1":
'VBS360
Dim MyAlarm
Set MyAlarm = HMIRuntime.Alarms(1)
MyAlarm.State = 5 'hmiAlarmStateCome + hmiAlarmStateComment
MyAlarm.Comment = "MyComment"
MyAlarm.UserName = "Hans-Peter"
MyAlarm.ProcessValues(1) = "Process Value 1"
MyAlarm.ProcessValues(4) = "Process Value 4"
MyAlarm.Create "MyApplication"
Consulte también
AlarmID (Página 513)
1.5.3.3 AlarmLogs (lista) (RT Professional)
Descripción
/RJJLQJ $ODUPORJV
'DWDORJV
Con el objeto se vuelven a asociar con runtime segmentos trasvasados del fichero de avisos
o se vuelven a borrar segmentos previamente almacenados del fichero de avisos. Los
segmentos de fichero que deben almacenarse se copian en la carpeta "Common Archiving"
del proyecto de WinCC. Los segmentos de fichero previamente almacenados se borran en la
carpeta "Common Archiving".

VB Scripting
Por medio de parámetros se controla el lugar desde el que se deben almacenar segmentos
de fichero. También se determina el período en el cual se almacenan o borran segmentos de
fichero.
Si se produce un error durante la operación con los segmentos de fichero, el método aplicado
devuelve un mensaje de error.
Utilización
● Método "Restore"
Los segmentos previamente trasvasados del fichero de avisos se asocian con runtime.
● Método "Remove"
Los segmentos previamente almacenados del fichero de avisos se borran del proyecto
runtime.
Ejemplo
En el siguiente ejemplo se guardan segmentos del fichero de avisos y el valor de retorno se
indica como Trace.
'VBS187
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
Consulte también
Restore (Página 1357)
Remove (Página 1352)

VB Scripting
1.5.3.4 DataItem (RT Professional)
Descripción
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
El objeto DataItem se usa para acceder a los contenidos de la lista DataSet. Los valores o
referencias de un objeto se guardan en el listado como DataItem.
El acceso se realiza con el nombre con el que se agregó el valor al listado. No se recomienda
el acceso individual a través del índice porque el índice varía al agregar o borrar valores. El
índice se utiliza para presentar el contenido completo de la lista. La salida se realiza en orden
alfabético.
Nota
En las referencias de objetos hay que asegurarse de que los objetos son aptos para
multithread.
Ejemplo
El ejemplo muestra cómo se visualiza como Trace el valor de 'Motor1'.
'VBS163
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine

VB Scripting
El siguiente ejemplo enumera todos los objetos DataItem del listado DataSet. El Nombre
(Name) y el valor (Value) tienen salida como Trace.
'VBS164
Dim data
For Each data In HMIRuntime.DataSet
HMIRuntime.Trace data.Name & ": " & data.Value & vbNewLine
Next
Nota
En objetos puede suceder que Value no tenga una salida directa.
Consulte también
Value (Página 1185)
Name (Página 839)
1.5.3.5 DataLogs (lista) (RT Professional)
Descripción
/RJJLQJ $ODUPORJV
'DWDORJV
Con el objeto se vuelven a asociar con runtime segmentos trasvasados del fichero de variables
o se vuelven a borrar segmentos previamente almacenados del fichero de variables. Los
segmentos de fichero que deben almacenarse se copian en la carpeta "Common Archiving"

VB Scripting
del proyecto de WinCC. Los segmentos de fichero previamente almacenados se borran en la

carpeta "Common Archiving".
fichero. Además, se establece el tipo de fichero ("Fichero de variables rápido", "Fichero de
variables lento", "Fichero de variables rápido y fichero de variables lento").
Utilización
Los segmentos previamente trasvasados del fichero de variables se asocian con runtime.
Los segmentos previamente almacenados del fichero de variables se borran del proyecto
runtime.
Ejemplo
En el siguiente ejemplo se almacenan segmentos del fichero de variables rápido y el valor de
retorno se indica como Trace.
'VBS188
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1,1) & vbNewLine
Consulte también

VB Scripting
1.5.3.6 DataSet (lista) (RT Professional)
Descripción
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
Con el objeto DataSet se intercambian datos a lo largo de varias acciones.

Un objeto DataSet es global y definido en el objeto Screen. Desde cada acción VBS es posible
acceder a los datos.
El objeto DataSet se direcciona en el objeto Screen conforme a la jerarquía de imágenes. El
objeto DataSet perdura mientras se muestra la imagen. El objeto global persiste durante todo
el tiempo de runtime.
El acceso se realiza a través del objeto DataItem.
Nota
Objetos del tipo Screen, Screens, ScreenItem, ScreenItems, Tag y TagSet no pueden ser
incluidos en la lista DataSet.
El objeto DataSet no soporta ninguna clase.
Utilización
La lista "DataSet" puede utilizarse del modo siguiente:
● Enumerar
Mostrar o editar todos los objetos dentro de la lista
● Propiedad "Count"
Mostrar el número de elementos contenidos

VB Scripting
● Método "Item"
Editar un objeto determinado de la lista
● Método "Add"
Agregar un objeto a la lista
Eliminar un objeto determinado de la lista
● Método "RemoveAll"
Eliminar todos los objetos de la lista
El acceso a los elementos de la lista se realiza del siguiente modo:
HMIRuntime.DataSet("Itemname")
En una lista específica de imágenes el acceso se realiza del siguiente modo:
HMIRuntime.Screens("Screenname").DataSet("Itemname")
En una imagen se accede al objeto DataSet de la imagen del siguiente modo:
DataSet("Itemname")
Si durante el acceso el nombre indicado no existe en el listado, se retorna VT_Empty y se

activa una Exception.
Ejemplo
El ejemplo muestra cómo comprobar con "Is Nothing" si existe el objeto "DataSet":
If HMIRuntime.DataSet("MyDataset") Is Nothing Then

HMIRuntime.Trace “Requested DataSet-object does not exsist”
Else
HMIRuntime.Trace “Requested DataSet-object exsists”
End If
El ejemplo muestra cómo incluir un valor en la lista, leer el valor, y eliminar nuevamente el
valor en diferentes acciones.
'VBS162
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.DataSet.Remove("motor1")
Consulte también
RemoveAll (Página 1356)

VB Scripting
Item (Página 1334)

Add (Página 1272)
1.5.3.7 HMIRuntime (RT Professional)
Descripción
+0,5XQWLPH
$ODUPV
$ODUP
7DJV
7DJ
6FUHHQV
6FUHHQ
'DWD6HW
'DWD,WHP
/RJJLQJ
$FWLYH3URMHFW
$FWLYH6FUHHQ
El objeto HMIRuntime representa el entorno gráfico Runtime.

VB Scripting
Utilización
El objeto "HMIRuntime" se utiliza, p. ej., del siguiente modo:
● Propiedad "Language"
Leer o definir el idioma actual de runtime.
● Propiedad "BaseScreenName"
Leer o definir la imagen raíz actual
● Propiedad "ActiveProject"
Leer la ruta del proyecto runtime activo
● Propiedad "Tags"
Acceder a variables
● Propiedad "DataSet"
Acceder a variables de una lista
● Método "Stop"
Finalizar runtime
● Método "Trace"
Visualizar avisos en una ventana de diagnóstico
Ejemplo
El siguiente comando finaliza WinCC Runtime:
'VBS3
HMIRuntime.Stop
Consulte también
Trace (Página 1378)
Stop (Página 1378)
Language (Página 772)
Tags (Página 1013)
Logging (Página 806)
DataSet (Página 656)
CurrentContext (Página 651)
MenuToolBarConfig (Página 813)
ActiveScreen (Página 504)
BaseScreenName (Página 556)
SmartTags (Página 967)

VB Scripting
1.5.3.8 Item (RT Professional)
Descripción
El objeto Item proporciona una referencia al objeto actual.
Utilización
El objeto Item se utiliza, p. ej., para acceder a las propiedades del objeto actualmente marcado
en la imagen.
Ejemplo
En el siguiente ejemplo se pone en rojo el color de fondo del objeto que está marcado en la
imagen:
'VBS195
Item.BackColor = RGB(255,0,0)
1.5.3.9 Layer (RT Professional)
Descripción
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
El objeto Layer se devuelve como resultado del acceso a la lista Layers.

VB Scripting
Objeto Parent
Imagen en la que está el nivel de la imagen
Utilización
Por medio del objeto Layer se accede a las propiedades de un nivel completo dependiendo
de determinados eventos, p. ej. para ocultar o mostrar un nivel con elementos de control
dependiendo de la autorización de uso.
El objeto "Layer" se utiliza del siguiente modo:
Mostrar u ocultar la visibilidad de un nivel
● Propiedad "Name"
Leer el nombre de un nivel
Nota
La propiedad Layer indica el nivel en la que se encuentra el objeto. El nivel "0" se indica
como nivel "0".
Durante el acceso, las capas son enumeradas en VBS del 1 hacia arriba. Por tanto, al nivel
"1" se accede con "Layers(2)".
Ejemplo
En el siguiente ejemplo se pone el nivel 1 en "invisible":
'VBS4
Layers(2).Visible = vbFalse
Consulte también
Name (Página 839)

VB Scripting
1.5.3.10 Layers (lista) (RT Professional)
Descripción
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
Con la lista Layers se accede a los 32 niveles del sistema runtime gráfico.
Objeto Parent
Imagen en la que está el nivel de la imagen
Utilización
La lista "Layers" se utiliza del siguiente modo:
● Propiedad "_NewEnum"
Editar todos los niveles dentro de la lista
Contar todos los niveles contenidos en la lista
● Método "Item"
Editar el nivel desde la lista
Las propiedades son propiedades y métodos predeterminados de un listado y no son descritos
detalladamente en la documentación de WinCC.
Consulte también
Item (Página 1334)

VB Scripting
1.5.3.11 Logging (RT Professional)
Descripción
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
Con el objeto se vuelven a asociar con runtime segmentos de fichero trasvasados o se vuelven
a borrar segmentos de fichero previamente almacenados. Los segmentos de fichero que
deben almacenarse se copian en la carpeta "Common Archiving" del proyecto de WinCC. Los
segmentos de fichero previamente almacenados se borran en la carpeta "Common Archiving".
fichero.
Utilización
Los segmentos previamente trasvasados del fichero de avisos y del fichero de variables
se asocian con runtime.
Los segmentos previamente almacenados del fichero de avisos y del fichero de variables
se borran del proyecto runtime.

VB Scripting
Ejemplo
En el siguiente ejemplo se almacenan segmentos del fichero de avisos y del fichero de
variables y el valor de retorno se indica como Trace.
'VBS189
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
Consulte también
DataLogs (lista) (Página 206)
AlarmLogs (lista) (Página 203)
1.5.3.12 Project (RT Professional)
Descripción
+0,5XQWLPH
$FWLYH3URMHFW
Con el objeto se consulta información del actual proyecto runtime.

El objeto de proyecto se retorna como resultado de ActiveProject.

VB Scripting
Utilización
Por medio del objeto "Project" se lee lo siguiente:
● la ruta del proyecto runtime actual (propiedad "Path")
● el nombre del proyecto runtime actual, sin indicación de ruta ni extensión de archivo
(propiedad "Name")
Ejemplo
El siguiente ejemplo indica como Trace el nombre y la ruta del proyecto runtime actual:
'VBS159
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
Consulte también
Name (Página 839)
Path (Página 872)
1.5.3.13 Screen (RT Professional)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Representa la imagen visualizada actualmente en el panel de operador, o bien el área

permanente en runtime. El objeto "Screen" se retorna como resultado del acceso a la lista
"Screens".

VB Scripting
El objeto "Screen" contiene además las listas siguientes:

● Todos los objetos gráficos incluidos en la imagen direccionada y que se direccionan
mediante la lista "ScreenItems".
● Todos los niveles incluidos en la imagen direccionada y que se direccionan mediante el
objeto "Layers".
Utilización
El objeto "Screen" se utiliza para las acciones siguientes, p. ej.:
● Propiedades "Width" y "Height"
Leer el ancho y la altura de una imagen
● Propiedad "BackColor"
Modificar el color de fondo
Ejemplo
En el ejemplo siguiente, el color de fondo se cambia de negro a verde:
Objeto "Parent"
Ventana de imagen en la que está incrustado el objeto "Screen".
Si el objeto "Screen" es la imagen raíz, el objeto "Parent" no está definido y está puesto a
cero.
Nota
Al cambiar de imagen, dejan de ser válidas todas las referencias abiertas a la imagen que ya
no existe. Por tanto, no podrá seguir utilizando dichas referencias.
Ejemplo
En el ejemplo siguiente se incrementa el ancho de la primera imagen de runtime en 20 píxeles:
'VBS7
Dim objScreen
Set objScreen = HMIRuntime.Screens(1)
MsgBox "Screen width before changing: " & objScreen.Width
objScreen.Width = objScreen.Width + 20
MsgBox "Screen width after changing: " & objScreen.Width

VB Scripting
Indicaciones relativas a CrossReference

Todas las imágenes que se direccionan con la fórmula estándar quedan automáticamente
registradas por la CrossReference de WinCC y aparecen en las propiedades de imagen.
HMIRuntime.BaseScreenName = "Screenname"
Si en el código se llaman imágenes con fórmulas distintas, deben darse a conocer a la

CrossReference mediante la sección siguiente:
' WINCC:SCREENNAME_SECTION_START
Const ScreenNameInAction = "ScreenName"
' WINCC:SCREENNAME_SECTION_END
Esta sección puede insertarse tantas veces como sea necesario en las acciones VBS.
Consulte también
Refresh (Página 1352)
Activate (Página 1268)
ObjectSizeDeclutteringEnable (Página 849)
ObjectSizeDeclutteringMax (Página 850)
ObjectSizeDeclutteringMin (Página 851)
LayerDeclutteringEnable (Página 781)
Layers (Página 782)
DataSet (Página 656)
ExtendedZoomingEnable (Página 694)
AccessPath (Página 503)

VB Scripting
1.5.3.14 ScreenItem (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa un objeto en la imagen indicada. El objeto "ScreenItem" forma parte de la lista

"ScreenItems".
Utilización
En función de determinados eventos, el objeto "ScreenItem" sirve para acceder a las
propiedades de los objetos gráficos contenidos en una imagen.
El objeto "ScreenItem" se utiliza del siguiente modo, p. ej.:
Activar o desactivar la visibilidad de un objeto
● Propiedades "Height" y "Width"
Averiguar el ancho y la altura de un objeto
● Propiedades "Top" y "Left"
Modificar la posición de un objeto
● Propiedad "ObjectName"
Leer el nombre de un objeto gráfico
● Propiedad "Parent"
Crear una referencia con la imagen de orden superior

VB Scripting
Ejemplo
'VBS_Example_ScreenItems
Dim objCircle
Nota
Para ahorrar espacio de memoria en el panel de operador, al cargar el proyecto no se
transfieren nombres de objetos. No obstante, si desea transferir también los nombres, abra
en WinCC la configuración de runtime para el panel de operador en cuestión. En "General"
podrá modificar los ajustes deseados. Los nombres de los objetos se necesitan si desea
acceder a ellos a través de su nombre, o bien para depurar un proyecto.
Dependiendo de su apariencia, el objeto "ScreenItem" tiene distintas propiedades. Todo objeto

"ScreenItem" tiene las propiedades siguientes:
● Enabled
● Height
● Left
● ObjectName
● Parent
● Top
● Type
● Visible
● Width
Si desea direccionar un tipo de objeto en particular, a las propiedades estándar se añadirán
otras propiedades adicionales. Para más información acerca de las propiedades adicionales,
consulte la descripción del tipo de objeto en cuestión.
Consulte también
Layer (Página 776)
ScreenItems (Página 913)
Top (Página 1099)

VB Scripting
1.5.3.15 ScreenItems (lista) (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Esta lista contiene los objetos "ScreenItem", es decir, todos los objetos de imagen que
conforman la imagen indicada. La lista tiene una propiedad "Parent". Esta propiedad "Parent"
sirve para indicar la imagen en la que se encuentra el objeto de imagen.
Utilización
La lista "ScreenItems" se utiliza del siguiente modo:
● Indicar o editar todos los objetos contenidos en la lista (es decir, todos los objetos de una
imagen)
Contar los objetos de una imagen
● Método "Item"
Editar un objeto determinado de la lista

VB Scripting
Ejemplo
Dim objCircle
Particularidades del objeto "ScreenItem"

Si se incorpora un control externo (control ActiveX u objeto OLE) en WinCC, es posible que
las propiedades del control incorporado tengan el mismo nombre que las propiedades
generales del objeto "ScreenItem". En este caso, las propiedades de "ScreenItem" tienen
preferencia.
Sin embargo, las propiedades del control incorporado también pueden direccionarse mediante
la propiedad "object". La propiedad "object" sólo existe en los controles ActiveX y objetos OLE.
Ejemplo:
'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
Ejemplo
En el ejemplo siguiente se visualizan en un cuadro los nombres de los objetos incluidos en la
imagen actual:
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

VB Scripting
Consulte también
Item (Página 1334)
ScreenItems (Página 913)
Top (Página 1099)
1.5.3.16 Screens (lista) (RT Professional)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Gracias a la técnica de ventanas de imagen, en WinCC Runtime puede haber varias imágenes
abiertas al mismo tiempo, aunque sólo exista una imagen raíz. La lista "Screens" permite
acceder a todas las imágenes abiertas en runtime por medio de su nombre. La lista "Screens"
también contiene todas las imágenes invisibles.
La clave de acceso necesaria en el entorno VBS para la instrucción
HMIRuntime.Screens(<clave de acceso>) debe cumplir la siguiente descripción de sintaxis:
[<nombre de la imagen raíz>.]<nombre de la ventana de imagen>[:<nombre de imagen>] ...

.<nombre de la ventana de imagen>[:<nombre de imagen>]
● La clave de acceso pone de manifiesto la jerarquía de imágenes.

● Es posible quitar los nombres de imagen en cualquier lugar de la clave.
● La propiedad "AccessPath" del objeto "Screen" equivale a la clave de acceso completa.
● La imagen raíz puede direccionarse mediante la clave de acceso "".

VB Scripting
Ejemplos
Las imágenes se direccionan indicando la jerarquía dentro de la lista. Es posible direccionar
las imágenes utilizando su nombre o sin utilizarlo. En los ejemplos siguientes se ha
configurado una imagen raíz "BaseScreenName" con una ventana de imagen
"ScreenWindow". La ventana de imagen contiene una imagen "ScreenName".
Direccionamiento utilizando el nombre de imagen
'VBS8
Set objScreen = HMIRuntime.Screens("BaseScreenName.ScreenWindow:ScreenName")
Direccionamiento sin utilizar el nombre de imagen
'VBS9
Set objScreen = HMIRuntime.Screens("ScreenWindow")
Referenciar la imagen raíz de distintos modos
'VBS10
Set objScreen = HMIRuntime.Screens(1)
'VBS11
Set objScreen = HMIRuntime.Screens("")
'VBS12
Set objScreen = HMIRuntime.Screens("BaseScreenName")
Consulte también
Screens (Página 914)

VB Scripting
1.5.3.17 SmartTag (RT Professional)
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Representa el valor de las variables de proceso indicadas. El objeto SmartTag forma parte
de la lista "SmartTags".
Utilización
El objeto SmartTag permite leer y escribir el valor de la variable de proceso indicada. El objeto
SmartTag no retorna una referencia de objeto. Utilice la lista "SmartTags" para retornar el
valor de una variable de proceso. Utilice el nombre de la variable en calidad de índice.
Nota
Con el ajuste "SmartTags lee valores del cache", los valores no se leen directamente del
controlador, sino de la memoria imagen de proceso (cache).
El objeto SmartTag también puede leer valores directamente del controlador. Sin embargo,
en tal caso hay que contar con una carga por comunicaciones mucho mayor entre el dispositivo
HMI y el controlador.

VB Scripting
Ejemplo
Dim strAirPressure
Nota
que no exista:
Dim intVar
Nota
Si desea retornar el tipo de datos de un objeto SmartTag con la función de VBS "TypeName",
utilice la sintaxis siguiente:
TypeName(SmartTags("FillLevel").value)
Para acceder al valor de un elemento de matriz, utilice "SmartTags("<Variable>[Índice]")".

Establezca en "Índice" el número del elemento de matriz deseado, p. ej.,
"SmartTags("AirPressure[2]")".

VB Scripting
1.5.3.18 SmartTags (RT Professional)
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Esta lista contiene los objetos "SmartTag" que representan todas las variables en WinCC
Runtime.
Nota
La lista "SmartTags" tiene una funcionalidad limitada. Para acceder a un objeto SmartTag sólo
se puede utilizar el nombre de la variable correspondiente. No es posible acceder a través del
índice ni utilizar la instrucción "For-Each".
Nota
que no exista:
Dim intVar

VB Scripting
Nota
Comportamiento actual del sistema cuando se produce un acceso dinámico a elementos de
un tipo de datos de usuario
Si se componen dinámicamente en runtime nombres de variables de un elemento de un tipo
de datos de usuario, el nombre de variable compuesto no se reconocerá si se da la siguiente
condición:
● Hay creada una variable del mismo tipo que el tipo de datos de usuario.
● La variable no se utiliza, p. ej., en un campo E/S.
Ejemplo:
Ha configurado un tipo de datos de usuario "Motor" con los elementos "RPM" (Int), "On" (Bool)
y "Off" (Bool). En el proyecto ha configurado la variable "Motor1 como instancia del tipo de
datos de usuario. Quiere mostrar los valores de los elementos en runtime en un único campo
E/S. Para la entrada del nombre del elemento, ha configurado un campo E/S adicional. El
valor introducido se guarda en la variable interna "strElementName". Con el siguiente script
se muestra el valor de un elemento en el campo E/S "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
Solución:
Configure, p. ej., en una imagen adicional, un campo E/S propio para cada elemento de tipo
de datos de usuario. Interconecte el "Valor de proceso" con el correspondiente elemento de
tipo de datos de usuario.
Nota
Dinamizar un faceplate
Para acceder a una variable interconectada a una interfaz de faceplate ("Properties"), utilice
la siguiente sintaxis:
Smarttags("Properties\int_input1_tag")

VB Scripting
Utilización
Utilice la lista "SmartTags" para retornar un objeto SmartTag. Utilice el nombre de la variable
para crear una referencia con el objeto SmartTag:
Dim strAirPressure
En Runtime Advanced y Panels, la variable se direcciona directamente por el nombre. Si el

nombre de la variable cumple con las convenciones para nombres VBS, no es necesario que
utilice la lista "SmartTags". Tenga en cuenta el ejemplo siguiente:
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(AirPressure)
Consulte también
SmartTag (Página 226)
1.5.3.19 Tag (RT Professional)
Descripción
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ

VB Scripting
Un objeto Tag (variable) será retornado por medio del listado "Tags". Por medio del objeto
Tag se puede acceder a todas las propiedades y métodos de una variable.
Al crear un objeto Tag se inicializan todas las propiedades con los siguientes valores:
● Value = VT_EMPTY
● Name = Nombre de variable
● QualityCode = BAD NON-SPECIFIC
● TimeStamp = 0
● LastError = 0
● ErrorDescription = " "
Nota
Un resumen de los QualityCodes posibles encontrará en el sistema de información de
WinCC, bajo la palabra clave "Comunicación" > "Diagnóstico" o "Comunicación" > "Quality
Codes".
Utilización
El objeto "Tag" se utiliza del siguiente modo:
● Propiedades "Name", "QualityCode", "TimeStamp", "LastError" y "ErrorDescription"
Leer información sobre la variable
● Método "Write", propiedad "Value"
Definir un valor de una variable
● Método "Read", propiedad "Value"
Leer un valor de una variable
Ejemplo
El siguiente ejemplo muestra la lectura del valor de una variable "Tag1":
'VBS13
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read()
MsgBox objTag.Value
Declaración de variables en WinCC

Defina variables internas en el guión VB siempre a través de la instrucción "Dim", para evitar
escribir incorrectamente las variables.
Al crear una nueva acción, la instrucción "Option explicit" se registra de manera automática
en el área de declaración sin posibilidad de borrarla.
No utilice la instrucción "Option explicit" en su código, ya que pueden producirse errores tiempo
de ejecución.

VB Scripting
Ejemplo
El siguiente ejemplo muestra la declaración de una variable VBScript "IngVar":
'VBS14
Dim lngVar
lngVar = 5
MsgBox lngVar
Nota
Los nombres de variables no deben contener caracteres especiales.
Debe prestarse atención a que, al crear una variable, ésta no contenga ningún valor (Value
= VT_EMPTY). Inicialice variables de acuerdo a la declaración con un valor correspondiente.
Notas acerca de CrossReference

Todas las imágenes que Ud. direcciona con la formulación estándar
HMIRuntime.Tags("Tagname")
serán registradas automáticamente por la CrossReference de WinCC y serán indicadas en

las propiedades de la imagen.
Si accede a variables en su código con otras formulaciones, podrá darlas a conocer a través
de la siguiente sección de CrossReference:
' ' WINCC:TAGNAME_SECTION_START

Const TagNameInAction = "TagName"
' WINCC:TAGNAME_SECTION_END
Ud. puede insertar esta sección cuantas veces desee en las acciones VBS.
Nota
Es posible que los nombres de variables compuestos no sean registrados por CrossReference.
Consulte también
Name (Página 839)
ErrorDescription (Página 682)
LastError (Página 775)
QualityCode (Página 888)
TimeStamp (Página 1058)

VB Scripting
1.5.3.20 Tags (lista) (RT Professional)
Descripción
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
El listado "Tags" le permite el acceso a variables en WinCC Runtime. Como resultado del
acceso al listado "Tags" se suministra un objeto del tipo "Tag". Por medio del objeto Tag se
puede acceder a todas las propiedades y métodos de una variable.
Nota
"Tags" es un listado con un volumen de funciones limitado. A las variables dentro del listado
no se puede acceder a través del índice, sino únicamente a través del nombre de la variable.
Los métodos estándar get_Count y get_NewEnum no se pueden aplicar en el listado Tags.
Utilización
El acceso a las variables del listado se realiza por medio de:
HMIRuntime.Tags("Tagname")
Por medio del listado Tags se declaran variables (objetos Tag) para un acceso leyendo y un
acceso escribiendo. Para que el acceso de lectura y escritura pueda realizare sin errores,
deben existir las variables HMI correspondientes.
En VB Script se puede acceder a variables HMI directamente a través de su nombre y definir
y leer valores. Pero si usted desea consultar propiedades adicionales de la variable, tal como
el código de calidad o el sello de tiempo, o ejecutar un tratamiento de error, deberá acceder

VB Scripting
a la variable siempre a través del listado Tags. A través del objeto Tag devuelto Ud. tiene
acceso a todas las propiedades y métodos de las variables.
Con el método "CreateTagSet" se puede generar un objeto TagSet que posibilita el acceso
simultáneo a varias variables.
Ejemplo
Para crear variables, utilice el nombre de la variable.
'VBS16
Dim objTag
Set objTag = HMIRuntime.Tags("Tagname")
Si se utiliza solo el nombre de la variable, se asignan a la propiedad "TagPrefix" los
valores del contexto actual (de la ventana de imagen actual).
1.5.3.21 TagSet (lista) (RT Professional)
Descripción
El objeto "TagSet" permite el acceso simultáneo a varias variables en una ejecución. El acceso
simultáneo se realiza con mejor rendimiento y menor carga de comunicación que el acceso
individual a las distintas variables.
Utilización
El objeto "TagSet" se utiliza del siguiente modo:
● Método "Add"
Agregar variables a la lista
● Método "Item"
Acceder a los objetos Tag contenidos en la lista y a sus propiedades
● Método "Write"
Escribir todas las variables de la lista
● Método "Read"
Leer todas las variables de la lista
Eliminar variables individuales de la lista
● Método "RemoveAll"
Eliminar todas las variables de la lista
El acceso a las variables del listado se realiza por medio de:
'VBS169
Dim myTags
myTags = HMIRuntime.Tags.CreateTagSet
myTags("Tagname")

VB Scripting
Para que el acceso de lectura y escritura a las variables (objetos Tag) de la lista pueda ser
ejecutado sin errores, deberán existir las variables correspondientes en WinCC.
Si se ha presentado un error durante el acceso de lectura o escritura, el método aplicado
retorna un mensaje de error a través de las propiedades "LastError" y "ErrorDescription".
Ejemplo
El siguiente ejemplo muestra cómo se genera un objeto TagSet, cómo se agregan variables
y cómo se escriben valores.
'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
Consulte también
ErrorDescription (Página 682)
LastError (Página 775)
1.5.4 Tipos de objeto (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5.4.1 Tipos de objeto disponibles en VBS (Panels, Comfort Panels, RT Advanced, RT

Professional)
Finalidad de las tablas inferiores

Las siguientes tablas muestran los nombres VBS de los tipos de objeto y su nombre de
visualización en el editor "Imágenes", así como su disponibilidad en los distintos runtimes.

VB Scripting
Objetos básicos
Nombre VBS Nombre de visualiza‐ Soporte de script Disponible en

ción WinCC RT CE WinCC RT Ad‐ WinCC RT Pro‐
(Panels) vanced fessional
Circle Círculo Sí Sí Sí Sí
CircleSegment Segmento circular Sí - - Sí
CircularArc Arco circular Sí - - Sí
Connector Conector Sí - - Sí
Ellipse Elipse Sí Sí Sí Sí
EllipseSegment Segmento elíptico Sí - - Sí
EllipticalArc Arco elíptico Sí - - Sí
GraphicView Visor de gráficos Sí Sí Sí Sí
Line Línea Sí Sí Sí Sí
Polygon Polígono Sí Sí Sí Sí
Polyline Polilínea Sí Sí Sí Sí
Rectangle Rectángulo Sí Sí Sí Sí
TextField Campo de texto Sí Sí Sí Sí
TubeArcObject Arco tubular Sí - - Sí
TubeDoubleTeeObject Pieza en T doble Sí - - Sí
TubePolyline Tubo Sí - - Sí
TubeTeeObject Pieza en T Sí - - Sí
Elementos

Bar Barra Sí Sí Sí Sí
BatteryView Estado de carga Sí Sí - -
Button Botón Sí Sí Sí Sí
CheckBox Casilla de verificación Sí - - Sí
Clock Reloj Sí Sí Sí Sí
ComboBox Cuadro combinado Sí - - Sí
DateTimeField Campo de fecha y hora Sí Sí Sí -
DiskSpaceView Visor de memoria Sí - - Sí
Gauge Indicador gauge Sí Sí Sí Sí
GraphicIOField Campo E/S gráfico Sí Sí Sí Sí
HelpIndicator Indicador de ayuda no1 Sí - -
IOField Campo E/S Sí Sí Sí Sí
MultilineEdit Campo de texto editable Sí - - Sí
ListBox Cuadro de lista Sí - - Sí
OptionGroup Botones de opción Sí - - Sí

VB Scripting

ProtectedAreaName‐ Rango efectivo Nombre Sí sí2 - -
View (RFID)
RangeLabelView Rango efectivo Nombre Sí sí2 - -
RangeQualityView Rango efectivo Señal Sí sí 2
- -
RoundButton Botón redondo Sí - - Sí
Slider Deslizador Sí Sí Sí Sí
Switch Interruptor Sí Sí Sí -
SymbolicIOField Campo E/S simbólico Sí Sí Sí Sí
SymbolLibrary Librería de símbolos Sí Sí Sí Sí
WindowSlider Barra de desplazamien‐ Sí - - Sí
to
WLanQualityView Recepción WLAN Sí sí2 - -
ZoneLabelView Zona Nombre Sí sí2 - -
ZoneQualityView Zona Señal Sí sí 2
- -
1
Configurable solo en la imagen general
2
Mobile Panels
Controles

AlarmControl Visor de avisos Sí - - Sí
AlarmIndicator Indicador de avisos no 1
Sí Sí -
AlarmView Visor de avisos Sí Sí Sí -
AlarmWindow Ventana de avisos no 1
Sí Sí -
ApplicationWindow Trabajo de impresión/ Sí - - Sí
diagnóstico de script
CameraControl Visor de cámara Sí Sí - -
ChannelDiagnose Diagnóstico de canal Sí - - Sí
FunctionTrendControl Visor de curvas f(x) Sí Sí Sí Sí
HTMLBrowser Navegador HTML Sí Sí Sí Sí
MediaPlayer Media Player Sí Sí - Sí
OnlineTableControl Visor de tablas Sí - - Sí
OnlineTrendControl Visor de curvas f(t) Sí - - Sí
PDFview Visor de PDF Sí Sí Sí -
PLCCodeViewer Visor de código PLC Sí - - Sí
RecipeView Visor de recetas Sí Sí Sí -
S7GraphOverview Vista general de S7- Sí - - Sí
GRAPH
ScreenWindow Ventana de imagen Sí - - Sí

VB Scripting

SmartClientView Visor Sm@rtClient Sí Sí Sí -
StatusForce Tabla de observación Sí Sí Sí -
SysDiagControl Visor de diagnóstico del Sí Sí Sí Sí
sistema
SysDiagWindow Ventana de diagnóstico no1 Sí Sí -
del sistema
TrendRulerControl Tabla de valores Sí - - Sí
TrendView Visor de curvas Sí Sí Sí -
UserArchiveControl Visor de recetas Sí - - Sí
UserView Visor de usuarios Sí Sí Sí Sí
1
Configurable solo en la imagen general
1.5.4.2 Objetos A-I (Panels, Comfort Panels, RT Advanced, RT Professional)
AlarmControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de avisos". El objeto AlarmControl es un elemento de la lista

ScreenItems.
Identificación de tipo en VBS

HMIAlarmControl

VB Scripting
Ejemplo
En el siguiente ejemplo se desplazará 10 píxeles hacia la derecha el objeto con el nombre
"Control1":
'VBS54
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 10
Abreviatura Acceso en runtime

R Lectura
RW Lectura y escritura
- Ningún acceso
Tabla 1-1 Propiedades
Propiedades RT Profes‐ RT Advan‐ Panel RT Descripción

sional ced
AllFilters - - - -
AllFiltersForHitlist - - - -
AllServer (Página 521) RW - - Determina si se mostrarán los avisos de todos los
servidores disponibles.
AllTagTypesAllowed - - - -
ApplyProjectSettings RW - - Define si se tomarán los ajustes de proyecto del edi‐
(Página 524) tor "Avisos HMI".
ApplyProjectSettings‐ - - - -
ForDesignMode
AssignedFilters - - - -
AssignedHitlistFilters - - - -
AutoCompleteColumns RW - - Define si se mostrarán las columnas vacías cuando
(Página 530) el control es más ancho que las columnas configu‐
radas.
AutoCompleteRows RW - - Define si se mostrarán filas vacías cuando el control
(Página 531) sea más largo que el número de filas configuradas.
AutoScroll (Página 532) RW - - Determina cómo se comportará la ventana de avisos
al aparecer nuevos avisos.
AutoSelectionColors RW - - Define si el color de selección para celda y fila se
(Página 532) realizará con los colores preestablecidos por el sis‐
tema.
AutoSelectionRectCo‐ RW - - Define si el borde de selección se representará en
lor (Página 533) el color definido por el sistema.
BackColor (Página 537) RW - - Define el color de fondo del objeto indicado.
Blocks - - - -

VB Scripting

sional ced
BorderColor - - - -
BorderWidth (Pági‐ RW - - Define el grosor de línea del objeto indicado.
na 589)
Bounds - - - -
CanBeGrouped - - - -
Caption (Página 598) RW - - Determina el texto que se muestra en la barra de
título del objeto indicado.
CellCut (Página 603) RW - - Define si el contenido de las celdas se abreviará en
caso de que las celdas sean demasiado estrechas.
CellSpaceBottom (Pági‐ RW - - Establece la distancia inferior que se utilizará en las
na 604) celdas de la tabla.
CellSpaceLeft (Pági‐ RW - - Define el sangrado izquierdo que se utilizará en las
CellSpaceRight (Pági‐ RW - - Define el sangrado derecho que se utilizará en las
CellSpaceTop (Pági‐ RW - - Establece la distancia superior que se utilizará en
na 606) las celdas de la tabla.
Closeable (Página 611) RW - - Define si el objeto se puede cerrar en runtime.
ColumnResize (Pági‐ RW - - Define si se puede modificar el ancho de las colum‐
na 628) nas.
Columns - - - -
ColumnScrollbar (Pági‐ RW - - Determina si las barras de desplazamiento de co‐
na 629) lumnas se deben visualizar.
ColumnTitleAlignment RW - - Determina cómo se alinearán los títulos de colum‐
(Página 639) nas.
ColumnTitles (Pági‐ RW - - Define si se mostrará el título de las columnas.
na 640)
ControlDesignMode RW - - Define el estilo del control.
(Página 646)
DefaultFilterEom - - - -
DefaultHitListFilterEom - - - -
DefaultMsgFilterSQL RW - - Define un Statement SQL como estándar para el fil‐
(Página 657) tro de avisos.
DefaultSort (Pági‐ RW - - Establece el tipo de clasificación.
na 658)
DefaultSort2 (Pági‐ RW - - Establece el tipo de clasificación.
na 658)
DefaultSort2Column RW - - Define una columna por la que se ordena inicialmen‐
(Página 659) te el visor de avisos de forma estándar.
DiagnosticsContext (Pá‐ RW - - Define el contexto de diagnóstico.
gina 660)
DisplayOptions (Pági‐ RW - - Determina si se mostrarán los avisos cuya visuali‐
na 665) zación se ha ocultado.
DoubleClickAction (Pá‐ RW - - Define la acción que se realizará cuando se haga
gina 667) doble clic en la fila de avisos en runtime.

VB Scripting

sional ced
Enabled (Página 672) RW - - Define si el objeto indicado se podrá manejar en
runtime.
ExportDelimiter - - - -
ExportDirectoryChan‐ RW - - Define si el directorio para la exportación de datos
geable (Página 686) se podrá modificar en runtime.
ExportDirectoryname RW - - Determina el directorio al cual se exportarán los da‐
(Página 687) tos de runtime.
ExportFileExtension RW - - Define la extensión del archivo de exportación. Has‐
(Página 688) ta el momento solamente es compatible la extensión
"csv".
ExportFilename (Pági‐ RW - - Define el nombre del archivo al cual se exportarán
na 688) los datos de runtime.
ExportFilenameChan‐ RW - - Define si el nombre del archivo de exportación se
geable (Página 689) podrá modificar en runtime.
ExportFormat - - - -
ExportFormatGuid (Pá‐ RW - - Define la asignación de número de ident. y Export-
gina 690) Provider.
ExportFormatName RW - - Determina el formato de archivo para la exportación.
(Página 691) Actualmente sólo está disponible el formato de ar‐
chivo "csv" para la exportación.
ExportParameters (Pá‐ RW - - Define los parámetros del formato seleccionado en
gina 692) el cuadro de diálogo de propiedades.
ExportSelection (Pági‐ RW - - Define qué datos de runtime del control se exporta‐
na 693) rán.
ExportShowDialog (Pá‐ RW - - Define si el cuadro de diálogo para la exportación
gina 693) de datos se mostrará en runtime.
FillPattern - - - -
FillPatternColor - - - -
Filter - - - -
Font (Página 717) RW - - Define la fuente.
GridLineColor (Pági‐ RW - - Establece el color de las líneas de cuadrícula.
na 730)
GridLineWidth (Pági‐ RW - - Define en píxeles el grosor de las líneas de separa‐
na 731) ción.
Height (Página 732) RW - - Define la altura del objeto indicado.
Hitlist - - - -
HitlistColumnAdd (Pági‐ RW - - Aplica el bloque de aviso seleccionado de la lista de
na 739) bloques de aviso existentes y lo introduce en la lista
de bloques de aviso seleccionados.
HitlistColumnCount (Pá‐ RW - - Especifica el número de bloques de aviso seleccio‐
gina 740) nados que aparecerán en la lista de aciertos en run‐
time.
HitlistColumnIndex (Pá‐ RW - - Hace referencia a uno de los bloques de aviso se‐
gina 740) leccionados para la lista de aciertos.
HitlistColumnName (Pá‐ RW - - Indica el nombre del bloque de aviso de la lista de
gina 741) aciertos referenciado con la propiedad "HitlistColum‐
nIndex".

VB Scripting

sional ced
HitlistColumnRemove RW - - Elimina el bloque de aviso seleccionado de la lista
(Página 742) de bloques seleccionados y lo introduce en la lista
de bloques de aviso existentes.
HitlistColumnRepos RW - - Modifica la secuencia de los bloques de aviso.
(Página 742)
HitlistColumnSort (Pági‐ RW - - Establece cómo se clasificará en la lista de aciertos
na 743) el bloque de aviso referenciado en "HitlistColumnIn‐
dex".
HitlistColumnSortIndex RW - - Define el orden de clasificación del bloque de aviso
(Página 743) de la lista de aciertos referenciado en "HitlistColum‐
nIndex".
HitlistColumnVisible RW - - Establece una lista con los bloques de aviso selec‐
(Página 744) cionados de la lista de aciertos que se utilizarán en
el control en runtime.
HitlistDefaultSort (Pági‐ RW - - Define la clasificación predeterminada en las colum‐
na 745) nas de la tabla de la lista de aciertos.
HitlistFilter - - - -
HitlistMaxSourceItems RW - - Establece el número máximo de registros que se
(Página 745) utilizan del fichero de avisos para la creación de la
lista de aciertos.
HitlistMaxSourceItems‐ RW - - Determina si se mostrará una advertencia cuando
Warn (Página 746) se alcance el número máximo de registros especifi‐
cado en "HitlistMaxSourceItems".
HitListRelTime (Pági‐ RW - - Determina si se utilizará el intervalo de tiempo para
na 746) la estadística.
HitListRelTimeFactor RW - - Establece el factor de tiempo que, con el tipo de
(Página 747) tiempo "HitlistRelTimeFactorType", determina el pe‐
riodo del que se creará la estadística de la lista de
aciertos.
HitlistRelTimeFactorTy‐ RW - - Establece el tipo de tiempo que, con el factor de
pe (Página 748) tiempo "HitlistRelativeTimeFactor", determina el pe‐
ríodo para el que se crea la estadística de la lista de
aciertos.
HorizontalGridLines RW - - Define si se deben visualizar líneas horizontales.
(Página 750)
IconSpace (Página 753) RW - - Define la distancia entre símbolo y texto en las cel‐
das de la tabla.
IsActive - - - -
Layer (Página 776) RW - - Dentro de la imagen, define el nivel en el que se
encuentra un objeto.
Left (Página 782) RW - - Define el valor de la coordenada X del objeto.
LineBackgroundColor - - - -
LineColor (Página 799) RW - - Define el color de las líneas de separación de la
ventana.
LineStyle - - - -
LineWidth (Página 802) RW - - Define el grosor de línea del objeto indicado.
Location - - - -

VB Scripting

sional ced
LongTermArchiveCon‐ RW - - Determina cómo se mostrarán los avisos en el visor
sistency (Página 807) de avisos cuando esté configurada la visualización
"Ficheros de largo plazo".
MessageBlockAlign‐ RW - - Determina cómo se van a alinear los contenidos del
ment (Página 814) bloque de aviso seleccionado en la tabla.
MessageBlockAutoPre‐ RW - - Determina si la cantidad de decimales se debe de‐
cisions (Página 814) terminar automáticamente.
MessageBlockCaption RW - - Establece el título de la columna en el visor de avisos
(Página 815) para el bloque de aviso seleccionado.
MessageBlockCount RW - - Especifica el número de bloques de aviso existentes
(Página 816) que están disponibles para la lista de avisos y la lista
de aciertos.
MessageBlockDateFor‐ RW - - Define qué formato de fecha se utilizará para los
mat (Página 816) avisos.
MessageBlockExpo‐ RW - - Determina si los valores del bloque de aviso selec‐
nentialFormat (Pági‐ cionado se mostrarán en representación exponen‐
na 817) cial.
MessageBlockFlashOn RW - - Establece si el contenido del bloque de aviso selec‐
(Página 818) cionado parpadeará en runtime cuando aparezca un
aviso.
MessageBlockHideText RW - - Determina si el contenido del bloque de aviso selec‐
(Página 818) cionado se mostrará en forma de texto.
MessageBlockHideTi‐ RW - - Determina si el título del bloque de aviso seleccio‐
tleText (Página 819) nado se mostrará en forma de texto.
MessageBlockId (Pági‐ RW - - Define la asignación de clave ID y bloque de aviso
na 819) en el visor de avisos.
MessageBlockIndex RW - - Hace referencia a un bloque de aviso ya existente.
(Página 820)
MessageBlockLeading‐ RW - - Determina si el formato del bloque de aviso selec‐
Zeros (Página 821) cionado se mostrará con ceros a la izquierda.
MessageBlockLength RW - - Establece la longitud en caracteres para el conteni‐
(Página 821) do del bloque de aviso seleccionado.
MessageBlockName RW - - Define el nombre para el bloque de aviso seleccio‐
(Página 822) nado.
MessageBlockPreci‐ RW - - Define el número de decimales de los valores del
sions (Página 822) bloque de aviso seleccionado.
MessageBlockSelected RW - - Los bloques de aviso existentes son bloques que
(Página 823) están disponibles para la lista de avisos o la lista de
aciertos en el control en runtime.
MessageBlockShowDa‐ RW - - Define si en el bloque de aviso "Hora" se mostrará
te (Página 823) la fecha además de la hora.
MessageBlockShowI‐ RW - - Determina si el contenido del bloque de aviso selec‐
con (Página 824) cionado se mostrará en forma de símbolo.
MessageBlockShowTi‐ RW - - Determina si el título del bloque de aviso seleccio‐
tleIcon (Página 825) nado se mostrará en forma de texto.
MessageBlockTextId RW - - Define el nombre del bloque de aviso seleccionado
(Página 825) con ayuda de un ID de texto obtenido en la librería
de textos.

VB Scripting

sional ced
MessageBlockTimeFor‐ RW - - Determina qué formato de tiempo o de duración se
mat (Página 826) utilizará para visualizar los avisos.
MessageBlockType RW - - Especifica el número de bloques de aviso existentes
(Página 827) que están disponibles para la lista de avisos y la lista
de aciertos.
MessageColumnAdd RW - - Aplica el bloque de aviso marcado de la lista de blo‐
(Página 827) ques de aviso existentes y lo introduce en la lista de
bloques de aviso seleccionados.
MessageColumnCount RW - - Especifica el número de bloques de aviso seleccio‐
(Página 828) nados que aparecerán en la lista de avisos en runti‐
me.
MessageColumnIndex RW - - Hace referencia a uno de los bloques de aviso se‐
(Página 829) leccionados para la lista de avisos.
MessageColumnName RW - - Define el nombre del bloque de aviso de la lista de
(Página 829) avisos referenciado con la propiedad "MessageCo‐
lumnIndex".
MessageColumnRemo‐ RW - - Elimina el bloque de aviso seleccionado de la lista
ve (Página 830) de bloques seleccionados y lo introduce en la lista
de bloques de aviso existentes.
MessageColumnRepos RW - - Define la secuencia de los bloques de aviso.
(Página 830)
MessageColumnSort RW - - Establece cómo se clasificará el bloque de aviso re‐
(Página 831) ferenciado en "MessageColumnIndex".
MessageColumnSortIn‐ RW - - Define el orden de clasificación del bloque de aviso
dex (Página 832) referenciado en "MessageColumnIndex".
MessageColumnVisible RW - - Determina si los bloques de aviso se mostrarán en
(Página 832) el visor de avisos.
MessageListType (Pági‐ RW - - Determina la lista de avisos cuyo contenido se mos‐
na 833) trará al abrir una imagen.
Moveable (Página 838) RW - - Determina si la ventana puede moverse en runtime.
MsgFilterSQL (Pági‐ RW - - Define uno o varios Statements SQL para la selec‐
na 838) ción personalizada de los avisos.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
OcxStateForEs2Rt - - - -
OperatorAlarms - - - -
OperatorMessageId RW - - Define la asignación por la clave ID y el evento de
(Página 853) activación en el visor de avisos.
OperatorMessageIndex RW - - Hace referencia al evento de aviso para un aviso de
(Página 854) operador.
OperatorMessageNa‐ RW - - Define el nombre referenciado con el evento "Ope‐
me (Página 855) ratorMessageIndex" en eventos para avisos de ope‐
rador.

VB Scripting

sional ced
OperatorMessageNum‐ RW - - Define un número para el aviso de operador del
ber (Página 855) evento de aviso seleccionado si nose utiliza el aviso
de operador de WinCC.
OperatorMessageSe‐ RW - - Activa los eventos de aviso en la lista en la que se
lected (Página 856) habilitarán los avisos de operador.
OperatorMessageSour‐ RW - - Determina un bloque de aviso para el aviso utilizado,
ce1 (Página 856) que se añadirá al "Bloque de valor de proceso 1" del
aviso de operador configurado aquí.
ce10 (Página 863) que se añadirá al "Bloque de valor de proceso 10"
del aviso de operador configurado aquí.
OperatorMessageSour‐ RW - - Define en qué formato se transferirá el contenido del
ceType1 (Página 863) origen.

VB Scripting

sional ced
PageMode (Pági‐ RW - - Determina si el paso de página es posible en la lista
na 871) de ficheros a largo plazo.
PageModeMessage‐ RW - - Define la cantidad de avisos que se mostrarán por
Number (Página 871) página cuando se pase de página en la lista de fi‐
cheros a largo plazo.
PrintJob (Página 885) RW - - Define un trabajo de impresión creado en el editor
"Informes".
RowScrollbar (Pági‐ RW - - Determina si las barras de desplazamiento de filas
na 898) se deben visualizar.
RowTitleAlignment (Pá‐ RW - - Define cómo se alinearán los títulos de fila.
gina 899)
RowTitles (Página 900) RW - - Determina que se muestren los encabezados de las
filas.
RTPersistence (Pági‐ RW - - Define cómo se conservarán las configuraciones on‐
na 901) line de WinCC.
RTPersistenceAuthori‐ RW - - Define el permiso que se requiere en runtime para
zation (Página 901) la configuración online.
RTPersistenceType RW - - Define cómo se conservarán las configuraciones on‐
(Página 902) line de WinCC.
SelectedCellColor (Pá‐ RW - - Define el color de fondo de la celda seleccionada.
gina 919)
SelectedCellForeColor RW - - Define el color de fuente de la celda seleccionada.
(Página 920)
SelectedRowColor (Pá‐ RW - - Define el color de fondo de la fila seleccionada.
gina 922)
SelectedRowForeColor RW - - Define el color de fuente de la fila seleccionada.
(Página 923)
SelectedTitleColor (Pá‐ RW - - Define el color de fondo del título de tabla seleccio‐
gina 924) nado.
SelectedTitleForeColor RW - - Define el color de fuente del título de tabla seleccio‐
(Página 925) nado.
SelectionColoring (Pági‐ RW - - Define si se utilizarán colores de selección para cel‐
na 928) das o filas.
SelectionRect (Pági‐ RW - - Define si se utilizará un borde de selección para las
na 929) celdas o filas seleccionadas.
SelectionRectColor (Pá‐ RW - - Define el color del rectángulo de selección en la ven‐
gina 930) tana de avisos cuando SelectionType sea "1".
SelectionRectWidth RW - - Establece el grosor de la línea del rectángulo de se‐
(Página 931) lección en la ventana de avisos cuando SelectionTy‐
pe sea "1".
SelectionType (Pági‐ RW - - Determina cuántas líneas pueden seleccionarse.
na 932)

VB Scripting

sional ced
ServerNames (Pági‐ RW - - Establece los servidores de un sistema distribuido
na 937) de los que recibe datos el visor de avisos.
ShowSortButton (Pági‐ RW - - Define si se mostrará la tecla de clasificación en la
na 955) barra de desplazamiento.
ShowSortIcon (Pági‐ RW - - Define si se mostrará el símbolo de clasificación.
na 956)
ShowSortIndex (Pági‐ RW - - Determina si se mostrará un índice de clasificación.
na 957)
ShowTitle (Página 962) RW - - Determina si se visualizará el título de la ventana del
control.
Size - - - -
Sizeable (Página 966) RW - - Define si puede modificarse el tamaño del objeto en
runtime.
SortSequence (Pági‐ RW - - Determina cómo se puede modificar el orden de cla‐
na 968) sificación haciendo clic con el ratón.
StatusbarBackColor RW - - Define el color de fondo de la barra de estado.
(Página 973)
StatusbarElementAdd RW - - Crea un nuevo elemento de la barra de estado defi‐
(Página 974) nido por el usuario.
StatusbarElementAuto‐ RW - - Establece si el ancho del elemento seleccionado de
Size (Página 975) la barra de estado se ajustará automáticamente.
StatusbarElement‐ RW - - Determina el número de elementos configurables de
Count (Página 976) la barra de estado.
StatusbarElementIco‐ RW - - Define la asignación del número de ident. y del sím‐
nId (Página 977) bolo de un elemento de la barra de estado.
StatusbarElementID RW - - Define el número de identidad para el elemento se‐
(Página 978) leccionado de la barra de estado.
StatusbarElementIndex RW - - Define la referencia de un elemento de la barra de
(Página 979) estado.
StatusbarElementNa‐ RW - - Define el nombre de objeto para el elemento selec‐
me (Página 980) cionado de la barra de estado.
StatusbarElementRe‐ RW - - Elimina el elemento definido por el usuario seleccio‐
move (Página 980) nado en la barra de estado.
StatusbarElementRena‐ RW - - Modifica el nombre del elemento definido por el
me (Página 981) usuario de la barra de estado que está referenciado
mediante la propiedad "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Determina el índice de un elemento en la barra de
pos (Página 982) estado del objeto de manejo y visualización.
StatusbarElements - - - -
StatusbarElementText RW - - Define el texto del elemento seleccionado de la ba‐
(Página 983) rra de estado.
StatusbarElementTool‐ RW - - Define el texto del tooltip del elemento definido por
tipText (Página 984) el usuario seleccionado en la barra de estado.
StatusbarElementUser‐ RW - - Define si el elemento de la barra de estado ha sido
Defined (Página 985) agregado por el ingeniero como nuevo elemento de‐
finido por el usuario.

VB Scripting

sional ced
StatusbarElementVisi‐ RW - - Determina si el elemento referenciado en la barra
ble (Página 986) de estado se mostrará en runtime.
StatusbarElementWidth RW - - Indica el ancho del elemento referenciado de la ba‐
(Página 987) rra de estado en píxeles.
StatusbarFont (Pági‐ RW - - Define la fuente de los textos de la barra de estado.
na 987)
StatusbarFontColor (Pá‐ RW - - Define el color de fuente de los textos de la barra de
gina 988) estado.
StatusbarShowTooltips RW - - Define si en runtime se mostrarán los tooltips de los
(Página 989) elementos de la barra de estado.
StatusbarText (Pági‐ RW - - Define el texto estándar de la barra de estado.
na 990)
StatusbarUseBackCo‐ RW - - Define si se debe visualizar el color de fondo de la
lor (Página 991) barra de estado.
StatusbarVisible (Pági‐ RW - - Define si se debe visualizar la barra de estado del
na 992) control.
TabIndex - - - -
TabIndexAlpha - - - -
TableColor (Pági‐ RW - - Define el color de fondo de las filas de tabla del ob‐
na 1002) jeto.
TableColor2 (Pági‐ RW - - Define el segundo color de fondo de las filas de tabla
na 1003) del objeto.
TableForeColor (Pági‐ RW - - Define el color de fuente de las celdas de tabla del
na 1005) objeto.
TableForeColor2 (Pági‐ RW - - Define el segundo color de fuente de las celdas de
na 1005) tabla del objeto.
TimeBase (Pági‐ RW - - Define la zona horaria que sirve de base para mos‐
na 1039) trar los valores de tiempo.
TitleColor (Pági‐ RW - - Define el color de fondo del título de la tabla.
na 1061)
TitleCut (Página 1062) RW - - Define si el contenido de los campos de una barra
de título se cortará cuando el ancho de columna sea
demasiado pequeño.
TitleDarkShadowColor RW - - Define el color de la parte oscura del sombreado 3D
(Página 1062) para los encabezados de columna y fila de la tabla
del objeto.
TitleForeColor (Pági‐ RW - - Define el color de fuente en los encabezados de co‐
na 1063) lumna y fila de la tabla del objeto.
TitleGridLineColor (Pá‐ RW - - Define el color de las líneas de separación en la ba‐
gina 1064) rra de título de la tabla.
TitleLightShadowColor RW - - Define el color de la parte clara del sombreado 3D
del objeto.
TitleSort (Página 1066) RW - - Define cómo se iniciará la clasificación por título de
columna.
TitleStyle (Página 1067) RW - - Determina qué color de sombreado se usa para el
título de tabla.

VB Scripting

sional ced
ToolbarAlignment (Pági‐ RW - - Define la posición de la barra de herramientas.
na 1075)
ToolbarBackColor (Pá‐ RW - - Define el color de fondo de la barra de herramientas.
gina 1076)
ToolbarButtonActive RW - - Define si la función enlazada con la tecla está acti‐
(Página 1077) vada en runtime.
ToolbarButtonAdd (Pá‐ RW - - Crea un nuevo botón definido por el usuario en la
gina 1078) barra de herramientas del objeto.
ToolbarButtonAuthori‐ RW - - Muestra el permiso para la función de tecla selec‐
zation (Página 1079) cionada.
ToolbarButtonBegin‐ RW - - Define si se añadirá un separador antes de la fun‐
Group (Página 1080) ción de teclas seleccionada.
ToolbarButtonClick (Pá‐ RW - - Hace clic en un botón de la barra de herramientas.
gina 1081)
ToolbarButtonCount RW - - Define el número de botones que contiene la barra
(Página 1081) de herramientas.
ToolbarButtonEnabled RW - - Define si se puede manejar la tecla definida por el
(Página 1082) usuario de la barra de herramientas.
ToolbarButtonHotKey RW - - Define la combinación de teclas para el botón selec‐
(Página 1083) cionado del objeto.
ToolbarButtonID (Pági‐ RW - - Define una función de tecla mediante su número de
na 1084) identidad inequívoco.
ToolbarButtonIndex RW - - Hace referencia a una función de tecla.
(Página 1085)
ToolbarButtonLocked RW - - Determina si se mostrará el estado pulsado (enca‐
(Página 1086) jado) de un botón definido por el usuario en la barra
de herramientas.
ToolbarButtonName RW - - Define el nombre del botón definido por el usuario
(Página 1087) seleccionado.
ToolbarButtonRemove RW - - Elimina el botón definido por el usuario selecciona‐
(Página 1088) do.
ToolbarButtonRename RW - - Define el nombre del botón personalizado de la ba‐
(Página 1088) rra de herramientas que está referenciado mediante
la propiedad "ToolbarButtonIndex".
ToolbarButtonRepos RW - - Define la posición de un botón referenciado en la
(Página 1089) barra de herramientas del objeto.
ToolbarButtons - - - -
ToolbarButtonTooltip‐ RW - - Define el texto para el tooltip del botón definido por
Text (Página 1091) el usuario en la barra de herramientas.
ToolbarButtonUserDefi‐ RW - - Define si la tecla de la barra de herramientas ha sido
ned (Página 1092) agregada por el ingeniero como tecla nueva definida
por el usuario.
ToolbarButtonVisible RW - - Determina si se mostrará el botón en la barra de
(Página 1092) herramientas.
ToolbarShowTooltips RW - - Define si en runtime se mostrarán los tooltips de las
(Página 1094) funciones de tecla.
ToolbarUseBackColor RW - - Define si visualizará el color de fondo de la barra de

VB Scripting

sional ced
ToolbarUseHotKeys RW - - Determina si las teclas de acceso directo están ac‐
(Página 1096) tivas para las funciones de tecla en runtime.
ToolbarVisible (Pági‐ RW - - Define si se debe visualizar la barra de herramientas
na 1097) del control.
Top (Página 1099) RW - - Define el valor de la coordenada Y del objeto indica‐
do.
UseMessageColor (Pá‐ RW - - Determina si deben mostrarse los colores acorda‐
gina 1171) dos para las categorías.
UseSelectedTitleColor RW - - Define si se utilizará un color de selección para los
(Página 1172) títulos de las celdas de tabla seleccionadas.
UseTableColor2 (Pági‐ RW - - Define si se utilizará un segundo color de fila en la
na 1174) representación de la tabla.
VerticalGridLines (Pági‐ RW - - Define si se deben visualizar líneas verticales.
na 1218)
Visible (Página 1222) RW - - Define si el objeto indicado será visible.
Width (Página 1234) RW - - Define el ancho del objeto en píxeles.
Tabla 1-2 Métodos
Métodos RT Profes‐ RT Advan‐ Panel RT Descripción

sional ced
Activate (Página 1268) Sí - - Activa el área permanente o la imagen raíz.
ActivateDynamic (Pági‐ Sí - - Activa dinámicamente un disparador y el ciclo fijado
na 1270) para una propiedad durante el runtime.
AttachDB (Pági‐ Sí - - Ejecuta la función de tecla "Conectar copia de se‐
na 1274) guridad" del control.
CopyRows (Pági‐ Sí - - Ejecuta la función de tecla "Copiar filas" del control.
na 1275)
DeactivateDynamic (Pá‐ Sí - - Desactiva en/durante el runtime el disparador usado
gina 1277) del método "ActivateDynamic" para la propiedad fi‐
jada.
DetachDB (Pági‐ Sí - - Ejecuta la función de tecla "Desconectar copia de
na 1280) seguridad" del control.
Export (Página 1281) Sí - - Ejecuta la función de tecla "Exportar fichero" o "Ex‐
portar datos" del control.
GetHitlistColumn (Pági‐ Sí - - Devuelve el objeto de columna designado por nom‐
na 1285) bre o índice de la lista de aciertos del visor de avisos
como tipo "ICCAxMessageColumn".
GetHitlistColumnCollec‐ Sí - - Devuelve el listado de todos los objetos de columna
tion (Página 1283) de la lista de aciertos del visor de avisos como tipo
"ICCAxCollection".
GetMessageBlock (Pá‐ Sí - - Devuelve el objeto de bloque de aviso designado
gina 1286) por nombre o índice del visor de avisos como tipo
"ICCAxMessageBlock".
GetMessageBlockCo‐ Sí - - Devuelve el listado de todos los objetos de bloque
llection (Página 1287) de aviso del visor de avisos como tipo "ICCAxCo‐
llection".

VB Scripting

sional ced
GetMessageColumn Sí - - Devuelve el objeto de columna designado por nom‐
(Página 1288) bre o índice del visor de avisos como tipo "ICCAx‐
MessageColumn".
GetMessageColumnCo‐ Sí - - Devuelve el listado de todos los objetos de columna
llection (Página 1289) del visor de avisos como tipo "ICCAxCollection".
GetOperatorMessage Sí - - Devuelve el objeto de aviso de operador designado
(Página 1290) por nombre o índice del visor de avisos como tipo
"ICCAxOperatorMessage".
GetOperatorMessage‐ Sí - - Devuelve el listado de todos los objetos de aviso de
Collection (Pági‐ operador del visor de avisos como tipo "ICCAxCo‐
na 1291) llection".
GetRow (Página 1292) Sí - - Devuelve el objeto de filas designado mediante el
número de fila de los controles basados en tablas
como tipo "ICCAxDataRow".
GetRowCollection (Pá‐ Sí - - Devuelve el listado de todos los objetos de filas de
gina 1294) los controles basados en tablas como tipo "ICCAx‐
DataRowCollection".
GetSelectedRow (Pági‐ Sí - - Devuelve como tipo "ICCAxDataRow" el objeto de
na 1300) filas seleccionado de un control basado en tablas.
GetSelectedRows (Pá‐ Sí - - Con selección múltiple, devuelve como tipo "ICCAx‐
gina 1301) DataRow" los objetos de filas seleccionados de un
control basado en tablas.
GetStatusbarElement Sí - - Devuelve el elemento de la barra de estado desig‐
(Página 1307) nado por nombre o índice del control como tipo "IC‐
CAxStatusbarElement".
GetStatusbarElement‐ Sí - - Devuelve el listado de todos los elementos de la ba‐
Collection (Pági‐ rra de estado del control como tipo "ICCAxCollec‐
na 1308) tion".
GetToolbarButton (Pági‐ Sí - - Devuelve la función de tecla designada por nombre
na 1315) o índice de la barra de herramientas del control co‐
mo tipo "ICCAxToolbarButton".
GetToolbarButtonCo‐ Sí - - Devuelve el listado de todas las funciones de tecla
llection (Página 1317) de la barra de herramientas del control como tipo
"ICCAxCollection".
HideAlarm (Pági‐ Sí - - Ejecuta la función del botón "Ocultar aviso" del visor
na 1333) de avisos.
LockAlarm (Pági‐ Sí - - Ejecuta la función del botón "Bloquear aviso" del vi‐
na 1335) sor de avisos.
LoopInAlarm (Pági‐ Sí - - Ejecuta la función del botón "Loop in Alarm" del visor
na 1336) de avisos.
MoveToFirstLine (Pági‐ Sí - - Ejecuta la función del botón "Primer aviso" del visor
na 1337) de avisos.
MoveToFirstPage (Pági‐ Sí - - Ejecuta la función del botón "Primera página" del
na 1338) visor de avisos.
MoveToLastLine (Pági‐ Sí - - Ejecuta la función del botón "Último aviso" del visor
na 1339) de avisos.
MoveToLastPage (Pági‐ Sí - - Ejecuta la función del botón "Última página" del visor
na 1339) de avisos.

VB Scripting

sional ced
MoveToNextLine (Pági‐ Sí - - Ejecuta la función del botón "Aviso siguiente" del
MoveToNextPage (Pá‐ Sí - - Ejecuta la función del botón "Página siguiente" del
gina 1341) visor de avisos.
MoveToPreviousLine Sí - - Ejecuta la función del botón "Aviso anterior" del visor
(Página 1342) de avisos.
MoveToPreviousPage Sí - - Ejecuta la función del botón "Página anterior" del
(Página 1342) visor de avisos.
Print (Página 1346) Sí - - Ejecuta la función del botón "Imprimir" del control.
QuitHorn (Página 1346) Sí - - Ejecuta la función del botón "Acuse de avisador cen‐
tral" del visor de avisos.
QuitSelected (Pági‐ Sí - - Ejecuta la función del botón "Acuse individual" del
QuitVisible (Pági‐ Sí - - Ejecuta la función del botón "Acuse de grupo" del
SelectAll (Página 1360) Sí - - Selecciona todas las filas en un control basado en
tablas.
SelectRow (Pági‐ Sí - - Selecciona una determinada fila en un control basa‐
na 1361) do en tablas.
ShowComment (Pági‐ Sí - - Ejecuta la función del botón "Diálogo de comentario"
na 1365) del visor de avisos.
ShowDisplayOptions‐ Sí - - Ejecuta la función del botón "Diálogo de opciones
Dialog (Página 1366) de visualización" del visor de avisos.
ShowEmergencyQuit‐ Sí - - Ejecuta la función del botón "Acuse de emergencia"
Dialog (Página 1366) del visor de avisos.
ShowHelp (Pági‐ Sí - - Ejecuta la función del botón "Ayuda" del control.
na 1367)
ShowHideList (Pági‐ Sí - - Ejecuta la función del botón "Lista de los avisos a
na 1367) ocultar" del visor de avisos.
ShowHitList (Pági‐ Sí - - Ejecuta la función del botón "Lista de aciertos" del
ShowInfoText (Pági‐ Sí - - Ejecuta la función del botón "Diálogo de texto infor‐
na 1368) mativo" del visor de avisos.
ShowLockDialog (Pági‐ Sí - - Ejecuta la función del botón "Diálogo de bloqueos"
ShowLockList (Pági‐ Sí - - Ejecuta la función del botón "Lista de inhibiciones"
ShowLongTermArchive‐ Sí - - Ejecuta la función del botón "Lista de ficheros de
List (Página 1370) largo plazo" del visor de avisos.
ShowMessageList (Pá‐ Sí - - Ejecuta la función del botón "Lista de avisos" del
gina 1370) visor de avisos.
ShowPropertyDialog Sí - - Ejecuta la función del botón "Diálogo de configura‐
(Página 1371) ción" del control.
ShowSelectionDialog Sí - - Ejecuta la función del botón "Diálogo de selección"
(Página 1373) del visor de avisos.
ShowShortTermArchi‐ Sí - - Ejecuta la función del botón "Lista de ficheros de
veList (Página 1374) corto plazo" del visor de avisos.

VB Scripting

sional ced
ShowSortDialog (Pági‐ Sí - - Ejecuta la función del botón "Diálogo de ordenación"
ShowTimebaseDialog Sí - - Ejecuta la función del botón "Diálogo de base de
(Página 1376) tiempo" del visor de avisos.
UnhideAlarm (Pági‐ Sí - - Ejecuta la función del botón "Mostrar aviso" del visor
na 1379) de avisos.
UnlockAlarm (Pági‐ Sí - - Ejecuta la función del botón "Habilitar aviso" del vi‐
na 1379) sor de avisos.
UnselectAll (Pági‐ Sí - - Elimina todas las marcas de las celdas de un control
na 1380) basado en tablas.
UnselectRow (Pági‐ Sí - - Elimina las marcas de una determinada celda de un
na 1380) control basado en tablas.
AlarmView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de avisos". El objeto AlarmView es un elemento de la lista

ScreenItems.
Si se modifican los ajustes de este objeto con una función de usuario, éstos se conservarán
incluso después de volver a llamar la imagen con este objeto.
Nota
El objeto "Visor de avisos simple" no se puede dinamizar mediante una función definida por
el usuario.

VB Scripting

R Lectura
- Ningún acceso

sional ced
AlarmAreaHeight - - - -
AlarmAreaWidth - - - -
AlarmClasses - - - -
AlarmLog - - - -
AlarmSource - - - -
AlarmTextTag - - - -
Authorization - - - -
BackColor (Página 537) - RW RW Define el color de fondo del objeto indicado.
BorderBackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBackColor - - - -
ButtonBackFillStyle - - - -
ButtonBarElements - - - -
ButtonBarStyle - - - -
ButtonBorderBackColor - - - -
ButtonBorderColor - - - -
ButtonBorderWidth - - - -
ButtonCornerRadius - - - -
ButtonEdgeStyle - - - -
ButtonFirstGradientCo‐ - - - -
lor
ButtonFirstGradientOff‐ - - - -
set
ButtonMiddleGradient‐ - - - -
Color
ButtonPositions - - - -
ButtonSecondGradient‐ - - - -
Color
ButtonSecondGradien‐ - - - -
tOffset

VB Scripting

sional ced
ColumnOrder - - - -
Columns - - - -
ColumnsMoveable - - - -
ColumnTextAckGroup - - - -
ColumnTextAlarmState - - - -
ColumnTextAlarmText - - - -
ColumnTextClassName - - - -
ColumnTextDate - - - -
ColumnTextDevice - - - -
ColumnTextDiagnosa‐ - - - -
ble
ColumnTextNumber - - - -
ColumnTextTime - - - -
ColumnWidth - - - -
ConfiguredAlarmClas‐ - - - -
ses
CornerRadius - - - -
CountOfLinesPerA‐ - - - -
larms
CountOfVisibleAlarms - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Página 672) - RW RW Define si el objeto indicado se podrá manejar en
runtime.
ES2RT_ButtonPositions - - - -
ES2RT_ColumnOrder - - - -
ES2RT_ColumnWidth - - - -
ES2RT_MessageArea‐ - - - -
Height
ES2RT_MessageArea‐ - - - -
Width
FilterTag - - - -
FilterText - - - -
FitToSize - - - -
Flashing - - - -
FocusColor (Pági‐ - RW RW Define el color del borde del foco cuando está resal‐
na 715) tado el objeto correspondiente.
FocusWidth (Pági‐ - RW RW Define el ancho del borde del foco cuando está re‐
na 716) saltado el objeto correspondiente.
ForeColor - - - -
GridLineColor (Pági‐ - RW RW Establece el color de las líneas de cuadrícula.
na 730)
Height - - - -

VB Scripting

sional ced
HorizontalScrollingEna‐ - - - -
bled
IsRunningUnderCE - - - -
Layer (Página 776) - RW RW Dentro de la imagen, define el nivel en el que se
Left (Página 782) - RW RW Define el valor de la coordenada X.
LineAlarmView - - - -
Location - - - -
MessageAreaHeight - - - -
MessageAreaLeft - - - -
MessageAreaTop - - - -
MessageAreaWidth - - - -
Name - - - -
PaddingBottom - - - -
PaddingLeft - - - -
PaddingRight - - - -
PaddingTop - - - -
PreferredUseOnAck - - - -
S7Device - - - -
SecurityForSimpleVie‐ - - - -
wEnabled
SelectionBackColor - RW RW Determina el color de fondo de las celdas seleccio‐
(Página 927) nadas.
SelectionForeColor (Pá‐ - RW RW Determina el color de primer plano de las celdas se‐
gina 929) leccionadas.
SeparateLineForAlarm‐ - - - -
Text
ShowAcknowledgeBut‐ - - - -
ton
ShowAlarmsFromDate - RW RW Establece que sólo se muestren los eventos de avi‐
(Página 939) so que estén guardados en esa variable.
ShowAlarmsToAcknow‐ - - - -
ledge
ShowColumnHeaders - - - -
ShowHelpButton - - - -
ShowHorizontalGridli‐ - - - -
nes
ShowLoopInAlarmBut‐ - - - -
ton
ShowMilliseconds - - - -
ShowPendingAlarms - - - -
Size - - - -
SortByTimeDirection - RW RW Define si el último aviso entrante se muestra arriba
(Página 967) (orden de clasificación ascendente).

VB Scripting

sional ced
SortByTimeEnabled - RW RW Define si puede modificarse la clasificación de los
(Página 968) avisos según la hora.
StyleItem - - - -
SupportsS7Diagnostic‐ - - - -
sInSimpleView
TabIndex - - - -
TableBackColor (Pági‐ - RW RW Define el color de fondo de las celdas de tabla.
na 1001)
TableEvenRowBackCo‐ - - - -
lor
TableFont - - - -
TableForeColor (Pági‐ - RW RW Define el color de fuente de las celdas de tabla del
na 1005) objeto.
TableHeaderBackColor - RW RW Define el color de fondo del encabezado de la tabla.
(Página 1007)
TableHeaderBack‐ - - - -
FillStyle
TableHeaderBorder‐ - - - -
BackColor
TableHeaderBorderCo‐ - - - -
lor
Width
TableHeaderCornerRa‐ - - - -
dius
TableHeaderEdgeStyle - - - -
TableHeaderFirstGra‐ - - - -
dientColor
dientOffset
TableHeaderFont - - - -
TableHeaderForeColor - RW RW Define el color de texto del encabezado de la tabla.
(Página 1009)
TableHeaderMiddleGra‐ - - - -
dientColor
TableHeaderPadding‐ - - - -
Bottom
TableHeaderPaddin‐ - - - -
gLeft
gRight
Top
TableHeaderSecond‐ - - - -
GradientColor

VB Scripting

sional ced
GradientOffset
ToolbarHeight - - - -
ToolbarLeft - - - -
ToolbarTop - - - -
ToolbarWidth - - - -
Top (Página 1099) - RW RW Define el valor de la coordenada Y.
UseButtonFirstGradient - - - -
UseButtonSecondGra‐ - - - -
dient
UseDesignColorSche‐ - - - -
ma
UseTableHeaderFirst‐ - - - -
Gradient
UseTableHeaderSe‐ - - - -
condGradient
VerticalScrollBarEna‐ - - - -
bled
VerticalScrollingEna‐ - - - -
bled
ViewType - - - -
ViewTypeForSaveS‐ - - - -
tream
Visible (Página 1222) - RW RW Define si el objeto indicado será visible.
Width - - - -
Tabla 1-4 Métodos

sional ced
Activate (Página 1268) - Sí Sí Activa el área permanente o la imagen raíz.

VB Scripting
ApplicationWindow (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Ventana de la aplicación". El objeto ApplicationWindow es un elemento

de la lista ScreenItems.

HMIApplicationWindow

R Lectura
- Ningún acceso

sional ced
BorderEnabled (Pági‐ RW - - Define si la ventana se representará con borde en
na 576) runtime.
Bounds - - - -
GSCRuntimeAllowed - - - -
Height (Página 732) RW - - Define la altura.

VB Scripting

sional ced
Left (Página 782) RW - - Define el valor de la coordenada X.
Location - - - -
Name - - - -
ShowCaption (Pági‐ RW - - Define si se muestra la barra de título.
na 941)
Size - - - -
TabIndex - - - -
Template (Página 1014) RW - - Define la plantilla para mostrar el contenido de la
ventana del objeto "Trabajo de impresión/diagnósti‐
co de script".
Top (Página 1099) - - - -
WindowCloseEnabled RW - - Determina si puede cerrarse una ventana en runti‐
(Página 1238) me.
WindowMaximizeEna‐ RW - - Define si el objeto se puede maximizar en runtime.
bled (Página 1238)
WindowMovingEnabled RW - - Define si el objeto se puede desplazar en runtime.
(Página 1239)
WindowOnTop (Pági‐ RW - - Define si el objeto permanece siempre en primer
na 1239) plano en runtime.
WindowsContents (Pá‐ RW - - Define el contenido del trabajo de impresión o del
gina 1240) diagnóstico de script.
WindowSizingEnabled RW - - Define si puede modificarse el tamaño.
(Página 1241)
Tabla 1-6 Métodos

sional ced
jada.

VB Scripting
Bar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Barra". El objeto Bar es un elemento de la lista ScreenItems.

HMIBar

R Lectura
- Ningún acceso

sional ced
AlarmLowerLimit (Pági‐ RW - - Define el valor límite inferior en el que se dispara la
na 514) alarma.
AlarmLowerLimitColor RW - - Define el color de barra para el valor límite "Alarm‐
(Página 515) LowerLimit".
AlarmLowerLimitEna‐ RW - - Determina si se vigila el valor límite "AlarmLowerLi‐
bled (Página 516) mit".
AlarmLowerLimitRelati‐ RW - - Determina si el valor límite inferior con el que se
ve (Página 517) dispara la alarma se evaluará de forma porcentual
o absoluta.

VB Scripting

sional ced
AlarmUpperLimit (Pági‐ RW - - Establece el valor límite superior con el que se dis‐
na 517) parará la alarma.
AlarmUpperLimitColor RW - - Define el color de barra para el valor límite "Alar‐
(Página 518) mUpperLimit".
AlarmUpperLimitEna‐ RW - - Determina si se vigila el valor límite "AlarmUpperLi‐
bled (Página 519) mit".
AlarmUpperLimitRelati‐ RW - - Determina si el valor límite superior con el que se
ve (Página 520) dispara la alarma se evaluará de forma porcentual
o absoluta.
Authorization (Pági‐ RW - - Define los derechos de manejo.
na 528)
AverageLast15Values RW - - Define si se muestra la media de los últimos 15 va‐
(Página 535) lores.
BackColor (Página 537) RW RW RW Define el color de fondo.
BackFillStyle (Pági‐ RW - - Define el patrón de relleno.
na 542)
BackFlashingColorOff RW - - Define el color de fondo para el estado de parpadeo
(Página 544) "Off".
BackFlashingColorOn RW - - Define el color de fondo para el estado de parpadeo
(Página 545) "On".
BackFlashingEnabled RW - - Define si el fondo parpadeará en runtime.
(Página 547)
BackFlashingRate (Pá‐ RW - - Define la frecuencia de parpadeo del fondo.
gina 548)
BarBackColor (Pági‐ RW RW RW Define el color del fondo de barra en el objeto indi‐
na 551) cado.
BarBackFillStyle (Pági‐ RW - - Define el patrón de relleno de la barra.
na 551)
BarBackFlashingColo‐ - - - -
rOff
BarBackFlashingColo‐ - - - -
rOn
BarBackFlashingEna‐ - - - -
bled
BarBackFlashingRate - - - -
BarEdgeStyle - - - -
BarOrientation (Pági‐ RW - - Define la orientación de la barra.
na 555)
BorderBackColor (Pági‐ RW - - Define el color de fondo de la línea de borde que‐
na 570) brada.
BorderColor (Pági‐ RW - - Define el color de línea.
na 573)
BorderFlashingColorOff RW - - Define el color de la línea de borde para el estado
(Página 577) de parpadeo "Off".
BorderFlashingColorOn RW - - Define el color de la línea de borde para el estado
(Página 579) de parpadeo "On".

VB Scripting

sional ced
BorderFlashingEnabled RW - - Define si el límite del objeto puede parpadear en
(Página 581) runtime.
BorderFlashingRate RW - - Define la frecuencia de parpadeo de la línea de bor‐
(Página 582) de.
BorderStyle (Pági‐ RW - - Define el tipo de líneas de borde.
na 587)
na 589)
BorderWidth3D - - - -
Bounds - - - -
ColorChangeHysteresis RW - - Determina la histéresis de forma porcentual al valor
(Página 613) de visualización.
ColorChangeHysteresi‐ RW - - Determina si se muestra el objeto con histéresis.
sEnabled (Página 613)
CompatibilityMode - - - -
CornerStyle (Pági‐ RW - - Define la forma de las esquinas del objeto indicado.
na 647)
CountDivisions (Pági‐ RW - - Determina el número de segmentos en los que se
na 649) subdivide la barra mediante las marcas grandes de
la escala.
CountSubDivisions (Pá‐ - RW RW Define el número de marcas de la escala entre dos
gina 649) marcas principales.
DeviceStyle - - - -
DrawInsideFrame (Pági‐ RW - - Define si la línea del borde del objeto indicado se
na 667) trazará dentro del borde o simétricamente respecto
al borde a partir de un grosor de línea superior a 1.
EdgeStyle (Página 669) RW - - Establece el estilo de línea del objeto indicado.
Enabled (Página 672) RW RW RW Define si el objeto indicado se podrá manejar en
runtime.
FillPatternColor (Pági‐ RW - - Establece el color del patrón de relleno del objeto
na 697) indicado.
Flashing - - - -
FlashingColorOff - - - -
FlashingColorOn - - - -
FlashingEnabled - - - -
FlashingOnLimitViola‐ - - - -
tion
FlashingRate - - - -
Font - - - -
FontBold (Página 720) RW - - Define si el texto del objeto indicado se mostrará en
negrita.
FontName (Página 722) RW - - Establece la fuente del objeto indicado.
FontSize (Página 723) RW - - Establece el tamaño de fuente del texto del objeto
indicado.

VB Scripting

sional ced
ForeColor (Página 724) RW RW RW Establece el color de fuente del texto del objeto in‐
dicado.
ForeColorTransparency - - - -
InnerHeight - - - -
InnerWidth - - - -
IntegerDigits (Pági‐ RW - - Define el número de dígitos antes de la coma (de 0
na 760) a 20).
LargeTickLabelingStep R - - Devuelve qué secciones de la escala se titulan.
(Página 772)
LargeTicksBold (Pági‐ RW - - Determina si las marcas largas de una escala se
na 773) muestran en negrita.
LargeTicksSize (Pági‐ RW - - Define la longitud de las marcas largas de una es‐
na 773) cala.
Layer (Página 776) RW RW RW Dentro de la imagen, define el nivel en el que se
Left (Página 782) RW RW RW Define el valor de la coordenada X del objeto indi‐
cado.
Limit4LowerLimit (Pági‐ RW - - Establece el valor límite inferior para "Reserve4".
na 788)
Limit4LowerLimitColor RW - - Define el color del valor límite inferior "Reserve4".
(Página 788)
Limit4LowerLimitEna‐ RW - - Define si se vigilará el valor límite inferior "Reser‐
bled (Página 789) ve4".
Limit4LowerLimitRelati‐ RW - - Define si el valor límite inferior "Reserve4" se eva‐
ve (Página 790) luará de forma porcentual o absoluta.
Limit4UpperLimit (Pági‐ RW - - Define el valor límite superior para "Reserve4".
na 790)
Limit4UpperLimitColor RW - - Define el color del valor límite superior "Reserve4".
(Página 791)
Limit4UpperLimitEna‐ RW - - Determina si se vigilará el valor límite superior "Re‐
bled (Página 792) serve4".
Limit4UpperLimitRelati‐ RW - - Determina si el valor límite superior "Reserve4" se
ve (Página 793) evaluará de forma porcentual o absoluta.
Limit5LowerLimit (Pági‐ RW - - Establece el valor límite inferior para "Reserve5".
na 793)
Limit5LowerLimitColor RW - - Define el color del valor límite inferior "Reserve5".
(Página 794)
Limit5LowerLimitEna‐ RW - - Define si se vigilará el valor límite inferior "Reser‐
bled (Página 795) ve5".
Limit5LowerLimitRelati‐ RW - - Define si el valor límite inferior "Reserve5" se eva‐
ve (Página 795) luará de forma porcentual o absoluta.
Limit5UpperLimit (Pági‐ RW - - Define el valor límite superior para "Reserve5".
na 796)
Limit5UpperLimitColor RW - - Define el color del valor límite superior "Reserve5".
(Página 796)

VB Scripting

sional ced
Limit5UpperLimitEna‐ RW - - Determina si se vigilará el valor límite superior "Re‐
bled (Página 797) serve5".
Limit5UpperLimitRelati‐ RW - - Determina si el valor límite superior "Reserve5" se
ve (Página 798) evaluará de forma porcentual o absoluta.
LimitRangeCollection - - - -
LineEndShapeStyle RW - - Define la forma de los finales de línea.
(Página 800)
Location - - - -
MaximumValue (Pági‐ RW RW RW Define el valor máximo de la escala en el objeto
na 811) indicado.
MinimumValue (Pági‐ RW RW RW Define el valor mínimo de la escala en el objeto in‐
na 834) dicado.
Name - - - -
Precision (Página 884) RW - - Define el número de decimales (de 0 a 20).
ProcessValue (Pági‐ RW RW RW Determina el ajuste predeterminado para el valor
na 886) que debe mostrarse.
ScaleColor (Pági‐ RW RW RW Define el color de la escala del objeto indicado.
na 905)
ScaleGradation (Pági‐ RW RW RW Define la distancia entre dos marcas grandes de la
na 907) escala.
ScaleLabelFieldLength - - - -
ScaleLabelingDoubleLi‐ - - - -
ned
ScalePosition (Pági‐ RW - - Define la posición de la escala del objeto indicado.
na 909)
ScaleStart - - - -
ScalingType (Pági‐ RW - - Establece el tipo de escala de barras.
na 912)
SegmentColoring (Pági‐ RW RW RW Define el tipo de cambio de color con el que se in‐
na 917) dicará el rebase por exceso de valores límite.
ShowBadTagState (Pá‐ RW - - Define si el objeto se mostrará atenuado cuando el
gina 940) QualityCode o el estado de la variable no sea bueno.
ShowLargeTicksOnly RW - - Define si han representarán solo las marcas gran‐
(Página 949) des de la escala.
ShowLimitLines - - - -
ShowLimitMarkers (Pá‐ RW - - Determina si los valores límite se mostrarán como
gina 950) valores de escala.
ShowLimitRanges - - - -
ShowProcessValue - - - -
ShowScale (Pági‐ RW - - Determina si los valores se mostrarán adicional‐
na 954) mente en una escala.
ShowSignForPositive‐ - - - -
Label
ShowTickLabels - - - -

VB Scripting

sional ced
ShowTrendIndicator RW - - Determina si la tendencia se mostrará con una pe‐
(Página 964) queña flecha (ascendente o descendente) del valor
medido que se vigila.
Size - - - -
StartValue (Página 972) RW - - Define el valor absoluto del punto cero de la visua‐
lización de la escala.
StyleItem - - - -
TabIndex - - - -
ToleranceLowerLimit RW - - Establece el límite inferior para la tolerancia 1.
(Página 1070)
ToleranceLowerLimit‐ RW - - Define el color para el valor límite inferior "Toleran‐
Color (Página 1070) ceLowerLimit".
ToleranceLowerLimitE‐ RW - - Determina si se vigilará el valor límite "Tolerance‐
nabled (Página 1071) LowerLimit".
ToleranceLowerLimi‐ RW - - Define si el valor límite inferior "ToleranceLowerLi‐
tRelative (Página 1072) mit" se evaluará en porcentaje o de forma absoluta.
ToleranceUpperLimit RW - - Define el límite superior para la tolerancia 1.
(Página 1072)
ToleranceUpperLimit‐ RW - - Define el color para el valor límite superior "Toleran‐
Color (Página 1073) ceUpperLimit".
ToleranceUpperLimitE‐ RW - - Determina si se vigila el valor límite "ToleranceUp‐
nabled (Página 1074) perLimit".
ToleranceUpperLimi‐ RW - - Define si el valor límite superior "ToleranceUpperLi‐
tRelative (Página 1074) mit" se evaluará en porcentaje o de forma absoluta.
ToolTipText (Pági‐ RW RW RW Define el texto del tooltip.
na 1098)
Top (Página 1099) RW RW RW Define el valor de la coordenada Y del objeto indi‐
cado.
Transparency (Pági‐ RW - - Define la transparencia del objeto en forma de por‐
na 1103) centaje.
TrendIndicatorColor RW - - Define el color del visor de tendencias.
(Página 1117)
Unit (Página 1159) RW - - Define la unidad de medida.
UseAutoScaling - - - -
UseDesignColorSche‐ RW - - Define si los colores definidos en el esquema cro‐
ma (Página 1165) mático global del diseño actual se utilizarán para
este objeto.
UseDesignShadowSet‐ RW - - Define si el objeto se representará con el sombrea‐
tings (Página 1167) do global.
UseExponentialFormat RW - - Determina si se mostrarán los números con expo‐
(Página 1169) nentes (p. ej.,"1,00e+000").
Visible (Página 1222) RW RW RW Define si el objeto indicado será visible.
WarningLowerLimit (Pá‐ RW - - Determina el valor límite inferior "WarningLowerLi‐
gina 1227) mit".
WarningLowerLimitCo‐ RW - - Define el color para el valor límite inferior "Warnin‐
lor (Página 1228) gLowerLimit".

VB Scripting

sional ced
WarningLowerLimitEna‐ RW - - Determina si se vigila el valor límite "WarningLower‐
bled (Página 1228) Limit".
WarningLowerLimitRe‐ RW - - Define si el valor límite inferior "WarningLowerLimit"
lative (Página 1229) se evaluará en porcentaje o de forma absoluta.
WarningUpperLimit (Pá‐ RW - - Determina el límite de advertencia superior.
gina 1232)
WarningUpperLimitCo‐ RW R R Define el color para el valor límite superior "Warnin‐
lor (Página 1233) gUpperLimit".
WarningUpperLimitEna‐ RW R R Define si se vigila el valor límite superior.
bled (Página 1233)
WarningUpperLimitRe‐ RW RW RW Define si el valor límite superior "WarningUpperLi‐
lative (Página 1234) mit" se evaluará en porcentaje o de forma absoluta.
ZeroPoint (Pági‐ RW RW RW Determina la posición del punto cero de forma por‐
na 1266) centual respecto a la altura de barra.
Tabla 1-8 Métodos

sional ced
Activate (Página 1268) Sí Sí Sí Activa el área permanente o la imagen raíz.
jada.

VB Scripting
BatteryView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Estado de carga". El objeto BatteryView es un elemento de la lista

ScreenItems.

HMIBatteryView

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
Height - - - -
Layer (Página 776) - - RW Dentro de la imagen, define el nivel en el que se
Left (Página 782) - - RW Define el valor de la coordenada X.

VB Scripting

sional ced
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Top (Página 1099) - - RW Define el valor de la coordenada Y.
Visible (Página 1222) - - RW Define si el objeto indicado será visible.
Width - - - -
Tabla 1-10 Métodos

sional ced
Activate (Página 1268) - - Sí Activa el área permanente o la imagen raíz.
Consulte también
Height (Página 732)
Width (Página 1234)
Button (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Botón". El objeto Button es un elemento de la lista ScreenItems.

La disponibilidad de las siguientes propiedades de objeto dependen del modo seleccionado
en el "botón":
Propiedad Modo "Texto" Modo "Lista de textos" Modo "Gráfico"

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

HMIButton

R Lectura
- Ningún acceso

sional ced
AdaptBorder (Pági‐ RW - - Determina si el borde del objeto se adaptará de ma‐
na 509) nera dinámica al tamaño del texto.
Authorization (Pági‐ RW RW RW Define los derechos de manejo del objeto indicado
na 528) en runtime.
BackColor (Página 537) RW RW RW Define el color de fondo del objeto indicado.
BackFillStyle (Pági‐ RW - - Define el patrón de relleno del objeto indicado.
na 542)
(Página 545) "On".
BackFlashingEnabled RW - - Determina si el fondo del objeto indicado parpadea‐
(Página 547) rá en runtime.
BackFlashingRate (Pá‐ RW - - Determina la frecuencia de parpadeo del fondo del
gina 548) objeto indicado.
BitNumber - - - -
na 570) brada del objeto indicado.
BorderBrightColor3D RW - - Determina el color de las siguientes partes del borde
(Página 572) para la representación en 3D del objeto indicado:
Partes exteriores del borde superior e inferior; par‐
tes interiores del borde inferior y derecha
BorderColor (Pági‐ RW - - Determina el color de línea del objeto.
na 573)

VB Scripting

sional ced
BorderFlashingColorOff RW - - Define el color de la línea de borde del objeto indi‐
(Página 577) cado para el estado de parpadeo "Off".
BorderFlashingColorOn RW - - Define el color de la línea de borde del objeto indi‐
(Página 579) cado para el estado de parpadeo "On".
BorderFlashingEnabled RW - - Determina si la línea de borde del objeto indicado
(Página 581) parpadeará en runtime.
BorderFlashingRate RW - - Determina la frecuencia de parpadeo de la línea de
(Página 582) borde del objeto indicado.
BorderShadeColor3D RW - - Determina el color de las siguientes partes del borde
Partes interiores del borde superior e inferior; partes
exteriores del borde inferior y derecha
BorderStyle (Pági‐ RW - - Determina el tipo de líneas de borde del objeto indi‐
na 587) cado.
na 589)
BorderWidth3D (Pági‐ RW - - Define el ancho del borde interior en una represen‐
na 591) tación tridimensional del objeto indicado.
na 647)
DeviceStyle - - - -
runtime.
ES2RT_StoreAsCheck‐ - - - -
Back
FillingDirection (Pági‐ RW - - Define la dirección de llenado.
na 700)
na 697) indicado.
FirstGradientColor - - - -
FirstGradientOffset - - - -
FitToLargest - - - -
Flashing - - - -
FlashingColorOff (Pági‐ RW - - Define el color de la línea de borde del objeto indi‐
na 706) cado para el estado de parpadeo "Off".
FlashingColorOn (Pági‐ RW - - Define el color de la línea de borde del objeto indi‐
na 708) cado para el estado de parpadeo "On".
FlashingEnabled (Pági‐ RW - - Determina si la línea de borde del objeto indicado
na 710) parpadeará en runtime.
FlashingRate (Pági‐ RW - - Determina la frecuencia de parpadeo de la línea de
na 712) borde del objeto indicado.

VB Scripting

sional ced
FocusColor (Pági‐ - RW RW Determina el color del borde del objeto indicado
na 715) cuando está resaltado dicho objeto.
FocusWidth (Pági‐ - RW RW Determina el ancho del borde del objeto indicado
Font - - - -
negrita.
FontItalic (Página 721) RW - - Determina si el texto del objeto indicado se mostrará
en cursiva.
indicado.
FontUnderline (Pági‐ RW - - Determina si el texto del objeto indicado se mostrará
na 724) subrayado.
dicado.
HelpText (Página 736) - RW RW Devuelve el tooltip que se visualiza en runtime como
ayuda de manejo del objeto indicado.
HorizontalAlignment RW RW RW Determina la alineación horizontal del texto dentro
(Página 748) del objeto indicado.
HorizontalPictureAlign‐ - - - -
ment
Hotkey - - - -
cado.
(Página 800)
Location - - - -
MiddleGradientColor - - - -
Mode (Página 836) RW - - Determina el tipo de campo del objeto indicado.
Name - - - -
PictureAlignment (Pági‐ RW - - Define el modo de representación de la imagen de
na 877) fondo en el sinóptico de proceso.
PictureAreaBottomMar‐ - - - -
gin
PictureAreaLeftMargin - - - -
PictureAreaRightMargin - - - -
PictureAreaTopMargin - - - -
PictureAutoSizing - - - -
PictureList - - - -
PictureOff (Página 879) RW - - Define el gráfico que se mostrará en el estado "Off".
PictureOn (Página 879) RW - - Establece la imagen que se muestra en el estado
"On".

VB Scripting

sional ced
Pressed (Página 885) RW - - Determina si el objeto indicado se mostrará pulsado.
ProcessValue (Pági‐ RW - - Determina el ajuste predeterminado para el valor
RelativeFillLevel (Pági‐ RW - - Determina el porcentaje de relleno del objeto.
na 893)
SecondGradientColor - - - -
SecondGradientOffset - - - -
ShowFillLevel (Pági‐ RW - - Define si se rellenará el objeto indicado.
na 948)
Size - - - -
StyleItem - - - -
StyleSettings (Pági‐ RW - - Define el estilo en el que se mostrará el objeto.
na 996)
TabIndex - - - -
TextAreaBottomMargin - - - -
TextAreaLeftMargin - - - -
TextAreaRightMargin - - - -
TextAreaTopMargin - - - -
TextList - - - -
TextOff (Página 1017) RW RW RW Determina el texto que se muestra con el estado
"Off" del objeto indicado.
TextOn (Página 1018) - RW RW Determina el texto que se muestra con el estado
"On" del objeto indicado.
TextOrientation (Pági‐ RW - - Establece la dirección del texto del objeto indicado.
na 1018)
Toggle (Página 1068) RW - - Determina si el objeto indicado en runtime quedará
enclavado tras ser accionado.
na 1098)
cado.
na 1103) centaje.
TransparentColorPictu‐ RW - - Determina qué color del objeto de mapa de bits asig‐
reOff (Página 1106) nado se pondrá en "transparente" para el estado
"Off".
TransparentColorPictu‐ RW - - Determina qué color del objeto de mapa de bits asig‐
reOn (Página 1107) nado se pondrá en "transparente" para el estado
"On".
ma (Página 1165) mático global del diseño actual se utilizarán para es‐
te objeto.
UseDesignShadowSet‐ RW - - Define si el objeto se representará con el sombreado
tings (Página 1167) fijado en el diseño activo.
UseFirstGradient - - - -

VB Scripting

sional ced
UseSecondGradient - - - -
UseTransparentColor‐ RW - - Determina si se utilizará el color transparente defini‐
PictureOff (Pági‐ do con la propiedad "TransparentColorPictureOff"
na 1177) para el estado "Off".
UseTransparentColor‐ RW - - Determina si se utilizará el color transparente defini‐
PictureOn (Pági‐ do con la propiedad "TransparentColorPictureOn"
na 1178) para el estado "On".
UseTwoHandOperation - - - -
VerticalAlignment (Pági‐ RW RW RW Determina la alineación vertical del texto dentro del
na 1217) objeto indicado.
VerticalPictureAlign‐ - - - -
ment
WindowsStyle (Pági‐ RW - - Determina si el objeto se mostrará en el estilo gene‐
na 1241) ral de Windows.
Tabla 1-12 Métodos

sional ced
jada.

VB Scripting
CameraControl (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de cámara". El objeto CameraControl es un elemento de la lista

ScreenItems.

HMICameraControl

R Lectura
- Ningún acceso
Propiedades RT Pro‐ RT Ad‐ Panel RT Descripción

fessional vanced
AllTagTypesAllo‐ - - - -
wed
Bounds - - - -
CameraUrl - - - -
Height - - - -

VB Scripting

fessional vanced
Layer (Página 776) - - RW Dentro de la imagen, define el nivel en el
que se encuentra un objeto.
Left (Página 782) - - R Devuelve el valor de la coordenada X.
Location - - - -
MaintainAspectRa‐ - - - -
tio
MaintainOriginalSi‐ - - - -
ze
Name - - - -
Size - - - -
TabIndex - - - -
Top (Página 1099) - - R Devuelve el valor de la coordenada Y.
UseUdp - - - -
Visible (Pági‐ - - R Devuelve si el objeto indicado es visible.
na 1222)
Width - - - -
Tabla 1-14 Métodos

sional ced

VB Scripting
ChannelDiagnose (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de diagnóstico de canal". El objeto ChannelDiagnose es un

elemento de la lista ScreenItems.

HMIChannelDiagnose

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
runtime.

VB Scripting

sional ced
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Top (Página 1099) RW - - Define el valor de la coordenada Y.
Tabla 1-16 Métodos

sional ced
jada.
CheckBox (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Casilla de verificación". El objeto CheckBox es un elemento de la lista

ScreenItems.

HMICheckBox

R Lectura
- Ningún acceso

sional ced
na 528)
BackColor (Página 537) RW - - Define el color de fondo.
na 542)
(Página 545) "On".
(Página 547)
gina 548)
na 570) brada.
na 573)
(Página 582) de.
na 587)

VB Scripting

sional ced
BorderWidth (Pági‐ RW - - Define el grosor de línea.
na 589)
Bounds - - - -
CheckMarkAlignment RW - - Define si los campos se disponen justificados a la
(Página 608) derecha.
CheckMarkCount (Pági‐ RW - - Determina el número de campos.
na 609)
CornerStyle (Pági‐ RW - - Define la forma de las esquinas.
na 647)
DrawInsideFrame (Pági‐ RW - - Define si la línea de borde se traza dentro del borde
na 667) o simétricamente respecto al borde a partir de un
grosor de línea superior a 1.
EdgeStyle (Página 669) RW - - Define el estilo de línea.
runtime.
na 700)
FillPatternColor (Pági‐ RW - - Define el color del patrón de relleno.
na 697)
Flashing - - - -
FlashingColorOff (Pági‐ RW - - Define el color de la línea de borde para el estado
na 706) de parpadeo "Off".
FlashingColorOn (Pági‐ RW - - Define el color de la línea de borde para el estado
na 708) de parpadeo "On".
FlashingEnabled (Pági‐ RW - - Define si se activa el parpadeo del objeto en runtime.
na 710)
FlashingRate (Pági‐ RW - - Define la frecuencia de parpadeo de la línea de bor‐
na 712) de.
Font - - - -
FontBold (Página 720) RW - - Define si el texto se mostrará en negrita.
FontItalic (Página 721) RW - - Define si el texto se muestra en cursiva.
FontName (Página 722) RW - - Define la fuente.
FontSize (Página 723) RW - - Define el tamaño de fuente del texto.
FontUnderline (Pági‐ RW - - Define si el texto se muestra subrayado.
na 724)
ForeColor (Página 724) RW - - Define el color de fuente del texto.
HorizontalAlignment RW - - Define la alineación horizontal del texto.
(Página 748)
Index (Página 753) RW - - Define el índice del campo de texto seleccionado.
(Página 800)

VB Scripting

sional ced
Location - - - -
LogOperation (Pági‐ RW - - Define si se emitirá un aviso al sistema de avisos
na 806) tras utilizarse este objeto.
Name - - - -
na 893)
na 948)
Size - - - -
TabIndex - - - -
Text (Página 1015) RW - - Define el título del campo de texto.
TextHandles - - - -
TextOrientation (Pági‐ RW - - Define la dirección del texto.
na 1018)
Texts - - - -
ToolTipText (Pági‐ RW - - Define el texto del tooltip.
na 1098)
na 1103) centaje.
te objeto.
tings (Página 1167) global.
VerticalAlignment (Pági‐ RW - - Determina la alineación vertical del texto en el objeto
na 1217) indicado.
Tabla 1-18 Métodos

sional ced
jada.

VB Scripting
Circle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Círculo". El objeto Circle es un elemento de la lista ScreenItems.

HMICircle

R Lectura
- Ningún acceso

sional ced
Authorization (Pági‐ RW - - Determina los derechos de manejo en runtime.
na 528)
BackFillStyle (Pági‐ RW RW RW Define el patrón de relleno.
na 542)
na 570) brada.

VB Scripting

sional ced
BorderColor (Pági‐ RW RW RW Define el color de línea.
na 573)
(Página 582) de.
na 587)
BorderWidth (Pági‐ RW RW RW Define el grosor de línea.
na 589)
na 647)
DeviceStyle - - - -
EdgeStyle (Página 669) RW RW RW Define el estilo de línea.
Enabled (Página 672) RW RW RW Define si el objeto se puede manejar en runtime.
na 700)
na 697)
Flashing - - - -
na 710)
na 712) de.
Height (Página 732) RW RW RW Define la altura.
encuentra el objeto.
Left (Página 782) RW RW RW Define el valor de la coordenada X.
(Página 800)
Location - - - -
Name - - - -
Radius (Página 889) RW RW RW Define el radio.
RadiusHeight - - - -

VB Scripting

sional ced
RadiusWidth - - - -
na 893)
ShowFillLevel (Pági‐ RW - - Determina si se rellena el objeto.
na 948)
Size - - - -
StyleItem - - - -
TabIndex - - - -
na 1098)
Top (Página 1099) RW RW RW Define el valor de la coordenada Y.
na 1103) centaje.
te objeto.
Visible (Página 1222) RW RW RW Determina si el objeto será visible.
Width (Página 1234) RW RW RW Define el ancho del objeto en píxeles.
Tabla 1-20 Métodos

sional ced
jada.

VB Scripting
CircleSegment (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Segmento circular". El objeto CircleSegment es un elemento de la lista

ScreenItems.

HMICircleSegment

R Lectura
- Ningún acceso

sional ced
na 528)
na 542)
na 570) brada.

VB Scripting

sional ced
na 573)
(Página 582) de.
na 587)
na 589)
Bounds - - - -
na 647)
runtime.
EndAngle (Página 678) RW - - Define el ángulo en el que se desvía del origen (0°)
el punto final.
na 700)
na 697)
Flashing - - - -
na 710)
na 712) de.
(Página 800)
Location - - - -

VB Scripting

sional ced
Name - - - -
Radius (Página 889) RW - - Define el radio.
na 893)
na 948)
Size - - - -
StartAngle (Página 970) RW - - Define el ángulo en el que se desvía del origen (0°)
el punto inicial.
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.
Tabla 1-22 Métodos

sional ced
jada.

VB Scripting
CircularArc (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Arco circular". El objeto CircularArc es un elemento de la lista

ScreenItems.

HMICircularArc

R Lectura
- Ningún acceso

sional ced
na 528)
na 587)
Bounds - - - -

VB Scripting

sional ced
Color (Página 611) RW - - Define el color de línea.
na 647)
runtime.
el punto final.
Flashing - - - -
na 710)
na 712) de.
(Página 800)
LineWidth (Página 802) RW - - Define el grosor de línea.
Location - - - -
Name - - - -
Radius (Página 889) RW - - Define el radio.
Size - - - -
el punto inicial.
Style (Página 995) RW - - Define el estilo de línea.
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

VB Scripting

sional ced
Tabla 1-24 Métodos

sional ced
jada.
Clock (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Reloj". El objeto Clock es un elemento de la lista ScreenItems.

VB Scripting

Clock

R Lectura
- Ningún acceso

sional ced
Analog (Página 522) RW - - Determina si el reloj se visualizará en forma de reloj
analógico.
na 542)
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
DeviceStyle - - - -
DialColor (Página 661) RW RW RW Define el color de la esfera del objeto indicado.
EdgeStyle - - - -
runtime.
Flashing (Página 704) RW - - Define si el objeto indicado parpadeará en runtime.
HourNeedleHeight (Pá‐ RW RW RW Define la longitud de la aguja horaria en el objeto
gina 751) "Clock".
HourNeedleWidth (Pági‐ RW RW RW Define el ancho de la aguja horaria en el objeto
na 752) "Clock".
Left (Página 782) RW RW RW Define el valor de la coordenada X del objeto.
Location - - - -
LockSquaredExtent RW - - Define si el tamaño del reloj puede ajustarse con el
(Página 805) ratón.
MinuteNeedleHeight RW RW RW Define la longitud del minutero en el objeto "Clock".
(Página 835)
MinuteNeedleWidth RW RW RW Define el ancho del minutero en el objeto "Clock".
(Página 836)

VB Scripting

sional ced
Name RW - - Define el nombre del objeto.
NeedleBorderColor (Pá‐ RW RW RW Define el color de línea de las agujas en el objeto
gina 844) "Clock".
NeedleColor (Pági‐ RW RW RW Define el color de las agujas en el objeto "Clock".
na 844)
NeedleFillStyle (Pági‐ RW - - Define si los punteros deben mostrarse opacos o
na 845) transparentes.
NumberStyle - - - -
Picture (Página 876) RW - - Define la imagen que se muestra en el objeto gráfico
en runtime.
SecondNeedleHeight RW RW RW Define la longitud del segundero en el objeto
(Página 916) "Clock".
SecondNeedleWidth RW RW RW Define el ancho del segundero en el objeto "Clock".
(Página 916)
ShowFocusRectangle RW - - Determina si el botón tendrá un borde de selección
(Página 948) en runtime cuando se active.
ShowTicks (Pági‐ RW RW RW Determina si se mostrarán las marcas en la escala
na 961) del objeto indicado.
Size - - - -
StyleItem - - - -
TabIndex - - - -
TickDistance - - - -
TicksColor (Pági‐ RW RW RW Define el color de las marcas horarias en la esfera
na 1022) del objeto "Clock".
TickStyle - - - -
cado.
na 1103) centaje.
te objeto.

VB Scripting
Tabla 1-26 Métodos

sional ced
jada.
ComboBox (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Casilla de verificación". El objeto ComboBox es un elemento de la lista

ScreenItems.

HMIComboBox

R Lectura
- Ningún acceso

VB Scripting

sional ced
AskOperationMotive RW - - Define si también se registrará la razón de manejo
(Página 526) de este objeto.
na 528)
na 542)
na 570) brada.
na 573)
na 587)
na 589)
Bounds - - - -
na 647)
CountVisibleItems (Pá‐ RW - - Determina cuántas líneas contiene la lista de selec‐
gina 650) ción.
runtime.
Font - - - -
na 724)
(Página 748)

VB Scripting

sional ced
(Página 800)
Location - - - -
Name - - - -
SelectedIndex (Pági‐ RW - - Define el índice cuyo texto se muestra resaltado en
na 921) el cuadro combinado o el cuadro de lista.
SelectedText (Pági‐ RW - - Define el texto para la entrada referenciada median‐
na 924) te "SelectedIndex".
Size - - - -
TabIndex - - - -
TextHandles - - - -
Texts - - - -
na 1098)
na 1103) centaje.
te objeto.
Tabla 1-28 Métodos

sional ced
Activate Sí - - Activa el área permanente o la imagen raíz.
jada.

VB Scripting
Connector (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Conector". El objeto Connector es un elemento de la lista ScreenItems.

HMIConnector

R Lectura
- Ningún acceso

sional ced
na 528)
BorderEndStyle (Pági‐ RW - - Define el tipo de finales de línea.
na 577)
na 587)
Bounds - - - -

VB Scripting

sional ced
ConnectionType (Pági‐ RW - - Define el tipo del conector.
na 643)
na 647)
DeviceStyle - - - -
runtime.
EndStyle (Página 679) RW - - Define la forma con la que se representa el final de
línea.
FirstConnectedObject - - - -
FirstConnectedObjec‐ RW - - Define el número de índice del punto del conector
tIndex (Página 702) superior.
FirstConnectedObject‐ RW - - Define el nombre del objeto que está acoplado en el
Name (Página 702) punto de conexión superior.
Flashing - - - -
na 710)
na 712) de.
LastConnectedObject - - - -
LastConnectedObjec‐ RW - - Define el número de índice del punto de conexión al
tIndex (Página 774) último objeto conectado.
LastConnectedObject‐ RW - - Define el nombre del objeto que está acoplado en el
Name (Página 774) punto de conector inferior.
(Página 800)
Location - - - -
Name - - - -
NoHitTest - - - -
Points - - - -
PointsCount - - - -
Size - - - -
StartStyle (Página 971) RW - - Define cómo se debe representar el comienzo de
línea.

VB Scripting

sional ced
SwapFirstWithLastCon‐ RW - - Define que la primera conexión y la última se inter‐
nection (Página 997) cambien.
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.
Tabla 1-30 Métodos

sional ced
jada.

VB Scripting
DateTimeField (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo de fecha y hora". El objeto DateTimeField es un elemento de

la lista ScreenItems.

HMIDateTimeField

R Lectura
- Ningún acceso

sional ced
Authorization (Pági‐ - RW RW Define los derechos de manejo.
na 528)
BackColor (Página 537) - RW RW Define el color de fondo.
BackFillStyle - - - -
BorderColor (Pági‐ - RW RW Define el color de línea.
na 573)

VB Scripting

sional ced
BorderWidth - - - -
BottomMargin - - - -
Bounds - - - -
DeviceStyle - - - -
DisplayCentury - - - -
DisplaySystemTime - - - -
EdgeStyle - - - -
runtime.
Flashing - - - -
Font - - - -
ForeColor (Página 724) - RW RW Define el color de fuente del texto.
Format - - - -
Height - - - -
HelpText (Página 736) - RW RW Define el tooltip que se visualiza en runtime como
HorizontalAlignment - RW RW Define la alineación horizontal del texto.
(Página 748)
LeftMargin - - - -
LineWrap - - - -
Location - - - -
LongDateTimeFormat - - - -
Mode - - - -
Name - - - -
ProcessValue - - - -
RightMargin - - - -
ShowDate - - - -
ShowTime - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TextOrientation - - - -
TimeDisplayMode - - - -
TopMargin - - - -

VB Scripting

sional ced
ma
VerticalAlignment (Pági‐ - RW RW Determina la alineación vertical del texto en el objeto
na 1217) indicado.
Width - - - -
Tabla 1-32 Métodos

sional ced
DiskSpaceView (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de memoria". El objeto DiskSpaceView es un elemento de la lista

ScreenItems.

VB Scripting

IXDiskSpaceView

R Lectura
- Ningún acceso

sional ced
Alarm - - - -
AlarmColor - - - -
Bounds - - - -
Drive - - - -
runtime.
Free - - - -
FreePercent (Pági‐ R - - Devuelve los valores medidos para el espacio de
na 728) memoria libre en porcentaje.
Interval (Página 761) R - - Devuelve el intervalo de tiempo para la actualización
de los valores medidos mostrados.
Location - - - -
Name (Página 839) R - - Devuelve el nombre.
NormalColor (Pági‐ R - - Devuelve el color de la memoria ocupada en el visor
na 846) de memoria cuando la utilización del espacio de me‐
moria se encuentra dentro del rango no crítico.
Size - - - -
TabIndex (Página 999) R - - Devuelve el lugar que ocupará el objeto en la se‐
cuencia cuando se pase de objeto en objeto con la
tecla del tabulador.
TabIndexAlpha (Pági‐ R - - Devuelve el lugar que ocupará el objeto en la se‐
na 999) cuencia cuando se pase de objeto en objeto con la
tecla del tabulador en el modo de cursor alfa.
Tolerance (Pági‐ R - - Devuelve el límite para el visor de memoria a partir
na 1068) del cual se notifica una desviación.
ToleranceColor (Pági‐ R - - Devuelve los colores en los que se representa la
na 1069) barra del visor de memoria en cuanto se rebasa por
exceso el rango de tolerancia.
Total (Página 1102) R - - Devuelve la capacidad de memoria.

VB Scripting

sional ced
Used (Página 1164) R - - Devuelve el tamaño de la memoria ocupada.
UsedPercent (Pági‐ R - - Devuelve los valores medidos para el espacio de
na 1169) memoria ocupado en porcentaje.
Warning (Página 1226) R - - Devuelve a partir de qué porcentaje de memoria
ocupada se emite una advertencia.
WarningColor (Pági‐ R - - Devuelve el color en el que se representa la barra
na 1226) del visor de memoria en cuanto se alcanza el rango
de advertencia.
Tabla 1-33 Métodos

sional ced
jada.
Ellipse (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Elipse". El objeto Ellipse es un elemento de la lista ScreenItems.

HMIEllipse

R Lectura
- Ningún acceso

sional ced
Authorization (Pági‐ RW - - Define los derechos de manejo del objeto indicado
na 528) en runtime.
BackFillStyle (Pági‐ RW RW RW Define el patrón de relleno del objeto indicado.
na 542)
na 570) brada del objeto indicado
BorderColor (Pági‐ RW RW RW Define el color de línea del objeto indicado.
na 573)
na 587) cado.
BorderWidth (Pági‐ RW RW RW Define el grosor de línea del objeto indicado.
na 589)
Bounds - - - -
na 647)
DeviceStyle - - - -

VB Scripting

sional ced
EdgeStyle (Página 669) RW RW RW Establece el estilo de línea del objeto indicado.
runtime.
na 700)
na 697) indicado.
Flashing - - - -
Height (Página 732) RW RW RW Define la altura del objeto indicado.
Left (Página 782) RW RW RW Define el valor de la coordenada X del objeto indica‐
do.
(Página 800)
Location - - - -
Name - - - -
RadiusHeight (Pági‐ RW RW RW Determina el eje menor del objeto indicado.
na 889)
RadiusWidth (Pági‐ RW RW RW Determina el eje mayor del objeto indicado.
na 890)
na 893)
na 948)
Size - - - -
StyleItem - - - -
TabIndex - - - -
na 1098)
Top (Página 1099) RW RW RW Define el valor de la coordenada Y del objeto indica‐
do.
na 1103) centaje.
te objeto.

VB Scripting

sional ced
Tabla 1-35 Métodos
Método RT Profes‐ RT Advan‐ Panel RT Descripción

sional ced
jada.
EllipseSegment (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Segmento elíptico". El objeto EllipseSegment es un elemento de la lista

ScreenItems.

VB Scripting

HMIEllipseSegment

R Lectura
- Ningún acceso

sional ced
na 528)
na 542)
na 570) brada.
na 573)
(Página 582) de.
na 587)
na 589)
Bounds - - - -
na 647)
runtime.
el punto final.

VB Scripting

sional ced
na 700)
na 697)
Flashing - - - -
na 710)
na 712) de.
(Página 800)
Location - - - -
Name - - - -
RadiusHeight (Pági‐ RW - - Define el eje menor.
na 889)
RadiusWidth (Pági‐ RW - - Define el eje mayor.
na 890)
na 893)
na 948)
Size - - - -
el punto inicial.
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

VB Scripting
Tabla 1-37 Métodos

sional ced
jada.
EllipticalArc (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Arco elíptico". El objeto EllipticalArc es un elemento de la lista

ScreenItems.

HMIEllipticalArc

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
na 587)
Bounds - - - -
na 647)
runtime.
el punto final.
Flashing - - - -
na 710)
na 712) de.
(Página 800)
Location - - - -
Name - - - -
na 889)
na 890)
Size - - - -

VB Scripting

sional ced
el punto inicial.
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.
Tabla 1-39 Métodos

sional ced
jada.

VB Scripting
FunctionTrendControl (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de curvas f(x)". El objeto FunctionTrendControl es un elemento


HMIFunctionTrendControl

R Lectura
- Ningún acceso

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

VB Scripting

sional ced
na 573)
na 589)
Bounds - - - -
Caption (Página 598) RW - - Define el texto que se mostrará en la barra de título.
Closeable (Página 611) RW - -
ConnectTrendWindows RW - - Define si se enlazan los visores de curvas configu‐
(Página 644) rados.
ControlDesignMode RW - - Determina la apariencia del control.
(Página 646)
runtime.
ExportFileExtension RW - - Define la extensión del archivo de exportación.
(Página 688)
gina 690) Provider.
(Página 691)
na 693) rán.
GraphDirection (Pági‐ RW - - Define el borde de la ventana de curvas en el que
na 729) se mostrarán los valores actuales.
Height (Página 732) RW - - -
ventana.

VB Scripting

sional ced
LoadDataImmediately RW - - Determina si los valores de variables para el inter‐
(Página 804) valo de tiempo que se representa se cargan desde
los ficheros al abrir una imagen.
Location - - - -
Moveable (Página 838) RW - - Define si el objeto se puede desplazar en runtime.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
Online (Página 852) RW - - Define el inicio y paro de la actualización.
"Informes".
RTPersistence (Pági‐ RW - - Define si se conservarán las configuraciones online
na 901) tras cambiar de imagen.
ShowRuler (Página 953) RW - - Determina si se muestra una escala graduada (línea
auxiliar) para la rotulación de eje del objeto "Online‐
TrendControl".
ShowRulerInAxis (Pági‐ RW - - Define si la regla se mostrará también en el eje de
na 953) tiempos.
ShowScrollbars (Pági‐ RW - - Define si se muestran las barras de desplazamiento.
na 955)
ShowTitle (Página 962) RW - - Define el estilo del marco de la ventana y el título de
la ventana para el objeto.
ShowTrendIcon (Pági‐ RW - - Determina si debajo de los ejes de valores se mos‐
na 963) trará un símbolo.
Size - - - -
runtime.
(Página 973)
StatusbarElementAuto‐ RW - - Define si el ancho de un elemento de la barra de
Size (Página 975) estado referenciado mediante "StatusbarElementIn‐
dex" se ajustará automáticamente.
StatusbarElement‐ RW - - Define el número de elementos configurados de la
Count (Página 976) barra de estado.
StatusbarElementIco‐ RW - - Hace referencia a un elemento de la barra de estado
nId (Página 977) mediante su ID de icono.
StatusbarElementID RW - - Hace referencia a un elemento de la barra de estado
(Página 978) mediante su ID de elemento.

VB Scripting

sional ced
StatusbarElementIndex RW - - Hace referencia a un elemento de la barra de estado.
(Página 979)
StatusbarElementNa‐ RW - - Define el nombre de un elemento de la barra de es‐
me (Página 980) tado referenciado mediante "StatusbarElementIn‐
dex".
StatusbarElementRe‐ RW - - Elimina el elemento de la barra de estado definido
move (Página 980) por el usuario y referenciado mediante su nombre.
StatusbarElementRena‐ RW - - Define el nuevo nombre de un elemento de la barra
me (Página 981) de estado definido por el usuario y referenciado me‐
diante "StatusbarElementIndex".
StatusbarElementRe‐ RW - - Define la posición de un elemento referenciado me‐
pos (Página 982) diante "StatusbarElementIndex" en la barra de esta‐
do del objeto.
StatusbarElementText RW - - Define el texto de un elemento de la barra de estado
(Página 983) definido por el usuario y referenciado mediante "Sta‐
tusbarElementIndex".
StatusbarElementTool‐ RW - - Define el texto del tooltip de un elemento de la barra
tipText (Página 984) de estado definido por el usuario y referenciado me‐
StatusbarElementUser‐ RW - - Define si un elemento de la barra de estado referen‐
Defined (Página 985) ciado mediante "StatusbarElementIndex" ha sido
agregado por el ingeniero como nuevo elemento de‐
StatusbarElementVisi‐ RW - - Define si el elemento de la barra de estado referen‐
ble (Página 986) ciado mediante "StatusbarElementIndex" se mostra‐
rá en el objeto.
StatusbarElementWidth RW - - Define el ancho de un elemento de la barra de esta‐
(Página 987) do referenciado mediante "StatusbarElementIndex"
en píxeles.
na 987)
gina 988) estado.
na 990)
na 992) control.
SupportsUserDefined‐ - - - -
ToolbarButtons
TabIndex - - - -

VB Scripting

sional ced
na 1075)
gina 1076)
ToolbarButtonAuthori‐ RW - - Define el permiso para la función de tecla seleccio‐
zation (Página 1079) nada.
gina 1081)
ToolbarButtonCount RW - - Define el número de botones configurados que con‐
(Página 1081) tiene la barra de herramientas.
ToolbarButtonHotKey RW - - Define el método abreviado de teclado para el botón
(Página 1083) seleccionado del objeto.
ToolbarButtonID (Pági‐ RW - - Hace referencia a un botón mediante su ID.
na 1084)
ToolbarButtonIndex RW - - Hace referencia a un botón.
(Página 1085)
ToolbarButtonLocked RW - - Define si se mostrará el estado pulsado (enclavado)
(Página 1086) de un botón definido por el usuario referenciado me‐
diante "ToolbarButtonIndex".
ToolbarButtonName RW - - Define el nombre de un botón definido por el usuario
(Página 1087) y referenciado mediante "ToolbarButtonIndex".
ToolbarButtonRemove RW - - Elimina un botón definido por el usuario y referen‐
(Página 1088) ciado mediante su nombre.
ToolbarButtonRename RW - - Define el nuevo nombre de un botón definido por el
(Página 1088) usuario y referenciado mediante "ToolbarButtonIn‐
dex".
ToolbarButtonRepos RW - - Define la posición de un botón referenciado median‐
(Página 1089) te "ToolbarButtonIndex" en la barra de herramientas
del objeto.
por el usuario.
ToolbarButtonVisible RW - - Define si se mostrará el botón referenciado median‐
(Página 1092) te "ToolbarButtonIndex" en la barra de herramientas.

VB Scripting

sional ced
ToolbarUseHotKeys RW - - Define si las teclas de acceso rápido para los boto‐
(Página 1096) nes de la barra de herramientas están activadas.
Top (Página 1099) - R R Devuelve el valor de la coordenada Y.
TrendActualize (Pági‐ RW - - Define si se actualizará la curva seleccionada.
na 1108)
TrendAdd (Pági‐ RW - - Crea una curva nueva.
na 1108)
TrendBeginTime (Pági‐ RW - - Define el inicio del rango de tiempo para el suminis‐
na 1112) tro de datos de la curva seleccionada.
TrendColor (Pági‐ RW - - Define el color de la línea de una curva referenciada
na 1112) del visor de curvas.
TrendCount (Pági‐ RW - - Determina el número de curvas configuradas.
na 1113)
TrendEndTime (Pági‐ RW - - Define el fin del rango de tiempo para la conexión
na 1114) de datos de la curva seleccionada.
TrendExtendedColor‐ RW - - Define si se mostrarán el color de punto y el color
Set (Página 1114) de relleno de la curva.
TrendFill (Página 1115) RW - - Define si se debe mostrar rellena la superficie deba‐
jo de la curva.
TrendFillColor (Pági‐ RW - - Define el color de relleno de la curva.
na 1116)
TrendIndex (Pági‐ RW - - Hace referencia a una curva configurada.
na 1117)
TrendLabel (Pági‐ RW - - Define el texto con el que se titulará la curva refe‐
na 1118) renciada mediante "TrendIndex".
TrendLineStyle (Pági‐ RW - - Define qué tipo de línea se utilizará para la repre‐
na 1119) sentación de la curva.
TrendLineType (Pági‐ RW - - Define cómo se mostrará la curva.
na 1119)
TrendLineWidth (Pági‐ RW - - Define el grosor de línea en píxeles de la curva se‐
na 1120) leccionada.
TrendLowerLimit (Pági‐ RW - - Indica el límite inferior de una variable que se visua‐
na 1121) liza como curva en el objeto.
TrendLowerLimitColor RW - - Define el color que marcará los valores de curva que
(Página 1121) se encuentren por debajo del valor de "TrendLower‐
Limit".
TrendLowerLimitColo‐ RW - - Establece si se utilizará "TrendLowerLimitColor" pa‐
ring (Página 1122) ra marcar los valores de variable que se encuentren
por debajo del valor "TrendLowerLimit".
TrendMeasurePoints RW - - Define el número de puntos de medida que se utili‐
(Página 1123) zará para representar la curva seleccionada.
TrendName (Pági‐ RW - - Define el nombre de una curva referenciada median‐
na 1123) te "TrendIndex".

VB Scripting

sional ced
TrendPointColor (Pági‐ RW - - Define el color de los puntos de la curva referencia‐
na 1124) da.
TrendPointStyle (Pági‐ RW - - Define cómo se mostrarán los puntos en la curva.
na 1125)
TrendPointWidth (Pági‐ RW - - Determina el ancho de punto en píxeles.
na 1125)
TrendProvider (Pági‐ RW - - Define el suministro de datos de la curva seleccio‐
na 1126) nada.
TrendProviderCLSID RW - - Define la CLSID de proveedor para los datos de una
(Página 1127) curva.
TrendRangeType (Pági‐ RW - - Define el rango de tiempo en el que se suministrarán
na 1127) datos a la curva seleccionada.
TrendRemove (Pági‐ RW - - Elimina una curva referenciada mediante su nombre.
na 1128)
TrendRename (Pági‐ RW - - Define el nombre nuevo de una curva referenciada
na 1129) mediante "TrendIndex".
TrendRepos (Pági‐ RW - - Define la posición de una curva referenciada me‐
na 1129) diante "TrendIndex" en la ventana de curvas del ob‐
jeto.
Trends - - - -
TrendSelectTagNameX RW - - Define que en runtime se muestre primero el cuadro
(Página 1131) de diálogo para seleccionar el nombre de variable
del origen de los datos del eje X.
TrendSelectTagNameY RW - - Define que en runtime se muestre primero el cuadro
(Página 1131) de diálogo para seleccionar el nombre de variable
del origen de los datos del eje Y.
TrendTagNameX (Pági‐ RW - - Define el nombre de la variable HMI o columna aso‐
na 1132) ciada para el eje X.
TrendTagNameY (Pági‐ RW - - Define el nombre de las variable HMI o columna
na 1133) asociada para el eje Y.
TrendTimeRangeBase RW - - Define la unidad de tiempo para determinar rango
(Página 1134) de tiempo.
TrendTimeRangeFac‐ RW - - Establece el factor que determina el intervalo de
tor (Página 1135) tiempo del que se visualizará la curva referenciada.
TrendTrendWindow RW - - Define en qué ventana de curvas se mostrará la cur‐
(Página 1135) va seleccionada.
TrendUncertainColor RW - - Define el color de los valores con estado inseguro.
(Página 1136)
TrendUncertainColo‐ RW - - Define que se resalten los valores con estado inse‐
ring (Página 1137) guro.
TrendUpperLimit (Pági‐ RW - - Define el límite superior de una variable que se re‐
na 1137) presenta como curva en un objeto dado.
TrendUpperLimitColor RW - - Define el color que marcará los valores de curva que
(Página 1138) se encuentren por encima del valor de "TrendUpper‐
Limit".
TrendUpperLimitColo‐ RW - - Define si el borde de selección se representará en
ring (Página 1139) el color definido por el sistema.

VB Scripting

sional ced
TrendVisible (Pági‐ RW - - Define si se mostrará la curva referenciada median‐
na 1141) te "TrendIndex" en el objeto.
TrendWindowAdd (Pá‐ RW - - Crea un nuevo visor de curvas.
gina 1141)
TrendWindowCoarse‐ RW - - Define si se mostrarán las líneas de cuadrícula y la
Grid (Página 1142) escala principal.
TrendWindowCoarse‐ RW - - Define el color de la cuadrícula principal para el dia‐
GridColor (Página 1143) grama referenciado en el objeto.
TrendWindowCount RW - - Define el número de diagramas de curva configura‐
(Página 1143) dos en el visor de curvas.
TrendWindowFineGrid RW - - Define si se mostrarán las líneas de cuadrícula de
(Página 1144) la escala auxiliar.
TrendWindowFineGrid‐ RW - - Define el color de la cuadrícula auxiliar para el dia‐
Color (Página 1145) grama referenciado en el objeto.
TrendWindowFore‐ RW - - Define si se mostrarán solamente las líneas de cua‐
groundTrendGrid (Pági‐ drícula para la curva de primer plano de la ventana
na 1145) de curvas seleccionada.
TrendWindowGridIn‐ RW - - Define si se mostrarán las líneas de cuadrícula de
TrendColor (Pági‐ la escala principal en el color de la curva.
na 1146)
TrendWindowHorizon‐ RW - - Determina si se mostrarán las líneas de cuadrícula
talGrid (Página 1147) horizontales.
TrendWindowIndex (Pá‐ RW - - Hace referencia a un visor de curvas.
gina 1147)
TrendWindowName RW - - Define el nombre de un visor de curvas referenciado
(Página 1148) mediante "TrendWindowIndex".
TrendWindowRemove RW - - Elimina un visor de curvas referenciado mediante su
(Página 1149) nombre.
TrendWindowRename RW - - Define el nombre nuevo de un visor de curvas refe‐
(Página 1149) renciado mediante "TrendWindowIndex".
TrendWindowRepos RW - - Define la posición de un visor de curvas referenciado
TrendWindowRulerCo‐ RW - - Define el color de la regla.
lor (Página 1150)
TrendWindowRulerLa‐ RW - - Define el nivel de representación de la regla en el
yer (Página 1151) visor de curvas.
TrendWindowRulerSty‐ RW - - Define la representación de la regla.
le (Página 1152)
TrendWindowRuler‐ RW - - Define en píxeles el grosor de la regla.
TrendWindows - - - -
TrendWindowSpace‐ RW - - Define la proporción del área del diagrama referen‐
Portion (Página 1153) ciado en el área de diagramas del objeto.
TrendWindowVertical‐ RW - - Define si se mostrarán las líneas de cuadrícula ver‐
Grid (Página 1156) ticales.
TrendWindowVisible RW - - Define si se muestra el visor de curvas referenciado

VB Scripting

sional ced
TrendXAxis (Pági‐ RW - - Determina qué eje X se utilizará para la curva refe‐
na 1157) renciada.
TrendYAxis (Pági‐ RW - - Determina qué eje Y se utilizará para la curva refe‐
na 1158) renciada.
UseTrendNameAsLa‐ RW - - Define si las propiedades "Nombre" o "Rotulación"
bel (Página 1178) se utilizarán como nombre de la curva en runtime.
Visible (Página 1222) - R R Devuelve si el objeto indicado es visible.
XAxes - - - -
XAxisAdd (Página 1243) RW - - Crea un nuevo eje X.
XAxisAlignment (Pági‐ RW - - Define la alineación del eje X referenciado mediante
na 1243) "XAxisIndex".
XAxisAutoPrecisions RW - - Define si se determinará automáticamente el núme‐
(Página 1244) ro de decimales de un eje X referenciado mediante
"XAxisIndex".
XAxisAutoRange (Pági‐ RW - - Define si se determinará automáticamente el rango
na 1245) de valores de un eje X referenciado mediante "XA‐
xisIndex".
XAxisBeginValue (Pági‐ RW - - Define el punto inferior del rango de valores de un
na 1245) eje X referenciado mediante "XAxisIndex".
XAxisColor (Pági‐ RW - - Define el color de un eje X referenciado mediante
XAxisCount (Pági‐ RW - - Define el número de ejes X configurados.
na 1247)
XAxisEndValue (Pági‐ RW - - Define el punto superior del rango de valores de un
XAxisExponentialFor‐ RW - - Determina si los valores de un eje X referenciado
mat (Página 1248) mediante "XAxisIndex" se mostrarán en representa‐
ción exponencial.
XAxisIndex (Pági‐ RW - - Hace referencia a un eje X.
na 1248)
XAxisInTrendColor (Pá‐ RW - - Define si el color del eje referenciado mediante "XA‐
gina 1249) xisIndex" debe corresponderse con el color de la
curva.
XAxisLabel (Pági‐ RW - - Define el texto con el que se titulará un eje X refe‐
na 1250) renciado mediante "XAxisIndex".
XAxisName (Pági‐ RW - - Define el nombre de un eje X referenciado mediante
XAxisPrecisions (Pági‐ RW - - Define con cuántos decimales se mostrarán los va‐
na 1251) lores de un eje X referenciado mediante "XAxisIn‐
dex".
XAxisRemove (Pági‐ RW - - Elimina un eje X referenciado mediante su nombre.
na 1251)
XAxisRename (Pági‐ RW - - Define el nombre nuevo de un eje X referenciado
na 1252) mediante "XAxisIndex".
XAxisRepos (Pági‐ RW - - En el caso de varios ejes X, define la posición de un

VB Scripting

sional ced
XAxisScalingType (Pá‐ RW - - Define el tipo de escala del eje X referenciado me‐
gina 1253) diante "XAxisIndex".
XAxisTrendWindow RW - - Define el diagrama de curvas en el que se mostrará
(Página 1254) el eje referenciado mediante "XAxisIndex".
XAxisVisible (Pági‐ RW - - Define si se mostrará el eje X referenciado mediante
na 1254) "XAxisIndex" en el objeto.
YAxes - - - -
YAxisAdd (Página 1255) RW - - Crea un nuevo eje Y.
YAxisAlignment (Pági‐ RW - - Define la alineación del eje Y referenciado mediante
na 1255) "YAxisIndex".
YAxisAutoPrecisions RW - - Define si se determinará automáticamente el núme‐
(Página 1256) ro de decimales de un eje Y referenciado mediante
"YAxisIndex".
YAxisAutoRange (Pági‐ RW - - Define si se determinará automáticamente el rango
na 1257) de valores de un eje Y referenciado mediante "YA‐
xisIndex".
YAxisBeginValue (Pági‐ RW - - Determina el punto inferior del rango de valores de
na 1257) un eje Y referenciado mediante "YAxisIndex".
YAxisColor (Pági‐ RW - - Define el color de un eje Y referenciado mediante
YAxisCount (Pági‐ RW - - Define el número de ejes Y configurados.
na 1259)
YAxisEndValue (Pági‐ RW - - Define el extremo superior del rango de valores de
na 1259) un eje Y referenciado mediante "YAxisIndex".
YAxisExponentialFor‐ RW - - Determina si los valores de un eje Y referenciado
mat (Página 1260) mediante "YAxisIndex" se mostrarán en representa‐
ción exponencial.
YAxisIndex (Pági‐ RW - - Hace referencia a un eje Y.
na 1260)
YAxisInTrendColor (Pá‐ RW - - Define si el color del eje referenciado mediante "YA‐
gina 1261) xisIndex" debe corresponderse con el color de la
curva.
YAxisLabel (Pági‐ RW - - Define el texto con el que se titulará un eje Y refe‐
na 1261) renciado mediante "YAxisIndex".
YAxisName (Pági‐ RW - - Define el nombre de un eje Y referenciado mediante
YAxisPrecisions (Pági‐ RW - - Define con cuántos decimales se mostrarán los va‐
na 1263) lores de un eje Y referenciado mediante "YAxisIn‐
dex".
YAxisRemove (Pági‐ RW - - Elimina un eje Y referenciado mediante su nombre.
na 1263)
YAxisRename (Pági‐ RW - - Define el nombre nuevo de un eje Y referenciado
na 1264) mediante "YAxisIndex".
YAxisRepos (Pági‐ RW R R En el caso de varios ejes Y, define la posición de un
na 1264) eje Y referenciado mediante "YAxisIndex".
YAxisScalingType (Pá‐ RW R R Define el tipo de escala del eje Y referenciado me‐
gina 1265) diante "YAxisIndex".

VB Scripting

sional ced
YAxisTrendWindow RW R R Define el diagrama de curvas en el que se mostrará
(Página 1265) el eje referenciado mediante "YAxisIndex".
YAxisVisible (Pági‐ RW R R Define si se mostrará el eje Y referenciado mediante
na 1266) "YAxisIndex" en el objeto.
Tabla 1-41 Métodos

sional ced
AttachDB (Pági‐ Sí - - Ejecuta la función de tecla "Conectar copia de segu‐
na 1274) ridad" del control.
jada.
GetStatusbarElement Sí - - Devuelve el elemento designado por nombre o índi‐
(Página 1307) ce de la barra de estado del control como tipo "IC‐
na 1308) tion".
"ICCAxCollection".
GetTrend (Pági‐ Sí - - Devuelve la curva designada por nombre o índice
na 1318) del visor de curvas f(t) o f(x) como tipo "ICCAxTrend"
o "ICCAxFunctionTrend".
GetTrendCollection (Pá‐ Sí - - Devuelve el listado de todas las curvas del visor de
gina 1319) curvas f(t) o f(x) como tipo "ICCAxCollection".
GetTrendWindow (Pági‐ Sí - - Devuelve el objeto de ventana de curvas designado
na 1320) por nombre o índice del visor de curvas f(t) o f(x)
como tipo "ICCAxTrendWindow".
GetTrendWindowCo‐ Sí - - Devuelve el listado de todos los objetos de ventana
llection (Página 1321) de curvas del visor de curvas f(t) o f(x) como tipo
"ICCAxCollection".
GetXAxis (Página 1328) Sí - - Devuelve el objeto de eje X designado por nombre
o índice del visor de curvas f(x) como tipo "ICCAx‐
ValueAxis".

VB Scripting

sional ced
GetXAxisCollection (Pá‐ Sí - - Devuelve el listado de todos los objetos de eje X del
gina 1329) visor de curvas f(x) como tipo "ICCAxCollection".
GetYAxis (Página 1330) Sí - - Devuelve el objeto de eje Y designado por nombre
o índice del visor de curvas f(x) como tipo "ICCAx‐
ValueAxis".
GetYAxisCollection (Pá‐ Sí - - Devuelve el listado de todos los objetos de eje Y del
gina 1331) visor de curvas f(x) del tipo "ICCAxCollection".
MoveAxis (Pági‐ Sí - - Ejecuta la función del botón "Desplazar área del eje"
na 1336) de los visores de curvas f(t) y f(x).
NextTrend (Pági‐ Sí - - Ejecuta la función del botón "Siguiente curva" de los
na 1343) visores de curvas f(t) y f(x).
OneToOneView (Pági‐ Sí - - Ejecuta la función del botón "Vista original" de los
PreviousTrend (Pági‐ Sí - - Ejecuta la función del botón "Curva anterior" de los
na 1367)
ShowTagSelection (Pá‐ Sí - - Ejecuta la función del botón "Seleccionar conexión
gina 1375) de datos" del control.
ShowTimeSelection Sí - - Ejecuta la función del botón "Rango de tiempo Se‐
(Página 1376) leccionar" del control.
ShowTrendSelection Sí - - Ejecuta la función del botón "Seleccionar curvas" de
(Página 1377) los visores de curvas f(t) y f(x).
StartStopUpdate (Pági‐ Sí - - Ejecuta la función del botón "Iniciar" o "Detener" del
na 1377) control.
ZoomArea (Pági‐ Sí - - Ejecuta la función del botón "Ampliar sección" de los
ZoomInOut (Pági‐ Sí - - Ejecuta la función del botón "Zoom +/-" de los viso‐
na 1385) res de curvas f(t) y f(x).
ZoomInOutX (Pági‐ Sí - - Ejecuta la función del botón "Zoom eje X +/-" del
na 1387) visor de curvas f(x).
ZoomInOutY (Pági‐ Sí - - Ejecuta la función del botón "Zoom eje Y +/-" del
na 1387) visor de curvas f(x).
ZoomMove Sí - - Ejecuta la función del botón "Desplazar área de cur‐
va" de los visores de curvas f(t) y f(x).

VB Scripting
Gauge (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Indicador (gauge)". El objeto Gauge es un elemento de la lista

ScreenItems.

HMIGauge

R Lectura
- Ningún acceso

sional ced
AngleMax (Página 522) RW RW RW Determina el ángulo para el fondo de escala en el
objeto "Gauge".
AngleMin (Página 523) RW RW RW Determina el ángulo para el inicio de escala en el
objeto "Gauge".
na 542)

VB Scripting

sional ced
BackPicture (Pági‐ RW - - Define el gráfico del fondo.
na 549)
BackStyle (Página 550) RW - - Determina el estilo del fondo.
BorderColor - - - -
BorderInnerStyle3D RW - - Define el modo de representación de la parte interior
(Página 583) del borde del objeto.
BorderOuterStyle3D RW - - Define el modo de representación de la parte exte‐
(Página 585) rior del borde del objeto.
na 589)
BorderWidth3D (Pági‐ RW - - Define el ancho del borde interior en una represen‐
na 591) tación tridimensional.
Bounds - - - -
CaptionColor (Pági‐ - RW RW Define el color del texto que visualizará en la barra
na 600) de título.
CaptionFont (Pági‐ RW - - Define el juego de caracteres para la rotulación.
na 601)
CaptionText (Pági‐ RW RW RW Define el texto que se mostrará en la barra de título.
na 602)
CaptionTop (Pági‐ RW - - Define la distancia del título de los instrumentos res‐
na 602) pecto al borde superior del objeto.
CenterColor (Pági‐ RW RW RW Determina el color del punto central.
na 606)
CenterSize (Pági‐ RW - - Define el diámetro del centro de la escala.
na 607)
DangerRangeColor (Pá‐ RW RW RW Define el color del rango de peligro en la escala del
gina 652) objeto "Gauge".
DangerRangeStart (Pá‐ RW RW RW Define a partir de qué valor de la escala comienza
gina 653) el rango de peligro del objeto "Gauge".
DangerRangeVisible RW RW RW Determina si debe mostrarse el rango de peligro en
(Página 654) la escala del objeto "Gauge".
DeviceStyle - - - -
DialColor (Página 661) RW RW RW Define el color de la esfera del objeto indicado.
DialFillStyle (Pági‐ RW - - Determina el tipo de fondo.
na 662)
DialPicture (Pági‐ RW - - Define un gráfico para la esfera.
na 662)
DialSize (Página 663) RW - - Determina el diámetro de la escala circular con res‐
pecto al valor más pequeño de los atributos geomé‐
tricos "Width" y "Height".
EdgeStyle (Página 669) - - - -

VB Scripting

sional ced
runtime.
Flashing (Página 704) RW - - Define si el objeto indicado parpadeará en runtime.
Gradation (Página 728) RW RW RW Determina la diferencia de valor entre dos marcas
principales del objeto "Gauge".
InnerDialColor - - - -
InnerDialInnerDistance - - - -
InnerDialOuterDistane - - - -
Location - - - -
LockSquaredExtent RW - - Define si el tamaño del reloj puede ajustarse con el
(Página 805) ratón.
MaximumValue (Pági‐ RW RW RW Define el valor máximo de la escala en el objeto in‐
na 811) dicado.
na 834) dicado.
Name (Página 839) RW - - Define el nombre del objeto.
NeedleHeight - - - -
NormalRangeColor (Pá‐ RW RW RW Determina el color del rango normal en la escala del
gina 847) objeto "Gauge".
NormalRangeVisible RW RW RW Determina si se mostrará el rango normal en la es‐
(Página 847) cala del objeto "Gauge".
PointerColor (Pági‐ RW RW RW Define el color del puntero del objeto "Gauge".
na 882)
ScaleLabelColor (Pági‐ RW RW RW Define el color de rotulación en la gradación de la
na 907) escala del objeto "Gauge".
ScaleLabelFont (Pági‐ RW - - Define la fuente de la rotulación de la escala.
na 908)
ScaleTickColor (Pági‐ RW RW RW Define el color de la gradación de la escala del ob‐
na 910) jeto "Gauge".
ScaleTickLabelPosition RW - - Define el diámetro del círculo imaginario en el que
(Página 910) se encuentra la rotulación de las divisiones de la
escala.
ScaleTickLength (Pági‐ RW - - Determina la longitud de las divisiones principales
na 911) de la escala.
ScaleTickPosition (Pági‐ RW - - Define el diámetro del círculo imaginario en el que
na 912) se encuentran las divisiones de la escala.
ShowDecimalPoint (Pá‐ RW - - Determina si la escala se rotula con números deci‐
gina 943) males (coma decimal y un decimal) o con números
enteros.

VB Scripting

sional ced
ShowInnerDial - - - -
ShowPeakValuePointer RW RW RW Determina si se utiliza un puntero de arrastre para
(Página 951) el objeto indicado.
Size - - - -
StyleItem - - - -
TabIndex - - - -
na 1103) centaje.
UnitColor (Página 1159) RW RW RW Define el color de texto del nombre de la unidad de
medida.
UnitFont (Página 1160) RW - - Determina la fuente de la unidad de medida.
UnitText (Página 1160) RW RW RW Define el texto para la unidad de medida.
UnitTop (Página 1161) RW - - Define la distancia de la unidad de medida respecto
del borde superior del objeto.
te objeto.
WarningRangeColor RW RW RW Define el color del rango de advertencia en la escala
(Página 1230) del objeto "Gauge".
WarningRangeStart RW RW RW Determina a partir de qué valor de la escala comien‐
(Página 1231) za el rango de advertencia del objeto "Gauge".
WarningRangeVisible RW RW RW Determina si debe mostrarse el rango de adverten‐
(Página 1231) cia en la escala del objeto "Gauge".
Tabla 1-43 Métodos

sional ced
jada.

VB Scripting
GraphicIOField (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo E/S gráfico". El objeto GraphicIOField es un elemento de la lista

ScreenItems.
La disponibilidad de las siguientes propiedades de objeto depende del modo seleccionado:
Propiedad "Entrada" "Salida" "Entrada/salida" "Dos estados"

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

HMIGraphicIOField

R Lectura
- Ningún acceso

VB Scripting

sional ced
AboveUpperLimitColor - - - -
AdaptPicture - - - -
Authorization (Pági‐ RW RW RW Define los derechos de manejo.
na 528)
AutoSizing - - - -
BelowLowerLimitColor - - - -
BitNumber - - - -
na 570) brada.
na 573)
BorderFlashingRate - - - -
na 587)
na 589)
Bounds - - - -
na 647)
runtime.
Flashing - - - -
na 710)
tion

VB Scripting

sional ced
na 712) de.
FlashTransparentColor RW - - Define el color del objeto de mapa de bits de una
(Página 714) imagen intermitente que se ajustará a "transparen‐
te".
IsImageMiddleAligned - - - -
(Página 800)
Location - - - -
Mode - - - -
Name - - - -
OnValue - - - -
PictureList - - - -
PictureOff (Página 879) RW - - Define el gráfico que se mostrará en el estado "Off".
PictureOn (Página 879) RW - - Define el gráfico que se mostrará en el estado "On".
PictureRotation - - - -
ScrollBarOrientation - - - -
ShowScrollBar - - - -
Size - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
TransparentColor (Pági‐ RW RW RW Define qué color del gráfico asignado (*.bmp, *.dib)
na 1105) se ajustará a "transparente".
UseFlashTransparent‐ RW - - Determina si el color del objeto de mapa de bits de
Color (Página 1170) una imagen intermitente se ajustará a "transparen‐
te".

VB Scripting

sional ced
UseTransparentColor RW RW RW Define si el color definido con la propiedad "Trans‐
(Página 1176) parentColor" debe verse transparente.
Tabla 1-45 Métodos

sional ced
jada.
GraphicView (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de gráficos". El objeto GraphicView es un elemento de la lista

ScreenItems.

VB Scripting

HMIGraphicView

R Lectura
- Ningún acceso

sional ced
AdaptPicture - - - -
na 528)
AutoSizing - - - -
na 542)
(Página 545) "On".
(Página 547)
gina 548)
na 570) brada.
na 573)
(Página 582) de.
na 587)
na 589)
Bounds - - - -

VB Scripting

sional ced
na 647)
Enabled (Página 672) RW RW RW Define si el objeto se puede manejar en runtime.
na 700)
na 697)
Flashing - - - -
IsImageMiddleAligned - - - -
(Página 800)
Location - - - -
Name - - - -
Picture (Página 876) RW - - Define la imagen de la colección de gráficos de
WinCC que se mostrará en el objeto en runtime.
PictureRotation - - - -
na 893)
ShowFillLevel (Pági‐ RW - - Determina si se rellena el objeto.
na 948)
Size - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
TransparentColor (Pági‐ RW RW RW Define qué color del gráfico asignado (*.bmp, *.dib)
na 1105) se ajustará a "transparente".
te objeto.
UseTransparentColor RW RW RW Define si el color definido con la propiedad "Trans‐
(Página 1176) parentColor" debe verse transparente.

VB Scripting

sional ced
Tabla 1-47 Métodos

sional ced
jada.
HTMLBrowser (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Navegador HTML". El objeto HTMLBrowser es un elemento de la lista

ScreenItems.

VB Scripting

HMIHTMLBrowser

R Lectura
- Ningún acceso

sional ced
Address (Página 512) RW RW RW Determina la dirección web que se abrirá en el na‐
vegador HTML.
AddressEnabled - - - -
Bounds - - - -
BrowserTypeUsed - - - -
runtime.
Flashing - - - -
Location - - - -
Name - - - -
ShowStatusBar (Pági‐ RW - - Determina si se muestra la barra de estado.
na 958)
ShowToolBar - - - -
Size - - - -
TabIndex - - - -

VB Scripting
Tabla 1-49 Métodos

sional ced
jada.
SetHtml (Página 1363) Sí - - Escribe un código HTML en el área de representa‐
ción del navegador HTML.
Consulte también
SetHTML (Página 1363)
IOField (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo E/S". El objeto IOField es un elemento de la lista ScreenItems.

VB Scripting

HMIIOField

R Lectura
- Ningún acceso

sional ced
AboveUpperLimitColor RW - - Define el color del objeto indicado para el caso "Re‐
(Página 501) base por exceso del límite superior".
AcceptOnExit (Pági‐ RW - - Define si el campo de entrada se confirmará auto‐
na 502) máticamente al salir de él.
AcceptOnFull (Pági‐ RW - - Define si se sale automáticamente del campo de
na 503) entrada con confirmación una vez que se ha intro‐
ducido un número determinado de valores.
na 528) en runtime.
na 542)
(Página 545) "On".
BelowLowerLimitColor RW - - Define el color para el caso "Rebase por defecto del
(Página 557) límite inferior".
BorderColor - - - -

VB Scripting

sional ced
na 587) cado.
na 589)
ClearOnError (Pági‐ RW - - Determina si se borrará automáticamente una en‐
na 610) trada errónea en este objeto.
ClearOnFocus (Pági‐ RW - - Determina si la entrada del campo se borrará en
na 610) cuanto se active el campo E/S.
na 647)
CursorControl (Pági‐ RW - - Define si el puntero del ratón saltará al siguiente
na 651) campo de la secuencia de tabulación tras salir del
campo.
DataFormat (Pági‐ RW - - Define el formato de visualización de un campo E/S.
na 654)
DeviceStyle - - - -
EditOnFocus (Pági‐ RW - - Determina si la entrada de datos será posible de
na 671) inmediato cuando se seleccione el campo de entra‐
da con la tecla <Tab>.
runtime.
FieldLength - - - -
na 697) indicado.
Flashing - - - -
tion
Font - - - -

VB Scripting

sional ced
negrita.
en cursiva.
indicado.
na 724) subrayado.
dicado.
FormatPattern (Pági‐ RW - - Determina el formato del valor de salida.
na 726)
HiddenInput (Pági‐ RW - - Determina si se mostrará el valor mientras se intro‐
na 737) duzca o bien un * por cada carácter.
HorizontalAlignment RW RW RW Determina la orientación horizontal del texto dentro
(Página 748) del objeto indicado
InputValue (Pági‐ RW - - Define el valor de entrada.
na 759)
cado.
LeftMargin - - - -
(Página 800)
LineWrap - - - -
Location - - - -
LowerLimit (Pági‐ RW - - Establece el valor límite inferior para valores de en‐
na 808) trada.
Mode (Página 836) RW - - Determina el tipo de campo del objeto indicado.
Name - - - -
RightMargin - - - -
ShiftDecimalPoint - - - -
ShowLeadingZeros - - - -
Size - - - -
StyleItem - - - -

VB Scripting

sional ced
TabIndex - - - -
TextOrientation (Pági‐ RW - - Establece la dirección del texto del objeto indicado.
na 1018)
na 1098)
Top (Página 1099) RW RW RW Define el valor de la coordenada Y del objeto.
TopMargin - - - -
na 1103) centaje.
Unit (Página 1159) RW - - Define la unidad de medida.
UpperLimit (Pági‐ RW - - Establece el valor límite superior para valores de
na 1162) entrada.
te objeto.
UseTagLimitColors (Pá‐ RW - - Determina si el rebase por exceso o por defecto de
gina 1176) los valores límite configurados para el objeto se re‐
saltará en color.
UseTwoHandOperation - R R Devuelve si el mando a dos manos está activado.
(Página 1179)
VerticalAlignment (Pági‐ RW RW RW Determina la alineación vertical del texto en el objeto
na 1217) indicado.
Tabla 1-51 Métodos

sional ced
jada.
Consulte también
BorderColor (Página 573)

VB Scripting
1.5.4.3 Objetos K-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
Line (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Línea". El objeto Line es un elemento de la lista ScreenItems.

HMILine

R Lectura
- Ningún acceso

sional ced
ActualPointIndex - - - -
ActualPointLeft - - - -
ActualPointTop - - - -

VB Scripting

sional ced
na 528) en runtime.
BorderEndStyle (Pági‐ RW - - Determina el tipo de finales de línea del objeto indi‐
na 577) cado.
na 587) cado.
Bounds - - - -
Color (Página 611) RW RW RW Define el color de línea del objeto indicado.
na 647)
DeviceStyle - - - -
runtime.
EndLeft - - - -
EndStyle (Página 679) RW RW RW Determina cómo se debe representar el final de lí‐
nea del objeto indicado.
EndTop - - - -
FillStyle (Página 699) - RW RW Define el patrón de relleno del objeto indicado.
Flashing - - - -
do.
LineEndShapeStyle RW - - Determina la forma del final de línea.
(Página 800)
LineWidth (Página 802) RW RW RW Define el grosor de línea del objeto indicado.
Location - - - -
Name - - - -
Points - - - -
PointsCount - - - -
RotationAngle (Pági‐ RW - - Define el ángulo de rotación en grados.
na 895)
RotationCenterLeft (Pá‐ RW - - Define la coordenada X del punto en torno al que
gina 896) gira el objeto en runtime.

VB Scripting

sional ced
RotationCenterTop (Pá‐ RW - - Define la coordenada Y del punto de giro en torno
gina 897) al que gira el objeto en runtime.
Size - - - -
StartLeft - - - -
StartStyle (Página 971) RW RW RW Determina cómo se debe representar el comienzo
de línea del objeto indicado.
StartTop - - - -
Style (Página 995) RW RW RW Establece el estilo de línea del objeto indicado.
StyleItem - - - -
TabIndex - - - -
na 1098)
Top (Página 1099) RW RW RW Define el valor de la coordenada Y del objeto indica‐
do.
na 1103) centaje.
te objeto.
Tabla 1-53 Métodos

sional ced
jada.

VB Scripting
Listbox (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Cuadro de lista". El objeto Listbox forma parte de la lista ScreenItems.

HMIListBox
Utilización
En el siguiente ejemplo, el objeto denominado "ListBox1" se desplazará 10 píxeles hacia la
derecha:
'VBS21
Dim objListBox
Set objListBox = ScreenItems("ListBox1")
objListBox.Left = objListBox.Left + 10

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
na 542)
na 570) brada.
na 573)
na 587)
na 589)
Bounds - - - -
na 647)
gina 650) ción.
runtime.
Font - - - -
na 724)
(Página 748)

VB Scripting

sional ced
(Página 800)
Location - - - -
Name - - - -
SelectedIndex (Pági‐ RW - - Define el índice cuyo texto se muestra resaltado en
na 921) el cuadro combinado o el cuadro de lista.
SelectedText (Pági‐ RW - - Define el texto de la entrada referenciada mediante
na 924) "SelectedIndex".
Size - - - -
TabIndex - - - -
TextHandles - - - -
Texts - - - -
na 1098)
na 1103) centaje.
te objeto.
Tabla 1-54 Métodos

sional ced
jada.

VB Scripting
MediaPlayer (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Media Player". El objeto MediaPlayer es un elemento de la lista

ScreenItems.

HMIMediaPlayer
Utilización
En el siguiente ejemplo, el objeto denominado "Control1" se desplazará 16 píxeles hacia la
derecha:
'VBS60
Dim objControl

R Lectura
- Ningún acceso

VB Scripting

sional ced
AspectRatio (Pági‐ RW - - Define si debe mantenerse la relación de aspecto
na 526) del Media Player en caso de cambiarse el tamaño.
AutoStart - - - -
Bounds - - - -
runtime.
FileName (Página 695) RW - - Define el nombre del archivo que se cargará.
Location - - - -
Name - - - -
PictureSizeMode (Pági‐ RW - - Define la adaptación de tamaño entre el Media Pla‐
na 880) yer y los contenidos que van a representarse.
PlayCount - - - -
PlayEndless (Pági‐ RW - - Define que el archivo de medios se reproduzca sin
na 881) fin.
PopupMenuEnabled - - - -
ShowControls (Pági‐ RW - - Determina que se muestre una barra de herramien‐
na 942) tas.
ShowFeatureBackward RW - - Define que se muestre el botón "Atrás" en runtime.
(Página 944)
ShowFeatureForward RW - - Define que se muestre el botón "Adelante" en runti‐
(Página 945) me.
ShowFeatureFullS‐ RW - - Define que el Media Player pueda cambiarse al mo‐
creen (Página 945) do de pantalla completa.
ShowFeatureFullVolu‐ - - - -
me
ShowFeaturePause RW - - Define que se muestre el botón "Pausa" en runtime.
(Página 946)
ShowFeaturePlay (Pági‐ RW - - Define que se muestre el botón "Reproducir" en run‐
na 946) time.
ShowFeatureStop (Pá‐ RW - - Define que se muestre el botón "Detener" en runti‐
gina 947) me.
ShowStatusBar - - - -
ShowTracker (Pági‐ RW - - Determina que se muestre la barra de tiempo.
na 963)
Size - - - -

VB Scripting

sional ced
StepSeconds (Pági‐ RW - - Crea el intervalo de salto en segundos tras pulsar el
na 994) botón "Adelante" o "Atrás".
TabIndex - - - -
Tabla 1-56 Métodos

sional ced
Activate (Página 1268) Sí - Sí Activa el área permanente o la imagen raíz.
jada.
MultiLineEdit (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo de texto editable". El objeto MultiLineEdit es un elemento de la

lista ScreenItems.

VB Scripting

HMIMultiLineEdit
Utilización
En el siguiente ejemplo, el objeto denominado "MultiLineEdit1" se desplazará 10 píxeles hacia
la derecha:
'VBS21
Dim objMultiLineEdit
Set objMultiLineEdit = ScreenItems("MultiLineEdit1")
objMultiLineEdit.Left = objMultiLineEdit.Left + 10

R Lectura
- Ningún acceso

sional ced
na 528)
na 570) brada.
na 573)
na 587)
na 589)
Bounds - - - -
na 647)
runtime.
Font - - - -

VB Scripting

sional ced
FontName - - - -
na 724)
(Página 748)
(Página 800)
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.
Tabla 1-58 Métodos

sional ced
jada.
GetSelectionText Sí - - -

VB Scripting

sional ced
SetSelection Sí - - -
SetSelectionText Sí - - -
OnlineTableControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de tablas". El objeto OnlineTableControl es un elemento de la lista

ScreenItems.

HMIOnlineTableControl

R Lectura
- Ningún acceso

sional ced
ForDesignMode

VB Scripting

sional ced
radas.
tema.
na 573)
na 589)
Bounds - - - -
Caption - - - -
na 628) nas.
ColumnScrollbar (Pági‐ RW - - Define cuándo se mostrará la barra de desplaza‐
na 629) miento horizontal.
ColumnTitleAlignment RW - - Define la alineación del título en una columna refe‐
(Página 639) renciada mediante "ColumnIndex".
na 640)
(Página 646)
Enabled (Página 672) - - - -
EnableEdit (Página 676) RW - - Determina si se pueden modificar los datos mostra‐
dos en runtime.

VB Scripting

sional ced
(Página 688)
gina 690) Provider.
(Página 691)
na 693) rán.
FillPattern - - - -
na 730)
na 731) ción.
(Página 750)
das de la tabla.
Layer - - - -
ventana.
LineStyle - - - -
Location - - - -
MaximumNumberOfTi‐ - - - -
meColumns
MaximumNumberOfVa‐ - - - -
lueColumns
MinimumNumberOfTi‐ - - - -
meColumns

VB Scripting

sional ced
MinimumNumberOfVa‐ - - - -
lueColumns
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
"Informes".
RowScrollbar (Pági‐ RW - - Define cuándo se mostrará la barra de desplaza‐
na 898) miento vertical.
gina 899)
RowTitles (Página 900) RW - - Define si se mostrarán encabezados de columna
numerados.
gina 919)
(Página 920)
gina 922)
(Página 923)
gina 924) nado.
(Página 925) nado.
SelectionRect (Pági‐ RW - - Determina si se utilizará un borde de selección para
na 929) las celdas o
gina 930) tana de avisos.
pe sea "1".
na 932)

VB Scripting

sional ced
na 956)
na 957)
Size - - - -
runtime.
SortSequence (Pági‐ RW - - Define cómo se modificará el orden de clasificación
na 968) cuando el operador haga clic en el título de la co‐
lumna en runtime.
(Página 973)
(Página 979)
dex".
do del objeto.

VB Scripting

sional ced
rá en el objeto.
en píxeles.
na 987)
gina 988) estado.
na 990)
na 992) control.
TabIndex - - - -
TableColor (Pági‐ RW - - Define el color de fondo de las filas de la tabla del
na 1002) objeto.
TableColor2 (Pági‐ RW - - Define el segundo color de fondo de las filas de la
na 1005) objeto.
TimeColumnActualize RW - - Define si se actualizarán los valores de la columna
(Página 1040) de tiempos referenciada mediante "TimeColumnIn‐
dex".
TimeColumnAdd (Pági‐ RW - - Crea una nueva columna de tiempo.
na 1040)
TimeColumnAlignment RW - - Define cómo se alineará el texto dentro la columna
(Página 1041) de tiempos referenciada mediante "TimeColumnIn‐
dex".
TimeColumnBackColor RW - - Define el color de fondo de la columna de tiempos
(Página 1041) referenciada mediante "TimeColumnIndex".
TimeColumnBeginTime RW - - Define el tiempo de inicio del rango de tiempo para
(Página 1042) la columna de tiempos referenciada mediante "Ti‐
meColumnIndex".

VB Scripting

sional ced
TimeColumnCaption RW - - Define el nombre de la columna de tiempos referen‐
(Página 1043) ciada mediante "TimeColumnIndex".
TimeColumnCount (Pá‐ RW - - Define el número de columnas de tiempo configura‐
gina 1043) das.
TimeColumnDateFor‐ RW - - Define qué formato de fecha se utilizará para visua‐
mat (Página 1044) lizar la columna de tiempos referenciada mediante
"TimeColumnIndex".
TimeColumnEndTime RW - - Define el tiempo de fin del rango de tiempo para una
(Página 1044) columna de tiempos referenciada mediante "Time‐
ColumnIndex".
TimeColumnForeColor RW - - Define el color de fuente de la columna de tiempos
TimeColumnHideText RW - - Define si el contenido de la columna de tiempos re‐
(Página 1046) ferenciada mediante "TimeColumnIndex" se mostra‐
rá en forma de texto.
TimeColumnHideTitle‐ RW - - Define si el título de la columna de tiempos referen‐
Text (Página 1046) ciada mediante "TimeColumnIndex" se mostrará en
forma de texto.
TimeColumnIndex (Pá‐ RW - - Hace referencia a una columna de tiempo configu‐
gina 1047) rada.
TimeColumnLength RW - - Define el ancho de la columna de tiempos referen‐
(Página 1047) ciada mediante "TimeColumnIndex".
TimeColumnMeasure‐ RW - - Define el número de puntos de medida que se mos‐
Points (Página 1048) trarán en la columna de tiempos referenciada me‐
diante "TimeColumnIndex".
TimeColumnName (Pá‐ RW - - Define el nombre de una columna de tiempos refe‐
gina 1048) renciada mediante "TimeColumnIndex".
TimeColumnRangeTy‐ RW - - Define el rango de tiempo que se empleará para una
pe (Página 1049) columna de tiempos referenciada mediante "Time‐
ColumnIndex".
TimeColumnRemove RW - - Elimina una columna de tiempos referenciada me‐
(Página 1050) diante su nombre.
TimeColumnRename RW - - Define el nombre nuevo de una columna de tiempos
TimeColumnRepos (Pá‐ RW - - En el caso de varias columnas de tiempos con las
gina 1051) correspondientes columnas de valores, define la po‐
sición de una columna de tiempos referenciada me‐
diante "TimeColumnIndex".
TimeColumns - - - -
TimeColumnShowDate RW - - Define si se mostrará la columna de tiempos refe‐
(Página 1052) renciada mediante "TimeColumnIndex" con fecha y
hora.
TimeColumnShowIcon RW - - Define si el contenido de la columna de tiempos re‐
(Página 1052) ferenciada mediante "TimeColumnIndex" se mostra‐
rá en forma de símbolo.
TimeColumnShowTitleI‐ RW - - Define si el título de la columna de tiempos referen‐
con (Página 1053) ciada mediante "TimeColumnIndex" se mostrará en
forma de símbolo.

VB Scripting

sional ced
TimeColumnSort (Pági‐ RW - - Define cómo se clasificará una columna de tiempos
na 1053) referenciada mediante "TimeColumnIndex".
TimeColumnSortIndex RW - - Determina la secuencia de clasificación de la colum‐
(Página 1054) na de tiempos referenciada en "TimeColumnIndex".
TimeColumnTimeFor‐ RW - - Define qué formato de tiempo se utilizará para vi‐
mat (Página 1054) sualizar la columna de tiempos referenciada median‐
te "TimeColumnIndex".
TimeColumnTimeRan‐ RW - - Define la unidad de tiempo para determinar el rango
geBase (Página 1055) de tiempo que se mostrará en la columna de tiempos
referenciada mediante "TimeColumnIndex".
TimeColumnTimeRan‐ RW - - Define el factor para la determinación del intervalo
geFactor (Página 1056) de tiempo.
TimeColumnUseValue‐ RW - - Define si se mostrará la columna de tiempos refe‐
ColumnColors (Pági‐ renciada mediante "TimeColumnIndex" en los colo‐
na 1056) res de la columna de valores.
TimeColumnVisible (Pá‐ RW - - Define si la columna de tiempos referenciada me‐
gina 1057) diante "TimeColumnIndex" se mostrará en el visor
de tablas.
TimeStepBase (Pági‐ RW - - Define la unidad de tiempo para especificar la preci‐
na 1059) sión del sello de tiempo que se representará en la
tabla.
TimeStepFactor (Pági‐ RW - - Determina la precisión del sello de tiempo que se
na 1060) establecerá con la unidad de tiempo "TimeStepBa‐
se".
TitleColor (Página 1061) RW - - Define el color de fondo del título de la tabla.
demasiado pequeño.
del objeto.
del objeto.
columna.
TitleStyle (Página 1067) RW - - Define si se empleará un color de sombreado para
el texto de los encabezados de columna.
na 1075)
gina 1076)

VB Scripting

sional ced
gina 1081)
na 1084)
(Página 1085)
dex".
del objeto.
por el usuario.

VB Scripting

sional ced
UseColumnBackColor RW - - Define los ajustes del color de fondo de las colum‐
(Página 1163) nas.
UseColumnForeColor RW - - Define los ajustes del color de fuente de las colum‐
(Página 1163) nas.
ValueColumnAdd (Pági‐ RW - - Crea una nueva columna de valores.
na 1200)
ValueColumnAlignment RW - - Define cómo se alineará el texto dentro la columna
(Página 1201) de valores referenciada mediante "ValueColumnIn‐
dex".
ValueColumnAutoPreci‐ RW - - Define si se definirá automáticamente el número de
sions (Página 1201) decimales de una columna de valores referenciada
mediante "ValueColumnIndex".
ValueColumnBackCo‐ RW - - Define el color de fondo de la columna de valores
lor (Página 1202) referenciada mediante "ValueColumnIndex".
ValueColumnCaption RW - - Define el nombre de la columna de valores referen‐
(Página 1203) ciada mediante "ValueColumnIndex".
ValueColumnCount (Pá‐ RW - - Define el número de columnas de valores configu‐
gina 1203) radas.
ValueColumnExponen‐ RW - - Define si los valores de una columna de valores re‐
tialFormat (Pági‐ ferenciada mediante "ValueColumnIndex" se mos‐
na 1204) trarán en representación exponencial.
ValueColumnForeColor RW - - Define el color de fuente de la columna de valores
(Página 1204) referenciada mediante "ValueColumnIndex".
ValueColumnHideText RW - - Define si se ocultará el texto de la columna de valo‐
(Página 1205) res referenciada mediante "ValueColumnIndex".
ValueColumnHideTitle‐ RW - - Define si se ocultará el texto del título de la columna
Text (Página 1206) de valores referenciada mediante "ValueColumnIn‐
dex".
ValueColumnIndex (Pá‐ RW - - Hace referencia a una columna de valores.
gina 1206)
ValueColumnLength RW - - Define el ancho de la columna de valores referen‐
(Página 1207) ciada mediante "ValueColumnIndex" en número de
caracteres.
ValueColumnName (Pá‐ RW - - Define el nombre de una columna de valores refe‐
gina 1207) renciada mediante "ValueColumnIndex".
ValueColumnPreci‐ RW - - Define el número de decimales de los valores de la
sions (Página 1208) columna de valores referenciada mediante "Value‐
ColumnIndex".
ValueColumnProvider RW - - Define el suministro de datos de la columna de va‐
(Página 1208) lores referenciada mediante "ValueColumnIndex".
ValueColumnProvi‐ RW - - Define la CLSID de proveedor para los datos de una
derCLSID (Página 1209) columna de valores referenciada mediante "Value‐
ColumnIndex".

VB Scripting

sional ced
ValueColumnRemove RW - - Elimina una columna de valores referenciada me‐
(Página 1210) diante su nombre.
ValueColumnRename RW - - Define el nombre nuevo de una columna de valores
(Página 1210) referenciada mediante "ValueColumnIndex".
ValueColumnRepos RW - - Define la posición de una columna de valores refe‐
(Página 1211) renciada mediante "ValueColumnIndex".
ValueColumns - - - -
ValueColumnSelect‐ RW - - Define que en runtime se muestre primero el cuadro
TagName (Página 1212) de diálogo para seleccionar el nombre de la variable
del origen de los datos de la columna de valores
referenciada mediante "ValueColumnIndex".
ValueColumnShowIcon RW - - Define si se mostrará un símbolo en la columna de
(Página 1212) valores referenciada mediante "ValueColumnIndex".
ValueColumnShowTi‐ RW - - Define si se mostrará un símbolo en el título de la
tleIcon (Página 1213) columna de valores referenciada mediante "Value‐
ColumnIndex".
ValueColumnSort (Pági‐ RW - - Define el tipo de clasificación de la columna de va‐
na 1213) lores referenciada mediante "ValueColumnIndex" ".
ValueColumnSortIndex RW - - Determina el orden en la clasificación.
(Página 1214)
ValueColumnTagName RW - - Define el nombre de las variables cuyos valores se
(Página 1215) muestran en la columna de valores referenciada me‐
diante "ValueColumnIndex".
ValueColumnTimeCo‐ RW - - Determina la correspondiente columna de tiempo.
lumn (Página 1215)
ValueColumnVisible RW - - Define si la columna de valores referenciada me‐
(Página 1216) diante "ValueColumnIndex" se visualizará en el ob‐
jeto.
na 1218)
Tabla 1-59 Métodos

sional ced
CalculateStatistic (Pági‐ Sí - - Ejecuta la función de tecla "Calcular estadística" del
na 1275) visor de curvas f(t) y del visor de tablas.
na 1275)

VB Scripting

sional ced
jada.
Edit (Página 1280) Sí - - Ejecuta la función de tecla "Editar" del visor de tab‐
las.
GetOperatorMessage Sí - - Devuelve el objeto de aviso de operador designado
(Página 1290) por nombre o índice del visor de avisos como tipo
"ICCAxOperatorMessage".
GetOperatorMessage‐ Sí - - -
Collection
DataRowCollection".
GetSelectedRow (Pági‐ Sí - - Devuelve el objeto de filas seleccionado de un con‐
na 1300) trol basado en tablas como tipo "ICCAxDataRow".
GetSelectedRows (Pá‐ Sí - - Con selección múltiple, devuelve los objetos de filas
gina 1301) seleccionados de un control basado en tablas como
tipo "ICCAxDataRow".
na 1308) tion".
GetTimeColumn (Pági‐ Sí - - Devuelve el objeto de columna de tiempo designado
na 1313) por nombre o índice del visor de tablas como tipo
"ICCAxTimeColumn".
GetTimeColumnCollec‐ Sí - - Devuelve el listado de todos los objetos de columna
tion (Página 1314) de tiempo del visor de tablas como tipo "ICCAxCo‐
llection".
"ICCAxCollection".
GetValueColumn (Pági‐ Sí - - Devuelve el objeto de columna de valores designa‐
na 1325) do por nombre o índice del visor de curvas f(t) como
tipo "ICCAxValueColumn".
GetValueColumnCollec‐ Sí - - Devuelve el listado de todos los objetos de columna
tion (Página 1326) de valores del visor de curvas f(t) como tipo "ICCAx‐
Collection".

VB Scripting

sional ced
MoveToFirst (Pági‐ Sí - - Ejecuta la función del botón "Primera fila" del control.
na 1337)
MoveToLast (Pági‐ Sí - - Ejecuta la función del botón "Último registro" del
na 1338) control.
MoveToNext (Pági‐ Sí - - Ejecuta la función del botón "Registro siguiente" del
na 1340) control.
MoveToPrevious (Pági‐ Sí - - Ejecuta la función del botón "Registro anterior" del
na 1341) control.
NextColumn (Pági‐ Sí - - Ejecuta la función del botón "Columna siguiente" del
na 1343) visor de tablas.
PreviousColumn (Pági‐ Sí - - Ejecuta la función del botón "Columna anterior" del
na 1345) visor de tablas.
tablas.
SelectStatisticArea (Pá‐ Sí - - Ejecuta la función del botón "Definir área estadísti‐
gina 1361) ca" del visor de tablas.
ShowColumnSelection Sí - - Ejecuta la función del botón "Seleccionar columnas"
(Página 1365) del visor de tablas.
na 1367)
ShowInsertValueDialog Sí - - -
StartStopUpdate (Pági‐ Sí - - Ejecuta la función del botón "Iniciar" o "Detener" del
na 1377) control.

VB Scripting
OnlineTrendControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de curvas f(t)". El objeto OnlineTrendControl es un elemento de


HMIOnlineTrendControl

R Lectura
- Ningún acceso

sional ced
ForDesignMode
na 573)
na 589)

VB Scripting

sional ced
Bounds - - - -
ConnectTrendWindows RW - - Define si se enlazan los visores de curvas configu‐
(Página 644) rados.
(Página 646)
Enabled - - - -
geable (Página 686) se puede modificar en runtime.
(Página 688)
gina 690) Provider.
(Página 691)
na 693) rán.
GraphDirection (Pági‐ RW - - Define el borde de la ventana de curvas en el que
na 729) se mostrarán los valores actuales.
Layer - - - -
ventana.
Location - - - -
MaximumNumberOfTi‐ - - - -
meAxes

VB Scripting

sional ced
MaximumNumberOfVa‐ - - - -
lueAxes
MinimumNumberOfTi‐ - - - -
meAxes
MinimumNumberOfVa‐ - - - -
lueAxes
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
PercentageAxis (Pági‐ RW - - Define que un eje adicional se muestre con una es‐
na 874) cala porcentual en el visor de curvas.
PercentageAxisAlign‐ RW - - Define la alineación del eje porcentual.
ment (Página 875)
PercentageAxisColor RW - - Define el color de fuente y de línea del eje porcen‐
(Página 876) tual.
"Informes".
ShowRuler (Página 953) RW - - Define si se mostrará una escala graduada (línea
auxiliar) para rotular el eje.
ShowRulerInAxis (Pági‐ RW - - Define si la regla se mostrará también en el eje de
na 953) tiempos.
ShowScrollbars (Pági‐ RW - - Define si se muestran las barras de desplazamiento.
na 955)
ShowStatisticRuler (Pá‐ RW - - Define si se mostrarán las líneas que definen el área
gina 958) de estadísticas.
ShowTrendIcon (Pági‐ RW - - Determina si debajo de los ejes de valores se mos‐
na 963) trará un símbolo.
Size - - - -
runtime.
(Página 973)

VB Scripting

sional ced
StatusbarElementAuto‐ RW - - Establece si el ancho del elemento seleccionado de
Size (Página 975) la barra de estado se ajustará automáticamente.
StatusbarElementIco‐ RW - - Define la asignación del número de ident. y del sím‐
nId (Página 977) bolo de un elemento de la barra de estado.
(Página 979)
dex".
do del objeto.
StatusbarElementText RW - - Define el texto del elemento seleccionado de la ba‐
(Página 983) rra de estado.
StatusbarElementTool‐ RW - - Define el texto del tooltip del elemento definido por
tipText (Página 984) el usuario seleccionado en la barra de estado.
StatusbarElementUser‐ RW - - Define si el elemento de la barra de estado ha sido
Defined (Página 985) agregado por el ingeniero como nuevo elemento de‐
rá en el objeto.
StatusbarElementWidth RW - - Indica el ancho del elemento referenciado de la ba‐
(Página 987) rra de estado en píxeles.
na 987)
gina 988) estado.
na 990)
na 992) control.
TabIndex - - - -

VB Scripting

sional ced
TimeAxes - - - -
TimeAxisAdd (Pági‐ RW - - Crea un nuevo eje de tiempo. El eje de tiempo recién
na 1024) creado se referencia automáticamente mediante "Ti‐
meAxisIndex".
TimeAxisAlignment (Pá‐ RW - - Determina la alineación del eje de tiempo.
gina 1025)
TimeAxisBeginTime RW - - Define el punto de inicio de la representación de la
(Página 1025) curva indicada.
TimeAxisColor (Pági‐ RW - - Determina el color del eje de tiempo.
na 1026)
TimeAxisCount (Pági‐ RW - - Define el número de ejes de tiempo configurados.
na 1027)
TimeAxisDateFormat RW - - Define qué formato de fecha se utilizará para mos‐
(Página 1027) trar el eje de tiempo seleccionado.
TimeAxisEndTime (Pá‐ RW - - Define el tiempo de fin de la representación de la
gina 1028) curva indicada.
TimeAxisIndex (Pági‐ RW - - Hace referencia a un eje de tiempo.
na 1028)
TimeAxisInTrendColor RW - - Define si el color del eje referenciado mediante "Ti‐
(Página 1029) meAxisIndex" debe corresponderse con el color de
la curva.
TimeAxisLabel (Pági‐ RW - - Define el texto con el que se rotulará un eje de tiem‐
na 1030) po referenciado mediante "TimeAxisIndex".
TimeAxisMeasure‐ RW - - Define el número de puntos de medida que se mos‐
Points (Página 1030) trarán para el eje de tiempo seleccionado.
TimeAxisName (Pági‐ RW - - Define el nombre de un eje de tiempo referenciado
na 1031) mediante "TimeAxisIndex".
TimeAxisOnline (Pági‐ RW - - Define que el eje de tiempo se actualice continua‐
na 1031) mente.
TimeAxisRangeType RW - - Define el ajuste del rango de tiempo del eje de tiem‐
(Página 1032) po seleccionado.
TimeAxisRemove (Pági‐ RW - - Elimina un eje de tiempo referenciado mediante su
na 1033) nombre.
TimeAxisRename (Pági‐ RW - - Define el nombre nuevo de un eje de tiempo refe‐
na 1033) renciado mediante "TimeAxisIndex".
TimeAxisRepos (Pági‐ RW - - Define la posición de un eje de tiempo referenciado
na 1034) mediante "TimeAxisIndex" en el diagrama de curvas
del objeto.
TimeAxisShowDate RW - - Define si se debe mostrar el eje de tiempo seleccio‐
(Página 1035) nado con fecha y hora.
TimeAxisTimeFormat RW - - Define el formato de las indicaciones a lo largo del
(Página 1035) eje de tiempo de la curva especificada.
TimeAxisTimeRange‐ RW - - Define la unidad de tiempo que determina el rango
Base (Página 1036) de tiempo con el factor de tiempo "TimeAxisTime‐
RangeFactor".
TimeAxisTimeRange‐ RW - - Determina el factor de tiempo que determina el pe‐
Factor (Página 1037) riodo con la unidad de tiempo "TimeAxisTimeRan‐
geBase".

VB Scripting

sional ced
TimeAxisTrendWindow RW - - Define el diagrama de curvas en el que se mostrará
(Página 1037) el eje referenciado mediante "TimeAxisIndex".
TimeAxisVisible (Pági‐ RW - - Define si se mostrará el eje de tiempo referenciado
na 1038) mediante "TimeAxisIndex" en el objeto.
na 1075)
gina 1076)
gina 1081)
ToolbarButtonHotKey RW - - Define la combinación de teclas para el botón selec‐
(Página 1083) cionado del objeto.
na 1084)
(Página 1085)
dex".
del objeto.

VB Scripting

sional ced
por el usuario.
TrendAdd (Pági‐ RW - - Crea una curva nueva.
na 1108)
TrendAutoRangeBegin‐ RW - - Define una variable que determina el valor de inicio
TagName (Página 1109) del área de datos de la curva.
TrendAutoRangeBegin‐ RW - - Define el valor de inicio del área de datos de la curva.
TrendAutoRangeEnd‐ RW - - Define una variable que determina el valor de fin del
TagName (Página 1110) área de datos de la curva.
TrendAutoRangeEnd‐ RW - - Define el valor de fin del área de datos de la curva.
TrendAutoRangeSour‐ RW - - Define cómo se determinará el área de datos auto‐
ce (Página 1111) mática de los datos de la curva.
TrendColor (Pági‐ RW - - Define el color de la línea de una curva referenciada
na 1112) del visor de curvas.
TrendCount (Pági‐ RW - - Determina el número de curvas configuradas.
na 1113)
TrendExtendedColor‐ RW - - Define si se mostrarán el color de punto y el color
Set (Página 1114) de relleno de la curva.
TrendFill (Página 1115) RW - - Define si se debe mostrar rellena la superficie deba‐
jo de la curva.
TrendFillColor (Pági‐ RW - - Define el color de relleno de la curva.
na 1116)
TrendIndex (Pági‐ RW - - Hace referencia a una curva configurada.
na 1117)
TrendLabel (Pági‐ RW - - Define el texto con el que se titulará la curva refe‐
na 1118) renciada mediante "TrendIndex".
TrendLineStyle (Pági‐ RW - - Define qué tipo de línea se utilizará para la repre‐
na 1119) sentación de la curva.
TrendLineType (Pági‐ RW - - Define cómo se mostrará la curva.
na 1119)
TrendLineWidth (Pági‐ RW - - Define el grosor de línea en píxeles de la curva se‐
na 1120) leccionada.

VB Scripting

sional ced
TrendLowerLimit (Pági‐ RW - - Indica el límite inferior de una variable que se visua‐
na 1121) liza como curva en el objeto.
TrendLowerLimitColor RW - - Define el color que marcará los valores de curva que
(Página 1121) se encuentren por debajo del valor de "TrendLower‐
Limit".
TrendLowerLimitColo‐ RW - - Establece si se utilizará "TrendLowerLimitColor" pa‐
ring (Página 1122) ra marcar los valores de variable que se encuentren
por debajo del valor "TrendLowerLimit".
TrendName (Pági‐ RW - - Define el nombre de una curva referenciada median‐
na 1123) te "TrendIndex".
TrendPointColor (Pági‐ RW - - Define el color de los puntos de la curva referencia‐
na 1124) da.
TrendPointStyle (Pági‐ RW - - Define cómo se mostrarán los puntos en la curva.
na 1125)
TrendPointWidth (Pági‐ RW - - Determina el ancho de punto en píxeles.
na 1125)
TrendProvider (Pági‐ RW - - Define el suministro de datos de la curva seleccio‐
na 1126) nada.
TrendProviderCLSID RW - - Define la CLSID de proveedor para los datos de una
(Página 1127) curva.
TrendRemove (Pági‐ RW - - Elimina una curva referenciada mediante su nom‐
na 1128) bre.
TrendRename (Pági‐ RW - - Define el nombre nuevo de una curva referenciada
na 1129) mediante "TrendIndex".
TrendRepos (Pági‐ RW - - Define la posición de una curva referenciada me‐
na 1129) diante "TrendIndex" en la ventana de curvas del ob‐
jeto.
Trends - - - -
TrendSelectTagName RW - - Determina que en runtime se muestre primero el
(Página 1130) cuadro de diálogo para seleccionar el nombre de la
variable del origen de los datos del eje de valores.
TrendTagName (Pági‐ RW - - Determina el nombre de la variable que suministra
na 1132) datos al eje de valores.
TrendTimeAxis (Pági‐ RW - - Define qué eje de tiempo se utilizará para la curva
na 1134) seleccionada.
TrendTrendWindow RW - - Define en qué ventana de curvas se mostrará la cur‐
(Página 1135) va seleccionada.
TrendUncertainColor RW - - Define el color de los valores con estado inseguro.
(Página 1136)
TrendUncertainColo‐ RW - - Define que se resalten los valores con estado inse‐
ring (Página 1137) guro.
TrendUpperLimit (Pági‐ RW - - Define el límite superior de una variable que se re‐
na 1137) presenta como curva en un objeto dado.
TrendUpperLimitColor RW - - Define el color que marcará los valores de curva que
(Página 1138) se encuentren por encima del valor de "TrendUpper‐
Limit".
TrendUpperLimitColo‐ RW - - Define si el borde de selección se representará en
ring (Página 1139) el color definido por el sistema.

VB Scripting

sional ced
TrendValueAlign - - - -
TrendValueAxis (Pági‐ RW - - Define qué eje de valores se utilizará para la curva
na 1140) seleccionada.
TrendValueUnit (Pági‐ RW - - Para el tipo de curva "Representar valores", deter‐
na 1140) mina una unidad de los valores que se adjunta al
valor que representar, p. ej., "%" o "°C".
TrendVisible (Pági‐ RW - - Define si se mostrará la curva referenciada median‐
na 1141) te "TrendIndex" en el objeto.
TrendWindowAdd (Pá‐ RW - - Crea un nuevo visor de curvas.
gina 1141)
TrendWindowCoarse‐ RW - - Define si se mostrarán las líneas de cuadrícula y la
Grid (Página 1142) escala principal.
TrendWindowCoarse‐ RW - - Define el color de la cuadrícula principal para el dia‐
GridColor (Página 1143) grama referenciado en el objeto.
TrendWindowCount RW - - Define el número de diagramas de curva configura‐
(Página 1143) dos en el visor de curvas.
TrendWindowFineGrid RW - - Define si se mostrarán las líneas de cuadrícula de
(Página 1144) la escala auxiliar.
TrendWindowFineGrid‐ RW - - Define el color de la cuadrícula auxiliar para el dia‐
Color (Página 1145) grama referenciado en el objeto.
TrendWindowFore‐ RW - - Define si se mostrarán solamente las líneas de cua‐
groundTrendGrid (Pági‐ drícula para la curva de primer plano de la ventana
na 1145) de curvas seleccionada.
TrendWindowGridIn‐ RW - - Define si se mostrarán las líneas de cuadrícula de
TrendColor (Pági‐ la escala principal en el color de la curva.
na 1146)
TrendWindowHorizon‐ RW - - Determina si se mostrarán las líneas de cuadrícula
talGrid (Página 1147) horizontales.
TrendWindowIndex (Pá‐ RW - - Hace referencia a un visor de curvas. Para acceder
gina 1147) a las propiedades de un visor de curvas, es necesa‐
rio activar "TrendWindowIndex".
TrendWindowName RW - - Define el nombre de un visor de curvas referenciado
TrendWindowRemove RW - - Elimina un visor de curvas referenciado mediante su
(Página 1149) nombre.
TrendWindowRename RW - - Define el nombre nuevo de un visor de curvas refe‐
(Página 1149) renciado mediante "TrendWindowIndex".
TrendWindowRepos RW - - Define la posición de un visor de curvas referenciado
TrendWindowRulerCo‐ RW - - Define el color de la regla.
lor (Página 1150)
TrendWindowRulerLa‐ RW - - Define el nivel de representación de la regla en el
yer (Página 1151) visor de curvas.
TrendWindowRulerSty‐ RW - - Define la representación de la regla.
le (Página 1152)
TrendWindowRuler‐ RW - - Define en píxeles el grosor de la regla.
TrendWindows - - - -

VB Scripting

sional ced
TrendWindowSpace‐ RW - - Define la proporción del área del diagrama referen‐
Portion (Página 1153) ciado en el área de diagramas del objeto.
TrendWindowStatisti‐ RW - - Define el color de la regla de estadística.
cRulerColor (Pági‐
na 1154)
TrendWindowStatisti‐ RW - - Define la posibilidad de configurar gráficamente las
cRulerStyle (Pági‐ líneas para definir el área de estadísticas en la ven‐
na 1155) tana de curvas.
TrendWindowStatisti‐ RW - - Define el grosor de línea de la regla de estadística.
cRulerWidth (Pági‐
na 1156)
TrendWindowVertical‐ RW - - Define si se mostrarán las líneas de cuadrícula ver‐
Grid (Página 1156) ticales.
TrendWindowVisible RW - - Define si se muestra el visor de curvas referenciado
UseTrendNameAsLa‐ RW - - Define si las propiedades "Nombre" o "Rotulación"
bel (Página 1178) se utilizarán como nombre de la curva en runtime.
ValueAxes - - - -
ValueAxisAdd (Pági‐ RW - - Crea un nuevo eje de valores.
na 1188)
ValueAxisAlignment RW - - Determina la alineación del eje de valores.
(Página 1188)
ValueAxisAutoPreci‐ RW - - Define si se determinará automáticamente el núme‐
sions (Página 1189) ro de decimales de un eje de valores referenciado
mediante "ValueAxisIndex".
ValueAxisAutoRange RW - - Define si se determinará automáticamente el rango
(Página 1190) de valores de un eje de valores referenciado me‐
diante "ValueAxisIndex".
ValueAxisBeginValue RW - - Define el punto inferior del rango de valores de un
(Página 1190) eje de valores referenciado mediante "ValueAxisIn‐
dex".
ValueAxisColor (Pági‐ RW - - Define el color de un eje de valores.
na 1191)
ValueAxisCount (Pági‐ RW - - Define el número de ejes de valores configurados.
na 1192)
ValueAxisEndValue RW - - Define el punto superior del rango de valores de un
(Página 1192) eje de valores referenciado mediante "ValueAxisIn‐
dex".
ValueAxisExponential‐ RW - - Determina si los valores de un eje de valores refe‐
Format (Página 1193) renciado mediante "ValueAxisIndex" se mostrarán
en representación exponencial.
ValueAxisIndex (Pági‐ RW - - Hace referencia a un eje de valores.
na 1193)
ValueAxisInTrendColor RW - - Define si el color del eje referenciado mediante "Va‐
(Página 1194) lueAxisIndex" debe corresponderse con el color de
la curva.
ValueAxisLabel (Pági‐ RW - - Define el texto con el que se rotulará un eje de valo‐
na 1195) res referenciado mediante "ValueAxisIndex".

VB Scripting

sional ced
ValueAxisName (Pági‐ RW - - Define el nombre nuevo de un eje de valores refe‐
na 1195) renciado mediante "ValueAxisIndex".
ValueAxisPrecisions RW - - Determina el número de decimales mostrados.
(Página 1196)
ValueAxisRemove (Pá‐ RW - - Elimina un eje de valores referenciado mediante su
gina 1196) nombre.
ValueAxisRename (Pá‐ RW - - Define el nombre nuevo de un eje de valores refe‐
gina 1197) renciado mediante "ValueAxisIndex".
ValueAxisRepos (Pági‐ RW - - Define la posición de un eje de valores referenciado
na 1197) mediante "ValueAxisIndex".
ValueAxisScalingType RW - - Define el tipo de escala del eje de valores referen‐
(Página 1198) ciado mediante "ValueAxisIndex".
ValueAxisTrendWin‐ RW - - Define el diagrama de curvas en el que se mostrará
dow (Página 1199) el eje referenciado mediante "ValueAxisIndex".
ValueAxisVisible (Pági‐ RW - - Define si se mostrará el eje de valores referenciado
na 1199) mediante "ValueAxisIndex" en el objeto.
Tabla 1-61 Métodos

sional ced
CalculateStatistic (Pági‐ Sí - - Ejecuta la función de tecla "Calcular estadística" del
na 1275) visor de curvas f(t) y del visor de tablas.
jada.
GetRulerData (Pági‐ Sí - - Devuelve el valor de la curva solicitada en la posi‐
na 1299) ción de la regla.
na 1314) tion".

VB Scripting

sional ced
GetTimeAxis (Pági‐ Sí - - Devuelve el objeto de eje de tiempo designado por
na 1310) nombre o índice del visor de curvas f(t) como tipo
"ICCAxTimeAxis".
GetTimeAxisCollection Sí - - Devuelve el listado de todos los objetos de eje de
(Página 1311) tiempo del visor de curvas f(t) como tipo "ICCAxCo‐
llection".
"ICCAxCollection".
GetTrend (Pági‐ Sí - - Devuelve la curva designada por nombre o índice
na 1318) del visor de curvas f(t) o f(x) como tipo "ICCAxTrend"
o "ICCAxFunctionTrend".
GetTrendCollection (Pá‐ Sí - - Devuelve el listado de todas las curvas del visor de
gina 1319) curvas f(t) o f(x) como tipo "ICCAxCollection".
GetTrendWindow (Pági‐ Sí - - Devuelve el objeto de ventana de curvas designado
na 1320) por nombre o índice del visor de curvas f(t) o f(x)
como tipo "ICCAxTrendWindow".
GetTrendWindowCo‐ Sí - - Devuelve el listado de todos los objetos de ventana
llection (Página 1321) de curvas del visor de curvas f(t) o f(x) como tipo
"ICCAxCollection".
GetValueAxis (Pági‐ Sí - - Devuelve el objeto de eje de valores designado por
na 1322) nombre o índice del visor de curvas f(t) como tipo
"ICCAxValueAxis".
GetValueAxisCollection Sí - - Devuelve el listado de todos los objetos de eje de
(Página 1324) valores del visor de curvas f(t) como tipo "ICCAxCo‐
llection".
MoveAxis (Pági‐ Sí - - Ejecuta la función del botón "Desplazar área del eje"
na 1336) de los visores de curvas f(t) y f(x).
MoveRuler Sí - -
na 1337)
na 1338) control.
na 1340) control.
na 1341) control.
NextTrend (Pági‐ Sí - - Ejecuta la función del botón "Siguiente curva" de los
OneToOneView (Pági‐ Sí - - Ejecuta la función del botón "Vista original" de los
PreviousTrend (Pági‐ Sí - - Ejecuta la función del botón "Curva anterior" de los

VB Scripting

sional ced
na 1367)
ShowPercentageAxis Sí - - Ejecuta la función del botón "Eje relativo" del visor
(Página 1371) de curvas f(t).
ZoomArea (Pági‐ Sí - - Ejecuta la función del botón "Ampliar sección" de los
ZoomInOut (Pági‐ Sí - - Ejecuta la función del botón "Zoom +/-" de los viso‐
na 1385) res de curvas f(t) y f(x).
ZoomInOutTime (Pági‐ Sí - - Ejecuta la función del botón "Zoom eje de tiempos
na 1386) +/-" del visor de curvas f(t).
ZoomInOutValues (Pá‐ Sí - - Ejecuta la función del botón "Zoom eje de valores
gina 1386) +/-" del visor de curvas f(t).
ZoomMove (Pági‐ Sí - - Ejecuta la función del botón "Desplazar área de cur‐
na 1388) va" de los visores de curvas f(t) y f(x).
OptionGroup (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Botones de opción". El objeto OptionGroup es un elemento de la lista

ScreenItems.

VB Scripting

HMIOptionGroup

R Lectura
- Ningún acceso

sional ced
na 528)
na 542)
(Página 545) "On".
(Página 547)
gina 548)
na 570) brada.
na 573)
(Página 582) de.
BorderStyle - - - -
na 589)
Bounds - - - -
CheckMarkAlignment RW - - Define si los campos se disponen justificados a la
(Página 608) derecha.

VB Scripting

sional ced
CheckMarkCount (Pági‐ RW - - Determina el número de campos.
na 609)
na 647)
runtime.
na 700)
na 697)
Flashing - - - -
na 710)
na 712) de.
Font - - - -
na 724)
(Página 748)
(Página 800)
Location - - - -
Name - - - -

VB Scripting

sional ced
na 893)
na 948)
Size - - - -
TabIndex - - - -
TextHandles - - - -
na 1018)
Texts - - - -
na 1098)
na 1103) centaje.
te objeto.
VerticalAlignment (Pági‐ RW - - Determina la alineación vertical del texto en el objeto
na 1217) indicado.
Tabla 1-63 Métodos

sional ced
jada.

VB Scripting
PDFview (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de PDF". El objeto PDFview es un elemento de la lista

ScreenItems.

HMIPDFview

R Lectura
- Ningún acceso

fessional vanced
wed
Bounds - - - -
Enabled (Pági‐ - RW RW Define si el objeto indicado se podrá ma‐
na 672) nejar en runtime.

VB Scripting

fessional vanced
FileName - - - -
Height - - - Define la altura.
Layer - RW RW Dentro de la imagen, define el nivel en el
que se encuentra un objeto.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Visible - - - -
Width - - - Define el ancho del objeto en píxeles.
Tabla 1-65 Métodos

sional ced
PLCCodeViewer (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Visor de código PLC". El objeto PLCCodeViewer es un elemento de la

lista ScreenItems.

HMIPLCCodeViewer

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
runtime.
Location - - - -
Name - - - -
NavigateTo (Pági‐ RW RW RW Define el módulo al que se salta.
na 842)
NumberOfVisibleLines RW - - Define el número de filas visibles del visor de código
(Página 848) PLC.
PathHeaderFont (Pági‐ RW - - Define la fuente del encabezado.
na 873)
Size - - - -
SymbolTableFont (Pági‐ RW - - Define la fuente de la tabla de símbolos del visor de
na 998) código PLC.
TabIndex - - - -
TransitionHeaderFont RW - - Define la fuente del área de información de este vi‐
(Página 1103) sor de código PLC.

VB Scripting
Tabla 1-67 Métodos

sional ced
ActivateDynamic Sí - - Activa dinámicamente un disparador y el ciclo fijado
para una propiedad durante el runtime.
DeactivateDynamic Sí - - Desactiva en/durante el runtime el disparador usado
del método "ActivateDynamic" para la propiedad fi‐
jada.
Polygon (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Polygon". El objeto Polygon es un elemento de la lista ScreenItems.

HMIPolygon

R Lectura
- Ningún acceso

VB Scripting

sional ced
ActualPointIndex (Pági‐ RW - - Determina el número del vértice actual.
na 507)
ActualPointLeft (Pági‐ RW - - Define la coordenada X del vértice actual referida al
na 508) origen de la imagen.
ActualPointTop (Pági‐ RW - - Determina la coordenada Y del vértice actual en re‐
na 509) ferencia al origen de la imagen.
na 528)
BackFillStyle (Pági‐ RW RW RW Define el patrón de relleno.
na 542)
na 570) brada.
na 573)
(Página 582) de.
na 587)
na 589)
Bounds - - - -
na 647)
DeviceStyle - - - -
runtime.
na 700)
FillPatternColor RW - - -
Flashing - - - -

VB Scripting

sional ced
na 710)
na 712) de.
(Página 800)
LineWidth - - - -
Location - - - -
Name - - - -
Points - - - -
PointsCount (Pági‐ RW - - Determina el número de vértices de la polilínea o del
na 883) polígono.
na 893)
na 895)
na 948)
Size - - - -
StyleItem - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

VB Scripting
Tabla 1-69 Métodos

sional ced
jada.
Polyline (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Polilínea". El objeto Polyline es un elemento de la lista ScreenItems.

HMIPolyline

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 507)
ActualPointLeft (Pági‐ RW - - Determina la coordenada X del vértice actual en re‐
na 528)
BorderEndStyle (Pági‐ RW - - Define el tipo de finales de línea.
na 577)
na 587)
Bounds - - - -
Color (Página 611) RW RW RW Define el color de línea.
na 647)
DeviceStyle - - - -
runtime.
EndStyle (Página 679) RW RW RW Define la forma con la que se representa el final de
línea.
FillStyle (Página 699) - RW RW Define si se visualizará el color de fondo de una línea
quebrada.
Flashing - - - -
na 710)
na 712) de.
Left (Página 782) RW RW RW Define el valor de la coordenada X del objeto.
LineEndShapeStyle RW - - Determina la forma del final de línea.
(Página 800)
LineWidth (Página 802) RW RW RW Define el grosor de línea.

VB Scripting

sional ced
Location - - - -
Name - - - -
Points - - - -
na 883) polígono.
na 895)
Size - - - -
StartStyle (Página 971) RW RW RW Define cómo se debe representar el comienzo de
línea.
Style (Página 995) RW RW RW Define el estilo de línea.
StyleItem - - - -
TabIndex - - - -
na 1098)
Top (Página 1099) RW RW RW Define el valor de la coordenada Y del objeto.
na 1103) centaje.
te objeto.
Visible (Página 1222) RW RW RW Determina si el objeto será visible.
Tabla 1-71 Métodos

sional ced
jada.

VB Scripting
Vista general ProDiag (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Vista general ProDiag". El objeto ProDiagOverview es un elemento de


HMIProDiagOverview

R Lectura
- Ningún acceso

sional ced
runtime.
Height (Página 732) RW RW RW Define la altura.
Name - - - -

VB Scripting

sional ced
Tabla 1-73 Métodos

sional ced
jada.
ProtectedAreaNameView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Nombre (RFID)". El objeto ProtectedAreaNameView es
un elemento de la lista ScreenItems.

HMIProtectedAreaNameView

R Lectura
- Ningún acceso

VB Scripting

sional ced
Bounds - - - -
Font - - - -
Height - - - -
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Tabla 1-75 Métodos

sional ced
RangeLabelView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Nombre". El objeto RangeLabelView es un elemento de

VB Scripting

HMIRangeLabelView

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
Font - - - -
Height - - - -
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -
Tabla 1-77 Métodos

sional ced

VB Scripting
RangeQualityView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Señal". El objeto RangeQualityView es un elemento de

HMIRangeQualityView

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
Height - - - -
Layer (Página 776) - - RW Dentro de la imagen, devuelve el nivel en el que se
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -

VB Scripting
Tabla 1-79 Métodos

sional ced
Consulte también
RecipeView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de recetas". El objeto RecipeView es un elemento de la lista

ScreenItems.
Nota
El objeto "Visor de recetas simple" no se puede dinamizar mediante un script de usuario.

VB Scripting

R Lectura
- Ningún acceso

sional ced
AdvancedButtonPosi‐ - - - -
tions
AdvancedView - - - -
AllowEdit - - - -
Authorization (Pági‐ - RW RW Define los derechos de manejo del objeto indicado
na 528) en runtime.
BackButtonVisible - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
lor
set
Color
Color
tOffset
ColumnOrder - - - -
ColumnWidth - - - -

VB Scripting

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

VB Scripting

sional ced
FitToSize - - - -
Flashing - - - -
Font - - - -
HeaderFont - - - -
Height - - - -
IsVerticalScrollBarEna‐ - - - -
bled
KeyboardOnline - - - -
ListAreaHeight - - - -
ListAreaLeft - - - -
ListAreaTop - - - -
ListAreaWidth - - - -
Location - - - -
MaxNumberOfCombo‐ - - - -
BoxCharacters
MenuButtonVisible - - - -
Name - - - -
NameColumnWidth - - - -
NumberOfButtons - - - -
NumberOfLines - - - -
PaddingLeft - - - -
PaddingTop - - - -
PlcUDTFilter - - - -
ProhibitDataRecordTa‐ - - - -
gInOnlySimpleView
Recipe - - - -
RecipeName (Pági‐ - RW RW Define el nombre de la receta que se visualiza en el
na 891) "Visor de recetas".
RecipeNameCaption - - - -
RecipeNrCaption - - - -
RecipeNrColFirst - - - -
RecipeNumber (Pági‐ - RW RW Define el número de la receta que se visualiza en el
na 892) "Visor de recetas".

VB Scripting

sional ced
RecordName (Pági‐ - RW RW Define el nombre del registro de receta que se vi‐
na 892) sualiza en el "Visor de recetas".
RecordNrColFirst - - - -
RecordNumber (Pági‐ - R R Devuelve el número del registro de receta que se
na 893) visualiza en ese momento en el "Visor de recetas".
RenameButtonVisible - - - -
SelectionBackColor - R R Devuelve el color de fondo de las celdas seleccio‐
SelectionForeColor (Pá‐ - R R Devuelve el color de primer plano de las celdas se‐
SimpleView - - - -
Size - - - -
StatuslineFont - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor (Pági‐ - R R Devuelve el color de fondo de las celdas de tabla.
na 1001)
lor
TableForeColor (Pági‐ - R R Devuelve el color de fuente de las celdas de tabla
na 1005) del objeto.
TableGridLineColor (Pá‐ - R R Devuelve el color de las líneas de la cuadrícula en
gina 1006) la tabla.
TableHeaderBackColor - R R Devuelve el color de fondo del encabezado de la
(Página 1007) tabla.
FillStyle
BackColor
lor
Width
dius
dientColor
dientOffset
TableHeaderForeColor - R R Devuelve el color de texto del encabezado de la ta‐
(Página 1009) bla.
dientColor

VB Scripting

sional ced
Bottom
gLeft
gRight
Top
GradientColor
GradientOffset
Tag4DataRecord - - - -
Tag4RecipeNumber - - - -
TextualObjectPositions - - - -
TextualObjectsAutoSize - - - -
TextualObjectsBorder‐ - - - -
BackColor
Color
Width
TextualObjectsCorne‐ - - - -
rRadius
TextualObjectsEd‐ - - - -
geStyle
TextualObjectsPadding‐ - - - -
Bottom
TextualObjectsPaddin‐ - - - -
gLeft
TextualObjectsPaddin‐ - - - -
gRight
TextualObjectsPadding‐ - - - -
Top
dient
ma
Gradient
condGradient
ValueCaption - - - -
ValueColumnWidth - - - -

VB Scripting

sional ced
VerticalScrolling - - - -
ViewType - - - -
tream
VisibleItems - - - -
Width - - - -
Tabla 1-81 Métodos

sional ced
Rectangle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Rectángulo". El objeto Rectangle es un elemento de la lista

ScreenItems.

HMIRectangle

VB Scripting

R Lectura
- Ningún acceso

sional ced
na 528) en runtime.
BackFillStyle (Pági‐ RW RW RW Define el patrón de relleno del objeto indicado.
na 542)
na 573)
na 587) cado.
na 589)
Bounds - - - -
na 647)
DeviceStyle - - - -
runtime.
na 700)

VB Scripting

sional ced
na 697) indicado.
Flashing - - - -
Height (Página 732) RW RW RW Define la altura del objeto indicado.
cado.
(Página 800)
Location - - - -
Name - - - Devuelve el nombre de objeto como STRING.
na 893)
RoundCornerHeight RW - - Define el radio angular.
(Página 897)
RoundCornerWidth (Pá‐ RW - - Define el radio angular.
gina 898)
na 948)
Size - - - -
StyleItem - - - -
TabIndex - - - -
na 1098)
cado.
na 1103) centaje.
te objeto.

VB Scripting
Tabla 1-83 Métodos

sional ced
ActivateDynamic (Pá‐ Sí - - Activa dinámicamente un disparador y el ciclo fijado
gina 1270) para una propiedad durante el runtime.
(Página 1277) del método "ActivateDynamic" para la propiedad fija‐
da.
RoundButton (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Botón redondo". El objeto RoundButton es un elemento de la lista

ScreenItems.

HMIRoundButton

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528) en runtime.
BackColor (Página 537) RW - - Define el color de fondo del objeto indicado.
na 542)
(Página 545) "On".
BackFlashingEnabled RW - - Determina si el fondo del objeto indicado parpadeará
(Página 547) en runtime.
BorderBrightColor3D RW - - Determina el color de las siguientes partes del borde
Partes exteriores del borde superior e inferior; partes
interiores del borde inferior y derecha
na 573)
BorderShadeColor3D - - - -
na 587) cado.
na 589)
BorderWidth3D (Pági‐ RW - - Determina el ancho del borde para la representación
na 591) tridimensional del objeto indicado.
Bounds - - - -
na 647)

VB Scripting

sional ced
Enabled (Página 672) RW - - Define si el objeto indicado se podrá manejar en run‐
time.
na 700)
na 697) indicado.
Flashing - - - -
Font - - - -
negrita.
en cursiva.
indicado.
na 724) subrayado.
ForeColor (Página 724) R - - Establece el color de fuente del texto del objeto in‐
dicado.
Height (Página 732) R - - Define la altura del objeto indicado.
HorizontalAlignment R - - Determina la alineación horizontal del texto dentro
Layer (Página 776) R - - Dentro de la imagen, devuelve el nivel en el que se
Left (Página 782) R - - Devuelve el valor de la coordenada X del objeto.
LineEndShapeStyle R - - Define la forma de los finales de línea.
(Página 800)
Location - - - -
Mode (Página 836) R - - Devuelve el tipo de campo del objeto indicado.
Name - - - -
PictureAlignment (Pági‐ R - - Devuelve el modo de representación de la imagen
na 877) de fondo en el sinóptico de proceso.
PictureDeactivated (Pá‐ R - - Devuelve el gráfico que se muestra en el estado
gina 878) "Desactivado".

VB Scripting

sional ced
PictureOff (Página 879) R - - Devuelve el gráfico que se muestra en el estado
"Off".
PictureOn (Página 879) R - - Devuelve la imagen que se muestra en el estado
"On".
Pressed (Página 885) R - - Devuelve si el objeto indicado se representa pulsa‐
do.
Radius (Página 889) R - - Devuelve el radio del objeto indicado "Circle".
RelativeFillLevel (Pági‐ R - - Devuelve el porcentaje de relleno del objeto.
na 893)
ShowFillLevel (Pági‐ R - - Devuelve si se rellena el objeto indicado.
na 948)
Size - - - -
StyleSettings (Pági‐ R - - Devuelve el estilo con el que se representa el objeto.
na 996)
TabIndex - - - -
Text (Página 1015) R - - Devuelve el título del campo de texto.
TextOrientation (Pági‐ R - - Devuelve la dirección del texto del objeto indicado.
na 1018)
Toggle (Página 1068) R - - Devuelve si el objeto indicado encaja en runtime tras
la activación.
ToolTipText (Pági‐ R - - Devuelve el texto del tooltip.
na 1098)
Top (Página 1099) R - - Devuelve el valor de la coordenada Y del objeto.
Transparency (Pági‐ R - - Devuelve la transparencia del objeto en forma de
na 1103) porcentaje.
TransparentColorDeac‐ R - - Devuelve qué color del objeto de mapa de bits asig‐
tivatedPicture (Pági‐ nado se pondrá en "transparente" para el estado
na 1106) "Desactivado".
TransparentColorPictu‐ R - - Devuelve qué color del objeto de mapa de bits asig‐
reOff (Página 1106) nado se pondrá en "transparente" para el estado
"Off".
TransparentColorPictu‐ R - - Devuelve qué color del objeto de mapa de bits asig‐
reOn (Página 1107) nado se pondrá en "transparente" para el estado
"On".
UseDesignColorSche‐ R - - Devuelve si los colores definidos en el esquema cro‐
ma (Página 1165) mático global del diseño actual se utilizan para este
objeto.
UseDesignShadowSet‐ R - - Devuelve si el objeto se representa con el sombrea‐
tings (Página 1167) do fijado en el diseño activo.
UseTransparentColor‐ R - - Devuelve si el color transparente definido con la pro‐
DeactivatedPicture (Pá‐ piedad "TransparentColorDeactivatedPicture" se uti‐
gina 1177) liza para el estado "Desactivado".
PictureOff (Pági‐ piedad "TransparentColorPictureOff" se utiliza para
na 1177) el estado "Off".

VB Scripting

sional ced
PictureOn (Pági‐ piedad "TransparentColorPictureOn" se utiliza para
na 1178) el estado "On".
VerticalAlignment (Pági‐ R - - Devuelve la alineación vertical del texto del objeto
na 1217) indicado.
Visible (Página 1222) R - - Devuelve si el objeto indicado es visible.
Width (Página 1234) R - - Devuelve el ancho del objeto en píxeles.
Tabla 1-85 Métodos

sional ced
jada.
S7GraphOverview (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Vista general de GRAPH". El objeto S7GraphOverview es un elemento


VB Scripting

HMIS7GraphOverview

R Lectura
- Ningún acceso

sional ced
AssociatedS7GraphDB‐ - - - -
Name
AssociatedS7GraphDB‐ - - - -
Tag
na 528)
Bounds - - - -
runtime.
ErrorColor (Página 681) RW - - Define el color de los errores en la vista general de
GRAPH.
Errorflag (Página 683) RW - - Define si se muestra una descripción del error en la
vista de dispositivos/vista detallada.
Height (Página 732) - - - -
HighlightColor (Pági‐ RW - - Define el color de selección en la vista general de
na 738) GRAPH.
Location - - - -
Name - - - -
PathHeaderBackColor - - -
(Página 873)
PathHeaderFont (Pági‐ RW - - Define la fuente del encabezado.
na 873)
PathHeaderTextColor RW - - Define el color de fuente del encabezado de la vista
(Página 874) general de GRAPH.
SeparatorColor (Pági‐ RW - - Define el color de los separadores en la lista de se‐
na 934) lección.
Size - - - -
StepBackColor (Pági‐ RW - - Determina el color de fondo de la etapa.
na 993)

VB Scripting

sional ced
StepFont (Página 994) RW - - Define la fuente de la etapa.
StepTextColor (Pági‐ RW - - Define el color de texto de la etapa.
na 995)
TabIndex - - - -
Width (Página 1234) - - - -
Tabla 1-87 Métodos

sional ced
ActivateDynamic Sí - - Activa dinámicamente un disparador y el ciclo fijado
jada.
ScreenWindow (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Ventana de imagen". El objeto ScreenWindow es un elemento de la

lista ScreenItems.

VB Scripting

HMIScreenWindow

R Lectura
- Ningún acceso

sional ced
AdaptScreenToWindow R - - Define si la imagen representada en una ventana de
(Página 510) imagen se adapta o no en runtime al tamaño de la
ventana de imagen.
AdaptWindowtoScreen R - - Define si la ventana de imagen se adapta en runtime
(Página 511) a la imagen representada en ella.
BorderEnabled (Pági‐ R - - Define si la ventana se representará con borde en
na 576) runtime.
Bounds - - - -
CaptionText (Pági‐ RW - - Define el texto que se mostrará en la barra de título.
na 602)
Flashing - - - -
HorizontalScrollBarPo‐ RW - - Define la posición del deslizador en la barra de des‐
sition (Página 751) plazamiento horizontal.
IndipendentWindow - - - -
LeftOffset (Página 787) RW - - Define el desplazamiento horizontal del punto cero
de la visualización de una imagen de mayor tamaño
que la ventana de imagen.
Location - - - -
MenuToolBarConfig RW - - Define el archivo de configuración con menú perso‐
(Página 813) nalizado y barras de herramientas.
MonitorNumber (Pági‐ R - - Define el número del monitor cuyos contenidos se
na 837) visualizan en la ventana de imagen.
Name - - - -
ProcessTag - - - -
ScreenName (Pági‐ R - - Define la imagen que se muestra en la ventana de
na 914) imagen en runtime.
ScreenScaleMode (Pá‐ R - - Define el modo de escala de la imagen visualizada.
gina 915)

VB Scripting

sional ced
ServerPrefix RW - - Define el servidor en el que se encuentra la imagen
que se mostrará en la ventana de imagen en runti‐
me, o devuelve el nombre del servidor.
ShowCaption (Pági‐ R - - Define si se muestra la barra de título.
na 941)
ShowScrollbars (Pági‐ R - - Define si se muestran las barras de desplazamiento.
na 955)
Size - - - -
TabIndex - - - -
TagPrefix (Página 1012) RW - - Define el prefijo de variable que precederá a todas
las variables contenidas en la ventana de imagen.
TopOffset (Página 1102) RW - - Define el desplazamiento vertical del punto cero de
la visualización de una imagen de mayor tamaño
que la ventana de imagen.
VerticalScrollBarPosi‐ RW - - Define la posición del deslizador en la barra de des‐
tion (Página 1219) plazamiento vertical del objeto.
WindowCloseEnabled R - - Determina si puede cerrarse una ventana en runti‐
(Página 1238) me.
WindowMaximizeEna‐ R - - Define si el objeto se puede maximizar en runtime.
bled (Página 1238)
WindowMovingEnabled R - - Define si el objeto se puede desplazar en runtime.
(Página 1239)
WindowOnTop (Pági‐ R - - Define si el objeto permanece siempre en primer
WindowSizingEnabled R - - Define si puede modificarse el tamaño.
(Página 1241)
WindowStartupPosition R - - Define la posición y el modo de la ventana de imagen
(Página 1242) si se ha configurado una ventana de imagen inde‐
pendiente.
ZoomFactor (Pági‐ RW - - Define el factor de zoom de una imagen o una ven‐
na 1267) tana de imagen.
Tabla 1-88 Métodos

sional ced
jada.

VB Scripting
ScriptDiagnostics (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Ventana de la aplicación". El objeto ApplicationWindow es un elemento


HMIApplicationWindow

R Lectura
- Ningún acceso

sional ced
BorderEnabled (Pági‐ RW - - Define si la ventana se representará con borde en
na 576) runtime.
Bounds - - - -
GSCRuntimeAllowed - - - -

VB Scripting

sional ced
Location - - - -
Name - - - -
ShowCaption (Pági‐ RW - - Define si se muestra la barra de título.
na 941)
Size - - - -
TabIndex - - - -
Template (Página 1014) RW - - Define la plantilla para mostrar el contenido de la
ventana del objeto "Trabajo de impresión/diagnósti‐
co de script".
Top (Página 1099) - - - -
WindowCloseEnabled RW - - Determina si puede cerrarse una ventana en runti‐
(Página 1238) me.
WindowMaximizeEna‐ RW - - Define si el objeto se puede maximizar en runtime.
bled (Página 1238)
WindowMovingEnabled RW - - Define si el objeto se puede desplazar en runtime.
(Página 1239)
WindowOnTop (Pági‐ RW - - Define si el objeto permanece siempre en primer
WindowsContents (Pá‐ RW - - Define el contenido del trabajo de impresión o del
gina 1240) diagnóstico de script.
WindowSizingEnabled RW - - Define si puede modificarse el tamaño.
(Página 1241)
Tabla 1-90 Métodos

sional ced
AUTOHOTSPOT Sí - - Activa el área permanente o la imagen raíz.
AUTOHOTSPOT Sí - - Activa dinámicamente un disparador y el ciclo fijado
AUTOHOTSPOT Sí - - Desactiva en/durante el runtime el disparador usado
jada.
Consulte también
ActivateDynamic (Página 1270)

VB Scripting
DeactivateDynamic (Página 1277)

Name (Página 839)
Slider (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Deslizador". El objeto Slider es un elemento de la lista ScreenItems.

HMISlider

R Lectura
- Ningún acceso

sional ced
AlarmLowerLimitColor - - - -
AlarmUpperLimitColor - - - -

VB Scripting

sional ced
Authorization (Pági‐ RW RW RW Define los derechos de manejo.
na 528)
na 542)
BackPicture (Pági‐ RW - - Define el gráfico del fondo.
na 549)
BarBackColor (Pági‐ RW RW RW Define el color del fondo de barra en el objeto indi‐
na 551) cado.
BarColor (Página 554) RW RW RW Define el color de la barra.
BarOrientation - - - -
BorderBrightColor3D RW RW RW Define el color de las siguientes partes del borde
(Página 572) para la representación tridimensional.
BorderColor - - - -
BorderInnerStyle3D RW - - Define el modo de representación de la parte interior
(Página 583) del borde del objeto.
BorderInnerWidth3D RW RW RW Define el ancho del borde interior en una represen‐
(Página 584) tación tridimensional.
BorderOuterStyle3D - - - -
BorderOuterWidth3D RW RW RW Define el ancho del borde exterior en una represen‐
(Página 586) tación tridimensional.
BorderShadeColor3D RW RW RW Define el color de las siguientes partes del borde
(Página 586) para la representación tridimensional.
na 589)
Bounds - - - -
Caption (Página 598) RW RW RW Define el texto que se mostrará en la barra de título.
ContinousChange (Pá‐ RW - - Determina si el valor de la propiedad "ProcessVa‐
gina 645) lue" se transfiere al soltar el botón del ratón o direc‐
tamente al modificar la posición del deslizador en
runtime.
DeviceStyle - - - -
EdgeStyle - - - -
runtime.
Flashing (Página 704) RW - - Determina que esté activado el parpadeo.
FocusColor (Pági‐ RW RW RW Define el color del borde del foco cuando está resal‐
FocusWidth (Pági‐ RW RW RW Define el ancho del borde del foco cuando está re‐
ForeColor (Página 724) RW RW RW Define el color de fuente del texto.

VB Scripting

sional ced
ForeColorTransparency - - - -
LabelColor (Página 771) RW RW RW Define el color de rotulación de la escala.
Location - - - -
MaximumValue (Pági‐ RW RW RW Define el valor máximo de la escala en el objeto in‐
na 811) dicado.
na 834) dicado.
Name (Página 839) RW - - Define el nombre del objeto.
PositionFont (Pági‐ RW - - Define la fuente de la rotulación del deslizador.
na 884)
ScaleLabelFieldLength - - - -
ScalePosition - - - -
ShowBar (Página 941) RW RW RW Define si el valor de proceso visualizado se muestra
adicionalmente con una barra rellena.
ShowLimitLines - - - -
ShowLimitMarkers - - - -
ShowPosition (Pági‐ RW RW RW Determina si el valor de la posición actual del desli‐
na 952) zador debe mostrarse adicionalmente en formato
numérico.
ShowScale - - - -
ShowThumb (Pági‐ R RW RW Determina si debe mostrarse el deslizador del objeto
na 959) "Slider".
ShowTickLabels (Pági‐ R RW RW Determina si debe mostrarse la rotulación en la es‐
na 960) cala.
ShowTicks (Página 961) R RW RW Define si deben mostrarse las marcas en la escala.
Size - - - -
StyleItem - - - -
TabIndex - - - -
ThumbBackColor (Pági‐ R RW RW Define el color de fondo del deslizador.
na 1021)
ThumbPicture (Pági‐ R - - Devuelve un gráfico para el elemento de mando del
na 1022) deslizador.
TickStyle (Página 1023) R - - Devuelve la representación de las marcas de la es‐
cala.
Top (Página 1099) R RW RW Define el valor de la coordenada Y.

VB Scripting

sional ced
objeto.
Visible (Página 1222) R RW RW Define si el objeto indicado será visible.
Tabla 1-92 Métodos

sional ced
Activate (Página 1268) sí sí sí Activa el área permanente o la imagen raíz.
ActivateDynamic (Pági‐ sí - - Activa dinámicamente un disparador y el ciclo fijado
DeactivateDynamic (Pá‐ sí - - Desactiva en/durante el runtime el disparador usado
jada.
SmartClientView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Visor Sm@rtClient". El objeto SmartClientView es un elemento de la

lista ScreenItems.

HMISmartClientView

R Lectura
- Ningún acceso

sional ced
AdressPreview - - - -
AllowMenu - - - -
Bounds - - - -
ConnectionType - - - -
ConnectOnStart - - - -
runtime.
EncryptCommunication - - - -
Flashing - - - -
Font - - - -
Height - - - -
LocalCursor - - - -
Location - - - -
Machine - - - -
MachineName (Pági‐ - RW RW Determina el ID de red del dispositivo que debe vi‐
na 809) gilarse.
Name - - - -
Password (Página 872) - RW RW Define la contraseña para establecer la supervisión
a distancia.
PasswordsMust‐ - - - -
BeEncrypted
ScaleDenominator - - - -
ScaleNumerator - - - -
Scaling - - - -

VB Scripting

sional ced
ServerScale - - - -
Shared - - - -
ShowControls - - - -
Size - - - -
TabIndex - - - -
TcpPortNr - - - -
UseCurserKeyScroll - - - -
ViewOnly (Página 1220) - RW RW Define si el visor Sm@rtClient debe utilizarse para
la monitorización o el mantenimiento a distancia.
Width - - - -
Tabla 1-94 Métodos

sional ced
StatusForce (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Tabla de observación". El objeto StatusForce es un elemento de la lista

ScreenItems.

HMIStatusForce

R Lectura
- Ningún acceso

sional ced
Appearance - - - -
na 528)
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
lor
set
Color
Color
tOffset

VB Scripting

sional ced
ColumnOrder - - - -
ColumnTextBit - - - -
ColumnTextConnection - - - -
ColumnTextDataType - - - -
ColumnTextDbNumber - - - -
ColumnTextFormat - - - -
ColumnTextOffset - - - -
ColumnTextRead - - - -
ColumnTextType - - - -
ColumnTextWrite - - - -
ColumnWidth - - - -
CountVisibleItems - - - -
DeviceStyle - - - -
EdgeStyle - - - -
runtime.
FitToSize - - - -
Flashing - - - -
Height - - - -
ListAreaLeft - - - -
ListAreaTop - - - -
Location - - - -
Name - - - -
Object - - - -
PaddingLeft - - - -
PaddingTop - - - -

VB Scripting

sional ced
PLCFilter - - - -
SetOfVisibleColumns - - - -
ShowReadButton - - - -
ShowTableGridlines - RW RW Define si en la tabla se mostrarán líneas de cuadrí‐
(Página 959) cula.
ShowWriteButton - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor (Pági‐ - RW RW Define el color de fondo de las celdas de tabla.
na 1001)
lor
TableFont - - - -
na 1005) objeto.
TableGridlineColor - - - -
TableHeaderBackColor - RW RW Define el color de fondo del encabezado de la tabla.
(Página 1007)
FillStyle
BackColor
lor
Width
dius
dientColor
dientOffset
(Página 1009) bla del objeto indicado.
dientColor
Bottom

VB Scripting

sional ced
gLeft
gRight
Top
GradientColor
GradientOffset
ToolTipText (Pági‐ - R R Define el texto del tooltip.
na 1098)
dient
ma
Gradient
condGradient
Width - - - -
Tabla 1-96 Métodos

sional ced

VB Scripting
Switch (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Interruptor". El objeto Switch es un elemento de la lista ScreenItems.

Propiedad "Interruptor con texto" "Interruptor con gráfico" "Interruptor"

CaptionColor (Pági‐ -- -- x
na 600)
CaptionText (Pági‐ -- -- x
na 602)
HorizontalAlignment X -- --
(Página 748)
InnerBackColorOff (Pá‐ -- -- x
gina 756)
InnerBackColorOn (Pá‐ -- -- x
gina 757)
TextOn (Página 1018) x -- x
TextOff (Página 1017) x -- x
VerticalAlignment (Pá‐ x -- --
gina 1217)

VB Scripting

HMISwitch

R Lectura
- Ningún acceso

sional ced
na 528)
BackFlashingColorOff - - - -
BackFlashingColorOn - - - -
BackFlashingEnabled - - - -
BackFlashingRate - - - -
BorderBrightColor3D - - - -
BorderColor - - - -
BorderFlashingColorOff - - - -
BorderFlashingColorOn - - - -
BorderFlashingEnabled - - - -
BorderFlashingRate - - - -
BorderShadeColor3D - - - -
BorderWidth - - - -
CaptionColor (Pági‐ - RW RW Define el color del texto que visualizará en la barra
na 600) de título.
CaptionFont - - - -
CaptionText (Pági‐ - RW RW Define el texto que se mostrará en la barra de título.
na 602)
CornerStyle - - - -
DeviceStyle - - - -
DrawInsideFrame - - - -
EdgeStyle - - - -

VB Scripting

sional ced
runtime.
FirstGradientColor - - - -
FirstGradientOffset - - - -
Flashing - - - -
tion
Font - - - -
Height - - - -
HorizontalAlignment - RW RW Define la alineación horizontal del texto.
(Página 748)
HorizontalPictureAlign‐ - - - -
ment
HotKey - - - -
InnerBackColorOff (Pá‐ - RW RW Define el color debajo del deslizador del objeto
gina 756) "Switch" cuando el objeto está en estado OFF.
InnerBackColorOn (Pá‐ - RW RW Define el color debajo del deslizador del objeto
gina 757) "Switch" cuando el objeto está en estado ON.
LineEndShapeStyle - - - -
Location - - - -
MiddleGradientColor - - - -
Mode - - - -
Name - - - -
OnValue - - - -
PictureAreaBottomMar‐ - - - -
gin
PictureAreaLeftMargin - - - -
PictureAreaRightMargin - - - -
PictureAreaTopMargin - - - -

VB Scripting

sional ced
PictureAutoSizing - - - -
PictureOff - - - -
PictureOn - - - -
SecondGradientColor - - - -
SecondGradientOffset - - - -
ShowCaption - - - -
Size - - - -
StyleItem - - - -
SwitchOrientation - - - -
TabIndex - - - -
TextAreaBottomMargin - - - -
TextAreaLeftMargin - - - -
TextAreaRightMargin - - - -
TextAreaTopMargin - - - -
TextOff (Página 1017) - R R Devuelve el texto que se muestra en el estado "Off".
TextOn (Página 1018) - R R Devuelve el texto que se muestra en el estado "On".
TextOrientation - - - -
ToolTipText (Pági‐ - R R Devuelve el texto del tooltip.
na 1098)
ma
UseFirstGradient - - - -
UseSecondGradient - - - -
VerticalAlignment (Pági‐ - R R Devuelve la alineación vertical del texto en el objeto
na 1217) indicado.
VerticalPictureAlign‐ - - - -
ment
Width - - - -
Tabla 1-98 Métodos

sional ced

VB Scripting
SymbolicIOField (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo E/S simbólico". El objeto SymbolicIOField es un elemento de la

lista ScreenItems.
Propiedad "Entrada" "Salida" "Entrada/salida" "Dos estados"

BackColor (Pági‐ x x x x
na 537)
BorderColor (Pági‐ -- x -- x
na 573)
BorderWidth (Pági‐ -- -- -- x
na 589)
Enabled (Pági‐ x -- x --
na 672)
HelpText (Pági‐ x -- x --
na 736)
VerticalAlignment -- x -- x
(Página 1217)
HorizontalAlignment -- x -- x
(Página 748)

VB Scripting

HMISymbolicIOField

R Lectura
- Ningún acceso

sional ced
AcceptOnExit (Pági‐ RW - - Define si el campo de entrada se confirmará auto‐
na 502) máticamente al salir de él.
Assignments (Pági‐ RW - - Establece un listado que contiene las asignaciones
na 527) entre el valor de salida y el texto de salida que real‐
mente se mostrará.
na 528) en runtime.
na 542)
(Página 545) "On".
BitNumber (Página 557) RW - - Define el bit cuyo estado debe cambiar para que se
produzca una modificación del valor.
na 573)

VB Scripting

sional ced
na 587) cado.
na 589)
CaptionBackColor (Pá‐ RW - - Determina el color de fondo de la barra de título del
CaptionColor (Pági‐ RW - - Determina el color del texto en el que se debe vi‐
na 600) sualizar la barra de título del objeto indicado.
na 647)
gina 650) ción.
CursorControl (Pági‐ RW - - Define si el puntero del ratón saltará al siguiente
na 651) campo de la secuencia de tabulación tras salir del
campo.
DeviceStyle - - - -
EditOnFocus (Pági‐ RW - - Determina si la entrada de datos será posible de
na 671) inmediato cuando se seleccione el campo de entra‐
da con la tecla de tabulación.
runtime.
EvenRowBackColor - - - -
ExtraHeightOffset - - - -
FillPatternColor (Pági‐ R - - Devuelve el color del patrón de relleno del objeto
na 697) indicado.
Flashing - - - -
FlashingColorOff (Pági‐ R - - Devuelve el color de la línea de borde del objeto
na 706) indicado para el estado de parpadeo "Off".
FlashingColorOn (Pági‐ R - - Devuelve el color de la línea de borde del objeto
na 708) indicado para el estado de parpadeo "On".
FlashingEnabled (Pági‐ R - - Devuelve si la línea de borde del objeto indicado
na 710) parpadea en runtime.
tion

VB Scripting

sional ced
FlashingRate (Pági‐ R - - Devuelve la frecuencia de parpadeo de la línea de
FocusColor - - - -
FocusWidth - - - -
Font - - - -
FontBold (Página 720) R - - Devuelve si el texto del objeto indicado se muestra
en negrita.
FontItalic (Página 721) R - - Devuelve si el texto del objeto indicado se muestra
en cursiva.
FontName (Página 722) R - - Devuelve la fuente del objeto indicado.
FontSize (Página 723) R - - Devuelve el tamaño de fuente del texto del objeto
indicado.
FontUnderline (Pági‐ R - - Devuelve si el texto del objeto indicado se muestra
na 724) subrayado.
ForeColor (Página 724) R RW RW Establece el color de fuente del texto del objeto in‐
dicado.
HorizontalAlignment R RW RW Determina la alineación horizontal del texto dentro
InputValue (Página 759) R - - Devuelve el valor de entrada.
ItemBorderStyle (Pági‐ R - - Devuelve el tipo de líneas de separación en la lista
na 762) de selección del objeto indicado.
Layer (Página 776) R RW RW Dentro de la imagen, define el nivel en el que se
Left (Página 782) R RW RW Define el valor de la coordenada X del objeto indi‐
cado.
LeftMargin - - - -
LineEndShapeStyle R - - Devuelve la forma de los finales de línea.
(Página 800)
Location - - - -
LogOperation (Pági‐ R - - Devuelve si se emite un aviso al sistema de avisos
Mode (Página 836) R - - Devuelve el tipo de campo del objeto indicado.
Name - - - -
OnValue - - - -
ProcessValue (Pági‐ R - - Devuelve el ajuste predeterminado para el valor que
na 886) debe mostrarse.
RightMargin - - - -
SelectBackColor (Pági‐ R - - Devuelve el color de fondo de la entrada de texto
na 918) seleccionada del objeto indicado.
SelectForeColor (Pági‐ R - - Devuelve el color de la entrada de texto selecciona‐
na 926) da del objeto indicado.

VB Scripting

sional ced
SeparatorBackColor R - - Devuelve el color de fondo de las líneas de separa‐
(Página 933) ción quebradas en la lista de selección del objeto
indicado.
SeparatorColor (Pági‐ R - - Devuelve el color de las líneas de separación en la
na 934) lista de selección del objeto indicado.
SeparatorCornerStyle R - - Devuelve la forma de las esquinas del objeto indica‐
(Página 935) do.
SeparatorLineEndSha‐ R - - Devuelve la forma de los finales de línea del objeto
peStyle (Página 935) indicado.
SeparatorStyle (Pági‐ R - - Devuelve el tipo de líneas de separación en la lista
na 936) de selección del objeto indicado.
SeparatorWidth (Pági‐ R - - Devuelve el ancho de las líneas de separación en
na 936) la lista de selección del objeto indicado.
ShowBadTagState (Pá‐ R - - Devuelve si el objeto se muestra atenuado cuando
gina 940) el QualityCode o el estado de la variable no sea
bueno.
ShowDropDownButton R - - Define si se mostrará un botón para la lista de se‐
(Página 943) lección.
ShowDropDownList - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TextList (Página 1016) R - - Devuelve un listado que contiene las asignaciones
entre el valor de salida y el texto de salida que real‐
mente se mostrará.
TextOff - - - -
TextOn - - - -
TextOrientation (Pági‐ R - - Devuelve la dirección del texto del objeto indicado.
na 1018)
ToolTipText (Pági‐ R R R Devuelve el texto del tooltip.
na 1098)
Top (Página 1099) R R R Devuelve el valor de la coordenada Y del objeto in‐
dicado.
TopMargin - - - -
objeto.
tings (Página 1167) do fijado en el diseño activo.
VerticalAlignment (Pági‐ R RW RW Determina la alineación vertical del texto en el objeto
na 1217) indicado.

VB Scripting
Tabla 1-100 Métodos

sional ced
jada.
SymbolLibrary (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Librería de símbolos". El objeto SymbolLibrary es un elemento de la

lista ScreenItems.

HMISymbolLibrary

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
na 542)
BlinkColor (Página 558) RW RW RW Define el color con el que parpadeará el objeto en
runtime.
BlinkMode (Página 559) RW - - Define el tipo de gráfico intermitente para el objeto
indicado.
BlinkSpeed (Pági‐ RW - - Determina la frecuencia de parpadeo.
na 560)
Bounds - - - -
ChangeMouseCursor RW - - Define si el aspecto del puntero del ratón permane‐
(Página 608) cerá invariable en runtime cuando se encuentre so‐
bre el símbolo.
runtime.
FillColorMode (Pági‐ RW - - Determina el tipo de primer plano para el objeto in‐
na 696) dicado.
FixedAspectRatio (Pági‐ RW - - Determina si la relación de aspecto se mantiene o
na 703) puede modificarse en caso de cambiarse el tamaño
del símbolo.
Flashing - - - -
tion
Flip (Página 714) RW - - Define si el símbolo se volteará por su eje central
vertical u horizontal.
Location - - - -
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -

VB Scripting

sional ced
Rotation (Página 895) RW - - Define el ángulo de giro en grados.
Size - - - -
TabIndex - - - -

sional ced
jada.
SysDiagControl (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

VB Scripting
Representa el objeto "Visor de diagnóstico del sistema". El objeto SystemDiagnoseView es

un elemento de la lista ScreenItems.

HMISysDiagView

R Lectura
- Ningún acceso

sional ced
BackgroundColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
BufferViewColumnOr‐ - - - -
der
BufferViewInternalRo‐ - - - -
wOrder
BusyText - - - -
lor
set
Color
Color
tOffset
BV_ColumnWidth_Date - - - -

VB Scripting

sional ced
BV_Column‐ - - - -
Width_Event
Width_EventSeverity
Width_EventState
Width_Number
BV_ColumnWidth_Time - - - -
BV_ItemText_Date - - - -
BV_ItemText_Event - - - -
BV_ItemText_EventSe‐ - - - -
verity
BV_ItemText_EventSta‐ - - - -
te
BV_ItemText_Number - - - -
BV_ItemText_Time - - - -
BV_ShowItem_Date - - - -
BV_ShowItem_Event - - - -
BV_ShowItem_Event‐ - - - -
Severity
BV_ShowItem_EventS‐ - - - -
tate
BV_ShowItem_Number - - - -
BV_ShowItem_Time - - - -
ColumnSettings - - - -
ColumnSettingsBuffer‐ - - - -
View
ComplexViewToolbar - - - -
ComplexViewToolbar‐ - - - -
Bounds
ComponentInfoText - - - -
DeviceStyle - - - -
EdgeStyle - - - -
Enabled (Página 672) R R R Devuelve si el objeto indicado se puede manejar en
runtime.
EnterButtonVisible - - - -
Es2RtTableBounds - - - -
EscButtonVisible - - - -
EsPreviewType - - - -
FitToSize - - - -
FitToSizeLowerRows - - - -

VB Scripting

sional ced
FitToSizeUpperRows - - - -
Flashing - - - -
HomeButtonVisible - - - -
InfoArea_Background‐ - - - -
Color
InfoArea_ColumnsMo‐ - - - -
vable
InfoArea_DefaultText‐ - - - -
Color
InfoArea_ErrorText‐ - - - -
BackgroundColor
InfoArea_ErrorTextCo‐ - - - -
lor
InfoArea_FocusFrame‐ - - - -
Color
InfoArea_FocusFrame‐ - - - -
Width
InfoArea_Font - - - -
InfoArea_RootNodeText - - - -
InfoArea_Selection‐ - - - -
BackgroundColor
InfoArea_SelectionFo‐ - - - -
regroundColor
InfoArea_ShowGridLi‐ - - - -
nes
InfoArea_TableHeader‐ - - - -
BackgroundColor
InfoArea_TableHeader‐ - - - -
TextColor
InputAddressText - - - -
InspectorViewInternal‐ - - - -
ColumnOrder
InspectorViewRowOr‐ - - - -
der
ItemText_AKZ - - - -
ItemText_Descriptor - - - -
ItemText_ErrorText - - - -
ItemText_HardwareRe‐ - - - -
vision
ItemText_IMDataVer‐ - - - -
sion
ItemText_Installation‐ - - - -
Date
ItemText_LADDR - - - -

VB Scripting

sional ced
ItemText_Manufacture‐ - - - -
rID
ItemText_Name - - - -
ItemText_OKZ - - - -
ItemText_OperationSta‐ - - - -
te
ItemText_OrderID - - - -
ItemText_ProfileID - - - -
ItemText_Rack - - - -
ItemText_Revision‐ - - - -
Counter
ItemText_SerialNumber - - - -
ItemText_Slot - - - -
ItemText_SoftwareRevi‐ - - - -
sion
ItemText_SpecificProfi‐ - - - -
leData
ItemText_State - - - -
ItemText_Station - - - -
ItemText_SubAddress - - - -
ItemText_SubSlot - - - -
ItemText_SubSystem - - - -
ItemText_Type - - - -
IV_ShowItem_AKZ - - - -
IV_ShowItem_Descrip‐ - - - -
tor
IV_ShowItem_ErrorText - - - -
IV_ShowItem_Hardwa‐ - - - -
reRevision
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

VB Scripting

sional ced
IV_ShowItem_Serial‐ - - - -
Number
IV_ShowItem_Slot - - - -
IV_ShowItem_Software‐ - - - -
Revision
IV_ShowItem_Specific‐ - - - -
ProfileData
IV_ShowItem_State - - - -
IV_ShowItem_Station - - - -
IV_ShowItem_SubAd‐ - - - -
dress
IV_ShowItem_SubSlot - - - -
IV_ShowItem_SubSys‐ - - - -
tem
IV_ShowItem_Type - - - -
Layer (Página 776) R R R Dentro de la imagen, devuelve el nivel en el que se
Left (Página 782) R R R Devuelve el valor de la coordenada X.
LinesPerDiagEntry - - - -
Location - - - -
MaxToolbarRows - - - -
Name - - - -
NavigateTo (Pági‐ RW - - -
na 842)
NavigationButtons - - - -
NavigationPath_Font - - - -
NavigationPath_Root‐ - - - -
Text
NavigationPath_Text‐ - - - -
Color
NavigationpathDiagbuf‐ - - - -
ferDetailText
NavigationpathDiagbuf‐ - - - -
ferText
OutputAddressText - - - -
PaddingLeft - - - -
PaddingTop - - - -
RTPersistence - - - -
RTPersistenceAuthori‐ - - - -
zation
RTPersistenceType - - - -
ShowMilliseconds - - - -
ShowNavigationButtons - - - -

VB Scripting

sional ced
ShowPathInformation - - - -
ShowSplittedView - - - -
ShowToolbarBack‐ - - - -
groundColor
SimpleViewToolbar - - - -
Size - - - -
SplittedViewRatio - - - -
StyleItem - - - -
SupportsInplaceEdit - - - -
SysDiagBuffButtonVisi‐ - - - -
ble
TabIndex - - - -
lor
TableGridlineColor - - - -
FillStyle
BackColor
lor
Width
dius
dientColor
dientOffset
dientColor
Bottom
gLeft
gRight
Top
GradientColor
GradientOffset

VB Scripting

sional ced
ToolBar_ButtonsHeight - - - -
ToolBar_ButtonsWidth - - - -
ToolbarAlignment - - - -
ToolbarBackgroundCo‐ - - - -
lor
ToolbarButtonClick - - - -
ToolbarButtonHeight - - - -
ToolbarButtonSettings - - - -
ToolbarButtonWidth - - - -
ToolbarIconStyle - - - -
Top (Página 1099) R R R Devuelve el valor de la coordenada Y.
UnitViewColumnOrder - - - -
UpdateButtonVisible - - - -
dient
ma
UseScadaRendererSty‐ - - - -
le
UseSystemScrollbar‐ - - - -
Width
Gradient
condGradient
UV_ColumnWidth_AKZ - - - -
UV_ColumnWidth_Des‐ - - - -
criptor
UV_ColumnWidth_Ins‐ - - - -
tallationDate
UV_Column‐ - - - -
Width_LADDR
UV_ColumnWidth_Na‐ - - - -
me
UV_ColumnWidth_OKZ - - - -
UV_ColumnWidth_Ope‐ - - - -
rationState
UV_ColumnWidth_Or‐ - - - -
derID
UV_ColumnWidth_Pro‐ - - - -
fileID
UV_ColumnWidth_Rack - - - -
UV_ColumnWidth_Slot - - - -

VB Scripting

sional ced
UV_ColumnWidth_Soft‐ - - - -
wareRevision
UV_ColumnWidth_Spe‐ - - - -
cificProfileData
UV_ColumnWidth_State - - - -
UV_ColumnWidth_Sta‐ - - - -
tion
UV_ColumnWidth_Su‐ - - - -
bAddress
Width_SubSlot
Width_SubSystem
UV_ColumnWidth_Type - - - -
UV_ShowItem_AKZ - - - -
UV_ShowItem_Descrip‐ - - - -
tor
UV_ShowItem_Installa‐ - - - -
tionDate
UV_ShowItem_LADDR - - - -
UV_ShowItem_Name - - - -
UV_ShowItem_OKZ - - - -
UV_ShowItem_Opera‐ - - - -
tionState
UV_ShowItem_OrderID - - - -
UV_ShowItem_ProfileID - - - -
UV_ShowItem_Rack - - - -
UV_ShowItem_Slot - - - -
UV_ShowItem_Softwa‐ - - - -
reRevision
UV_ShowItem_Specific‐ - - - -
ProfileData
UV_ShowItem_State - - - -
UV_ShowItem_Station - - - -
UV_ShowItem_SubAd‐ - - - -
dress
UV_ShowItem_SubSlot - - - -
UV_ShowItem_SubSys‐ - - - -
tem
UV_ShowItem_Type - - - -
ViewType - - - -

VB Scripting

sional ced
TextField (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo de texto". El objeto TextField es un elemento de la lista

ScreenItems.

HMITextField

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
na 542)
(Página 545) "On".
(Página 547)
gina 548)
na 570) brada.
na 573)
(Página 582) de.
AUTOHOTSPOT RW - - Define el tipo de líneas de borde.
na 589)
Bounds - - - -
na 647)
runtime.

VB Scripting

sional ced
na 697)
Flashing - - - -
na 710)
na 712) de.
Font - - - -
na 724)
HorizontalAlignment RW RW RW Define la alineación horizontal del texto.
(Página 748)
Layer (Página 776) R R R Dentro de la imagen, devuelve el nivel en el que se
LeftMargin - - - -
(Página 800)
LineWrap - - - -
Location - - - -
Name - - - -
na 893)
ReSizeable - - - -
RightMargin - - - -
na 895)
na 948)
Size - - - -

VB Scripting

sional ced
TabIndex - - - -
Text (Página 1015) RW RW RW Define el título del campo de texto.
na 1018)
ToolTipText (Pági‐ RW R R Define el texto del tooltip.
na 1098)
TopMargin - - - -
na 1103) centaje.
te objeto.
VerticalAlignment (Pági‐ RW RW RW Determina la alineación vertical del texto en el objeto
na 1217) indicado.

sional ced
jada.

VB Scripting
TrendRulerControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Tabla de valores". El objeto TrendRulerControl es un elemento de la

lista ScreenItems.

HMITrendRulerControl
Ejemplo
En el siguiente ejemplo, el objeto denominado "Control1" se desplazará 16 píxeles hacia la
derecha:
'VBS60
Dim objControl

R Lectura
- Ningún acceso

VB Scripting

sional ced
ForDesignMode
radas.
AutoPosition (Pági‐ RW - - Determina si la tabla de valores se coloca automáti‐
na 531) camente debajo del objeto que suministra datos a la
tabla de valores.
tema.
AutoShow (Página 534) RW - - Determina si la tabla de valores se muestra automá‐
ticamente.
BlockAlignment (Pági‐ RW - - Define la alineación del texto dentro del título de la
na 560) columna del bloque referenciado.
BlockAutoPrecisions RW - - Determina si el número de decimales visualizados
(Página 561) en el bloque actual se ajusta automáticamente.
BlockCaption (Pági‐ RW - - Define el título del bloque actual.
na 562)
BlockCount (Pági‐ RW - - Define el número de bloques.
na 562)
BlockDateFormat (Pági‐ RW - - Define el formato para la indicación de fecha en el
na 563) bloque actual.
BlockExponentialFor‐ RW - - Define si los valores del bloque actual se muestran
mat (Página 563) en representación exponencial.
BlockHideText - - - -
BlockHideTitleText (Pá‐ RW - - Define si el título del bloque se muestra como texto.
gina 564)
BlockId (Página 564) RW - - Hace referencia a un bloque mediante su ID de blo‐
que.
BlockIndex (Página 565) RW - - Hace referencia a un bloque.
BlockLength (Pági‐ RW - - Define el número de caracteres del bloque actual.
na 565)
BlockName (Pági‐ RW - - Determina el nombre del bloque actual.
na 566)
BlockPrecisions (Pági‐ RW - - Define el número de decimales del bloque actual.
na 566)
Blocks - - - -

VB Scripting

sional ced
BlockShowDate (Pági‐ RW - - Define que se muestre la fecha en el bloque actual.
na 567)
BlockShowIcon (Pági‐ RW - - Define si el contenido del bloque actual se muestra
na 568) como símbolo.
BlockShowTitleIcon RW - - Define si se muestra el título del bloque actual como
(Página 568) símbolo.
BlockTimeFormat (Pági‐ RW - - Define el formato de la indicación de hora del bloque
na 569) actual.
BlockUseSourceFormat RW - - Define si en el bloque actual se utiliza el formato del
(Página 569) control enlazado.
na 573)
na 589)
Bounds - - - -
ColumnAdd (Pági‐ RW - - Crea una columna nueva.
na 614)
ColumnCount (Pági‐ RW - - Define el número de columnas configuradas.
na 616)
ColumnIndex (Pági‐ RW - - Hace referencia a una columna.
na 621)
ColumnName (Pági‐ RW - - Define el nombre de una columna referenciada me‐
na 624) diante "ColumnIndex".
ColumnRemove (Pági‐ RW - - Elimina una columna referenciada mediante su nom‐
na 627) bre.
ColumnRepos (Pági‐ RW - - En el caso de varias columnas, define la posición de
na 627) una columna referenciada mediante "ColumnIndex".
na 628) nas.
Columns - - - -
ColumnScrollbar (Pági‐ RW - - Define cuándo se mostrará la barra de desplaza‐
na 629) miento horizontal.
ColumnSort (Pági‐ RW - - Define el tipo de clasificación en una columna refe‐
na 632) renciada mediante "ColumnIndex".

VB Scripting

sional ced
ColumnSortIndex (Pági‐ RW - - Define el orden de clasificación en una columna re‐
na 633) ferenciada mediante "ColumnIndex" en la que las
columnas se clasifican de forma consecutiva.
ColumnTitleAlignment RW - - Define la alineación del título en una columna refe‐
(Página 639) renciada mediante "ColumnIndex".
na 640)
ColumnVisible (Pági‐ RW - - Define si se mostrará la columna referenciada me‐
na 641) diante "ColumnIndex" en el objeto.
(Página 646)
runtime.
(Página 688)
gina 690) Provider.
(Página 691)
na 693) rán.
FillPattern - - - -
na 730)
na 731) ción.
(Página 750)
das de la tabla.

VB Scripting

sional ced
ventana.
LineStyle - - - -
Location - - - -
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
"Informes".
RowScrollbar (Pági‐ RW - - Define cuándo se mostrará la barra de desplaza‐
na 898) miento vertical.
gina 899)
RowTitles (Página 900) RW - - Define si se mostrarán encabezados de columna
numerados.
RulerColumns - - - -
RulerType (Página 904) RW - - Define el modo de representación de la tabla de va‐
lores.
gina 919)
(Página 920)
gina 922)
(Página 923)
gina 924) nado.
(Página 925) nado.

VB Scripting

sional ced
SelectionRect (Pági‐ RW - - Define si se utilizará un borde de selección para las
na 929) celdas o filas seleccionadas.
gina 930) tana de avisos.
pe sea "1".
na 932)
ShareSpaceWithSour‐ RW - - Define que el rango de representación del origen de
ceControl (Página 939) los datos se adapte al tamaño de la tabla de valores.
na 956)
na 957)
Size - - - -
runtime.
SortSequence (Pági‐ RW - - Define cómo se modificará el orden de clasificación
na 968) cuando el operador haga clic en el título de la co‐
lumna en runtime.
SourceControl (Pági‐ RW - - Define con qué visor de tablas o de curvas se enlaza
na 969) la tabla de valores.
SourceControlType (Pá‐ RW - - Determina el tipo de la fuente de datos.
gina 970)
StatisticAreaColumns - - - -
StatisticResultColumns - - - -
(Página 973)
(Página 979)

VB Scripting

sional ced
dex".
do del objeto.
StatusbarElements (Pá‐ - - - -
gina 983)
rá en el objeto.
en píxeles.
na 987)
gina 988) estado.
na 990)
na 992) control.
TabIndex - - - -
TableColor (Pági‐ RW - - Define el color de fondo de las filas de la tabla del
na 1002) objeto.
TableColor2 (Pági‐ RW - - Define el segundo color de fondo de las filas de la

VB Scripting

sional ced
na 1005) objeto.
TitleColor (Página 1061) RW - - Define el color de fondo del título de la tabla.
demasiado pequeño.
del objeto.
del objeto.
columna.
TitleStyle (Página 1067) RW - - Define si se empleará un color de sombreado para
el texto de los encabezados de columna.
na 1075)
gina 1076)
gina 1081)
na 1084)
(Página 1085)

VB Scripting

sional ced
dex".
del objeto.
por el usuario.
UseSourceBackColors RW - - Determina que se utilice el color de fondo de la fuen‐
(Página 1173) te de datos.
UseSourceForeColors RW - - Define que se utilice el color de fuente de la fuente
(Página 1174) de datos.
na 1218)

VB Scripting

sional ced
jada.
DataRowCollection".
GetRulerBlock (Pági‐ Sí - - Devuelve el objeto de bloque designado por nombre
na 1295) o índice de la tabla de evaluación como tipo "ICCAx‐
RulerBlock".
GetRulerBlockCollec‐ Sí - - Devuelve el listado de todos los objetos de bloque
tion (Página 1296) de la tabla de evaluación como tipo "ICCAxCollec‐
tion".
GetRulerColumn (Pági‐ Sí - - Devuelve el objeto de columna designado por nom‐
na 1297) bre o índice de la tabla de evaluación como tipo "IC‐
CAxRulerColumn".
GetRulerColumnCollec‐ Sí - - Devuelve el listado de todos los objetos de columna
tion (Página 1298) de la tabla de evaluación como tipo "ICCAxCollec‐
tion".
GetStatisticAreaCo‐ Sí - - Devuelve el objeto de columna designado por nom‐
lumn (Página 1303) bre o índice de la ventana del área estadística de la
tabla de evaluación como tipo "ICCAxRulerColumn".
GetStatisticAreaCo‐ Sí - - Devuelve el listado de todos los objetos de columna
lumnCollection (Pági‐ de la ventana del área estadística de la tabla de eva‐
na 1304) luación como tipo "ICCAxCollection".
GetStatisticResultCo‐ Sí - - Devuelve el objeto de columna designado por nom‐
lumn (Página 1305) bre o índice de la ventana estadística de la tabla de
evaluación como tipo "ICCAxRulerColumn".
GetStatisticResultCo‐ Sí - - Devuelve el listado de todos los objetos de columna
lumnCollection (Pági‐ de la ventana estadística de la tabla de evaluación
na 1306) como tipo "ICCAxCollection".

VB Scripting

sional ced
na 1308) tion".
"ICCAxCollection".
tablas.
na 1367)

VB Scripting
TrendView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de curvas". El objeto TrendView es un elemento de la lista

ScreenItems.

HMITrendView

R Lectura
- Ningún acceso

sional ced
na 528) en runtime.
AxisXBunchCount - - - -
AxisXMarkCount - - - -
AxisXNoOfDigits - - - -
AxisXShowBunchVa‐ - - - -
lues

VB Scripting

sional ced
AxisXStyle - - - -
AxisY1BunchCount - - - -
AxisY1MarkCount - - - -
AxisY1ShowBunchVa‐ - - - -
lues
AxisY2BunchCount - - - -
AxisY2MarkCount - - - -
AxisY2ShowBunchVa‐ - - - -
lues
BackColor - - - -
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
ButtonBarHeight - - - -
lor
set
Color
Color
tOffset
ColumnOrder - - - -
ColumnTextDateTime - - - -
ColumnTextTagCon‐ - - - -
nection
ColumnTextTrend - - - -
ColumnTextValue - - - -
ColumnTextXValue - - - -
ColumnWidth - - - -

VB Scripting

sional ced
Curves - - - -
DeviceStyle - - - -
DiagramAreaHeight - - - -
DiagramAreaLeft - - - -
DiagramAreaTop - - - -
DiagramAreaWidth - - - -
EdgeStyle - - - -
runtime.
EnableNavigateButtons - - - -
EnableNavigateKeys - - - -
FitToSize - - - -
Flashing - - - -
FocusColor (Pági‐ - RW RW Determina el color del borde del objeto indicado
FocusWidth (Pági‐ - RW RW Determina el ancho del borde del objeto indicado
Font - - - -
GridlineAxis - - - -
GridlineColor - - - -
GridlineEnabled - - - -
GridlineFillColor - - - -
GridlineStyle - - - -
Height - - - -
Left (Página 782) - RW RW Define el valor de la coordenada X del objeto indica‐
do.
Location - - - -
Look3D - - - -
MaxNrOfCurves - - - -
MinNrOfCurves - - - -
Name - - - -
PaddingLeft - - - -
PaddingTop - - - -

VB Scripting

sional ced
RulerColor (Pági‐ - RW RW Define el color de la escala graduada (línea auxiliar)
na 903) en la rotulación del eje del objeto indicado.
ScaleColor (Pági‐ - RW RW Define el color de la escala del objeto indicado.
na 905)
SelectionBackColor - - - -
SelectionForeColor - - - -
ShowRuler (Pági‐ - RW RW Define si se mostrará una escala graduada (línea
na 953) auxiliar) para la rotulación de eje del objeto indicado.
ShowTableGridLines - - - -
ShowTimeAxis - - - -
ShowTimeAxisLabeling - - - -
ShowValueAxis1 - - - -
ShowValueAxis1Label - - - -
ShowValueAxis2 - - - -
ShowValueAxis2Label - - - -
ShowValueTable - - - -
ShowY1HlpLine - - - -
ShowY2HlpLine - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor (Pági‐ - RW RW Determina el color de fondo de las celdas de la tabla
TableColumnsWidthAn‐ - - - -
dOrder
lor
TableFont - - - -
TableGridLineColor (Pá‐ - R R Devuelve el color de las líneas de cuadrícula en la
gina 1006) tabla del objeto indicado.
TableHeaderBackColor - R R Devuelve el color de fondo del encabezado de la
(Página 1007) tabla del objeto indicado.
FillStyle
BackColor
lor
Width
dius

VB Scripting

sional ced
dientColor
dientOffset
(Página 1009) bla del objeto indicado.
dientColor
Bottom
gLeft
gRight
Top
GradientColor
GradientOffset
TagForExternalTime - - - -
TimeAxisBegin - - - -
TimeAxisBeginTime - - - -
TimeAxisCountPoints - - - -
TimeAxisEnd - - - -
TimeAxisMode - - - -
TimeAxisRange - - - -
TimeAxisSide - - - -
TimeAxisTimeRange - - - -
ToolbarButtonsForMi‐ - - - -
gration
ToolbarEnabled - - - -
ToolbarHeight - - - -
ToolbarLeft - - - -
ToolbarStyle - - - -
ToolbarTop - - - -
ToolbarWidth - - - -
Top (Página 1099) - R R Devuelve el valor de la coordenada Y del objeto in‐
dicado.
TrendsForPrinting - - - -
dient

VB Scripting

sional ced
ma
Gradient
condGradient
ValueAxis1AutoRange - - - -
ValueAxis1Begin - - - -
ValueAxis1End - - - -
ValueAxis1LabelLength - - - -
ValueAxis1Style - - - -
ValueAxis2AutoRange - - - -
ValueAxis2Begin - - - -
ValueAxis2End - - - -
ValueAxis2LabelLength - - - -
ValueAxis2Style - - - -
ValueTableHeight - - - -
ValueTableLeft - - - -
ValueTableTop - - - -
ValueTableWidth - - - -
ValueY1HlpLine - - - -
ValueY2HlpLine - - - -
Width - - - -

sional ced
Consulte también

VB Scripting
TubeArcObject (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Arco tubular". El TubeArcObject forma parte de la lista ScreenItems.

HMITubeArcObject
Utilización
En el siguiente ejemplo, el objeto denominado "TubeArcObject1" se desplazará 10 píxeles
hacia la derecha:
'VBS24
Dim objTubeArcObject
Set objTubeArcObject = ScreenItems("TubeArcObject1")
objTubeArcObject.Left = objTubeArcObject.Left + 10

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
BackColor - - - -
Bounds - - - -
CornerStyle - - - -
DrawInsideFrame - - - -
runtime.
el punto final del objeto indicado.
Flashing - - - -
LineEndShapeStyle - - - -
Location - - - -
Name - - - -
na 889)
na 890)
Size - - - -
el punto inicial.
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

VB Scripting

sional ced

sional ced
jada.
TubeDoubleTeeObject (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Pieza en T doble". El TubeDoubleTeeObject forma parte de la lista

ScreenItems.

HMITubeDoubleTeeObject

VB Scripting
Utilización
En el siguiente ejemplo, el objeto denominado "TubeDoubleTeeObject1" se desplazará 10
píxeles hacia la derecha:
'VBS21
Dim objTubeDoubleTeeObject
Set objTubeDoubleTeeObject = ScreenItems("TubeDoubleTeeObject1")
objTubeDoubleTeeObject.Left = objTubeDoubleTeeObject.Left + 10

R Lectura
- Ningún acceso

sional ced
na 528)
Bounds - - - -
runtime.
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

VB Scripting

sional ced

sional ced
jada.
TubePolyline (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Tubo". El objeto TubePolyline forma parte de la lista ScreenItems.

HMITubePolyline

VB Scripting
Utilización
En el siguiente ejemplo, el objeto denominado "TubePolyline1" se desplazará 10 píxeles hacia
la derecha:
'VBS24
Dim objTubePolyline
Set objTubePolyline = ScreenItems("TubePolyline1")
objTubePolyline.Left = objTubePolyline.Left + 10

R Lectura
- Ningún acceso

sional ced
na 507)
ActualPointLeft (Pági‐ RW - - Define la coordenada X del vértice actual referida al
na 508) origen de la imagen.
na 528)
Bounds - - - -
na 647)
DeviceStyle - - - -
runtime.
Location - - - -
Name - - - -
Points - - - -

VB Scripting

sional ced
na 883) polígono.
Size - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

sional ced
jada.

VB Scripting
TubeTeeObject (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Pieza en T". El TubeTeeObject forma parte de la lista ScreenItems.

HMITubeTeeObject
Utilización
En el siguiente ejemplo, el objeto denominado "TubeTeeObject1" se desplazará 10 píxeles
hacia la derecha:
'VBS21
Dim objTubeTeeObject
Set objTubeTeeObject = ScreenItems("TubeTeeObject1")
objTubeTeeObject.Left = objTubeTeeObject.Left + 10

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
Bounds - - - -
runtime.
Location - - - -
Name - - - -
na 895)
Size - - - -
TabIndex - - - -
na 1098)
na 1103) centaje.
te objeto.

VB Scripting

sional ced
jada.
UserArchiveControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de recetas". El objeto UserArchiveControl es un elemento de la

lista ScreenItems.

HMIUserArchiveControl

R Lectura
- Ningún acceso

VB Scripting

fessional vanced
wed
ApplyProjectSet‐ - - - -
tingsForDesignMo‐
de
ArchiveName (Pá‐ RW - - Define el nombre del fichero.
gina 524)
ArchiveType (Pági‐ RW - - Define el tipo de fichero.
na 525)
AutoCompleteCo‐ RW - - Define si se mostrarán las columnas va‐
lumns (Página 530) cías cuando el control es más ancho que
las columnas configuradas.
AutoComplete‐ RW - - Define si se mostrarán filas vacías cuando
Rows (Página 531) el control sea más largo que el número de
filas configuradas.
AutoSelectionCo‐ RW - - Define si el color de selección para celda y
lors (Página 532) fila se realizará con los colores preestable‐
cidos por el sistema.
AutoSelectionRect‐ RW - - Define si el borde de selección se repre‐
Color (Página 533) sentará en el color definido por el sistema.
BackColor (Pági‐ RW - - Define el color de fondo.
na 537)
Blocks - - - -
na 573)
na 589)
Bounds - - - -
Caption (Pági‐ RW - - Define el texto que se mostrará en la barra
na 598) de título.
CellCut - - - -
CellSpaceBottom RW - - Establece la distancia inferior que se utili‐
(Página 604) zará en las celdas de la tabla.
CellSpaceLeft (Pá‐ RW - - Define el sangrado izquierdo que se utili‐
gina 604) zará en las celdas de la tabla.
CellSpaceRight RW - - Define el sangrado derecho que se utiliza‐
(Página 605) rá en las celdas de la tabla.
CellSpaceTop (Pá‐ RW - - Establece la distancia superior que se utili‐
gina 606) zará en las celdas de la tabla.
Closeable (Pági‐ RW - - Define si el objeto se puede cerrar en run‐
na 611) time.
ColumnAlias (Pági‐ RW - - Define el nombre de visualización de la co‐
na 614) lumna referenciada mediante "ColumnIn‐
dex".

VB Scripting

fessional vanced
ColumnAlignment RW - - Define la alineación del contenido de la co‐
(Página 615) lumna en una columna referenciada me‐
diante "ColumnIndex".
ColumnAutoPreci‐ RW - - Define si se determinará automáticamente
sions (Página 615) el número de decimales de una columna
referenciada mediante "ColumnIndex".
ColumnCaption RW - - Determina el título de la columna actual.
(Página 616)
ColumnCount (Pá‐ RW - - Define el número de columnas configura‐
gina 616) das.
ColumnDateFor‐ RW - - Determina el formato de la indicación de
mat (Página 617) fecha.
ColumnDMVarNa‐ RW - - Determina el nombre de una variable.
me (Página 618)
ColumnExponen‐ RW - - Define si los valores de una columna refe‐
tialFormat (Pági‐ renciada mediante "ColumnIndex" se mos‐
na 618) trarán en representación exponencial.
ColumnFlagNot‐ RW - - Define si el campo del fichero de usuario
Null (Página 619) asignado a una columna referenciada me‐
diante "ColumnIndex" debe tener un valor.
ColumnFlagUnique RW - - Define si el campo del fichero de usuario
(Página 619) asignado a una columna referenciada me‐
diante "ColumnIndex" debe tener un valor
único.
ColumnHideText RW - - Define si se ocultará el texto de una colum‐
(Página 620) na referenciada mediante "ColumnIndex".
ColumnHideTitle‐ RW - - Define si se ocultará el encabezado de una
Text (Página 620) columna referenciada mediante "Colum‐
nIndex".
ColumnIndex (Pági‐ RW - - Hace referencia a una columna.
na 621)
ColumnLeadingZe‐ RW - - Define con cuántos ceros a la izquierda se
ros (Página 622) mostrarán los valores en una columna re‐
ferenciada mediante "ColumnIndex".
ColumnLength (Pá‐ RW - - Define el número de caracteres mostrados
gina 622) en una columna referenciada mediante
"ColumnIndex".
ColumnMaxValue RW - - Define el valor máximo definido en el fiche‐
(Página 623) ro de usuario de una columna referenciada
mediante "ColumnIndex".
ColumnMinValue RW - - Define el valor mínimo especificado en el
(Página 623) fichero de usuario de una columna referen‐
ciada mediante "ColumnIndex".
ColumnName (Pá‐ RW - - Define el nombre de una columna referen‐
gina 624) ciada mediante "ColumnIndex".
ColumnPosition RW - - Define la posición de una columna referen‐
(Página 625) ciada mediante "ColumnIndex".

VB Scripting

fessional vanced
ColumnPrecisions RW - - Define el número de decimales en una co‐
(Página 625) lumna referenciada mediante "ColumnIn‐
dex".
ColumnReadAc‐ RW - - Define el permiso especificado en el fiche‐
cess (Página 626) ro de usuario para el acceso de lectura a
una columna referenciada mediante "Co‐
lumnIndex".
ColumnReadonly RW - - Define si los valores de una columna refe‐
(Página 626) renciada mediante "ColumnIndex" son de
solo lectura.
ColumnRepos (Pá‐ RW - - En el caso de varias columnas, define la
gina 627) posición de una columna referenciada me‐
diante "ColumnIndex".
ColumnResize (Pá‐ RW - - Define si se puede modificar el ancho de
gina 628) las columnas.
Columns - - - -
ColumnScrollbar RW - - Define cuándo se mostrará la barra de des‐
(Página 629) plazamiento horizontal.
ColumnShowDate RW - - Define si se mostrará la fecha en una co‐
dex".
ColumnShowIcon RW - - Define si se mostrará un símbolo en una
(Página 631) columna referenciada mediante "Colum‐
nIndex".
ColumnShowTitleI‐ RW - - Define si se mostrará un símbolo en una
con (Página 631) columna referenciada mediante "Colum‐
nIndex".
ColumnSort (Pági‐ RW - - Define el tipo de clasificación en una co‐
na 632) lumna referenciada mediante "ColumnIn‐
dex".
ColumnSortIndex RW - - Define el orden de clasificación en una co‐
dex" en la que las columnas se clasifican
de forma consecutiva.
ColumnStartValue RW - - Define el valor inicial especificado en el fi‐
(Página 633) chero de usuario de una columna referen‐
ColumnStrin‐ RW - - Define la longitud de la cadena de caracte‐
gLength (Pági‐ res especificada en el fichero de usuario
na 634) de una columna referenciada mediante
"ColumnIndex".
ColumnTimeFor‐ RW - - Define el formato de la indicación de hora
mat (Página 638) en una columna referenciada mediante
"ColumnIndex".
ColumnTitleAlign‐ RW - - Define la alineación del título en una co‐
ment (Página 639) lumna referenciada mediante "ColumnIn‐
dex".
ColumnTitles (Pági‐ RW - - Define si se mostrará el título de las colum‐
na 640) nas.

VB Scripting

fessional vanced
ColumnType (Pági‐ RW - - Define el tipo de datos especificado en el
na 641) fichero de usuario de una columna referen‐
ColumnVisible (Pá‐ RW - - Define si se mostrará la columna referen‐
gina 641) ciada mediante "ColumnIndex" en el obje‐
to.
ColumnWriteAc‐ RW - - Define el permiso especificado en el fiche‐
cess (Página 642) ro de usuario para el acceso de escritura a
una columna referenciada mediante "Co‐
lumnIndex".
ControlDesignMo‐ RW - - Determina la apariencia del control.
de (Página 646)
DataProviderGuid R - - Determina el GUID del control.
(Página 655)
DataSource - - - -
DefaultFilterEom - - - -
Enabled - - - -
EnableDelete (Pá‐ RW - - Define si pueden borrarse datos en runti‐
gina 676) me.
EnableEdit (Pági‐ RW - - Determina si se pueden modificar los datos
na 676) mostrados en runtime.
EnableInsert (Pági‐ RW - - Define si pueden insertarse datos en runti‐
na 677) me.
ExportDirectory‐ RW - - Define si el directorio para la exportación
Changeable (Pági‐ de datos se podrá modificar en runtime.
na 686)
ExportDirectoryna‐ RW - - Determina el directorio al cual se exporta‐
me (Página 687) rán los datos de runtime.
ExportFileExten‐ RW - - Define la extensión del archivo de exporta‐
sion (Página 688) ción.
ExportFilename RW - - Define el nombre del archivo al cual se ex‐
(Página 688) portarán los datos de runtime.
ExportFilename‐ RW - - Define si el nombre del archivo de exporta‐
Changeable (Pági‐ ción se podrá modificar en runtime.
na 689)
ExportFormatGuid RW - - Define la asignación de número de ident. y
(Página 690) Export-Provider.
ExportFormatNa‐ RW - - Determina el formato de archivo para la ex‐
me (Página 691) portación.
ExportParameters RW - - Define los parámetros del formato selec‐
(Página 692) cionado en el cuadro de diálogo de propie‐
dades.
ExportSelection RW - - Define qué datos de runtime del control se
(Página 693) exportarán.
ExportShowDialog RW - - Define si el cuadro de diálogo para la ex‐
(Página 693) portación de datos se mostrará en runtime.

VB Scripting

fessional vanced
FillPattern - - - -
Filter - - - -
FilterSQL (Pági‐ RW - - Define un Statement SQL para el criterio
na 701) de filtro.
GridLineColor (Pá‐ RW - - Establece el color de las líneas de cuadrí‐
gina 730) cula.
GridLineWidth (Pá‐ RW - - Define en píxeles el grosor de las líneas de
gina 731) separación.
HorizontalGridLi‐ RW - - Define si se deben visualizar líneas hori‐
nes (Página 750) zontales.
IconSpace (Pági‐ RW - - Define la distancia entre símbolo y texto en
Layer - - - -
LineBackground‐ - - - -
Color
LineColor (Pági‐ RW - - Define el color de las líneas de separación
na 799) de la ventana.
LineStyle - - - -
LineWidth (Pági‐ RW - - Define el grosor de línea.
na 802)
Location - - - -
Moveable (Pági‐ RW - - Define si el objeto se puede desplazar en
na 838) runtime.
Name - - - -
Object - - - -
OcxGuid - - - -
OcxState - - - -
PrintJob (Pági‐ RW - - Define un trabajo de impresión creado en
na 885) el editor "Informes".
RowScrollbar (Pá‐ RW - - Define cuándo se mostrará la barra de des‐
gina 898) plazamiento vertical.
RowTitleAlignment RW - - Define cómo se alinearán los títulos de fila.
(Página 899)
RowTitles (Pági‐ RW - - Define si se mostrarán encabezados de
na 900) columna numerados.
RTPersistence (Pá‐ RW - - Define si se conservarán las configuracio‐
gina 901) nes online tras cambiar de imagen.
RTPersistenceAut‐ RW - - Define el permiso que se requiere en runti‐
horization (Pági‐ me para la configuración online.
na 901)

VB Scripting

fessional vanced
RTPersistenceTy‐ RW - - Define cómo se conservarán las configura‐
pe (Página 902) ciones online de WinCC.
SelectArchiveNa‐ RW - - Define que en runtime se muestre primero
me (Página 918) el cuadro de diálogo de selección para el
origen de datos del visor de recetas.
SelectedCellColor RW - - Define el color de fondo de la celda selec‐
(Página 919) cionada.
SelectedCellFore‐ RW - - Define el color de fuente de la celda selec‐
Color (Página 920) cionada.
SelectedID (Pági‐ RW - - Define la ID del registro seleccionado en el
na 921) visor de recetas.
SelectedRowColor RW - - Define el color de fondo de la fila seleccio‐
(Página 922) nada.
SelectedRowFore‐ RW - - Define el color de fuente de la fila seleccio‐
Color (Página 923) nada.
SelectedTitleColor RW - - Define el color de fondo del título de tabla
(Página 924) seleccionado.
SelectedTitleFore‐ RW - - Define el color de fuente del título de tabla
Color (Página 925) seleccionado.
SelectionColoring RW - - Define si se utilizarán colores de selección
(Página 928) para celdas o filas.
SelectionRect (Pá‐ RW - - Define si se utilizará un borde de selección
gina 929) para las celdas o filas seleccionadas.
SelectionRectColor RW - - Define el color del rectángulo de selección
(Página 930) en la ventana de avisos.
SelectionRect‐ RW - - Establece el grosor de la línea del rectán‐
Width (Página 931) gulo de selección en la ventana de avisos
cuando SelectionType sea "1".
SelectionType (Pá‐ RW - - Determina cuántas líneas pueden seleccio‐
gina 932) narse.
ShowSortButton RW - - Define si se mostrará la tecla de clasifica‐
(Página 955) ción en la barra de desplazamiento.
ShowSortIcon (Pá‐ RW - - Define si se mostrará el símbolo de clasifi‐
gina 956) cación.
ShowSortIndex RW - - Determina si se mostrará un índice de cla‐
(Página 957) sificación.
ShowTitle (Pági‐ RW - - Define el estilo del marco de la ventana y
na 962) el título de la ventana para el objeto.
Size - - - -
Sizeable (Pági‐ RW - - Define si puede modificarse el tamaño del
na 966) objeto en runtime.
SortSequence (Pá‐ RW - - Define cómo se modificará el orden de cla‐
gina 968) sificación cuando el operador haga clic en
el título de la columna en runtime.
StatusbarBackCo‐ RW - - Define el color de fondo de la barra de es‐
lor (Página 973) tado.
StatusbarElemen‐ RW - - Crea un nuevo elemento de la barra de es‐
tAdd (Página 974) tado definido por el usuario.

VB Scripting

fessional vanced
StatusbarElemen‐ RW - - Define si el ancho de un elemento de la
tAutoSize (Pági‐ barra de estado referenciado mediante
na 975) "StatusbarElementIndex" se ajustará auto‐
máticamente.
StatusbarElement‐ RW - - Define el número de elementos configura‐
Count (Página 976) dos de la barra de estado.
StatusbarElementI‐ RW - - Hace referencia a un elemento de la barra
conId (Página 977) de estado mediante su ID de icono.
StatusbarElemen‐ RW - - Hace referencia a un elemento de la barra
tID (Página 978) de estado mediante su ID de elemento.
StatusbarElemen‐ RW - - Hace referencia a un elemento de la barra
tIndex (Página 979) de estado.
StatusbarElement‐ RW - - Define el nombre de un elemento de la ba‐
Name (Página 980) rra de estado referenciado mediante "Sta‐
StatusbarElemen‐ RW - - Elimina el elemento de la barra de estado
tRemove (Pági‐ definido por el usuario y referenciado me‐
na 980) diante su nombre.
StatusbarElemen‐ RW - - Define el nuevo nombre de un elemento de
tRename (Pági‐ la barra de estado definido por el usuario y
na 981) referenciado mediante "StatusbarElemen‐
tIndex".
StatusbarElemen‐ RW - - Define la posición de un elemento referen‐
tRepos (Pági‐ ciado mediante "StatusbarElementIndex"
na 982) en la barra de estado del objeto.
StatusbarElement‐ RW - - Define el texto de un elemento de la barra
Text (Página 983) de estado definido por el usuario y referen‐
ciado mediante "StatusbarElementIndex".
StatusbarElement‐ RW - - Define el texto del tooltip de un elemento
TooltipText (Pági‐ de la barra de estado definido por el usua‐
na 984) rio y referenciado mediante "StatusbarEle‐
mentIndex".
StatusbarElemen‐ RW - - Define si un elemento de la barra de estado
tUserDefined (Pági‐ referenciado mediante "StatusbarElemen‐
na 985) tIndex" ha sido agregado por el ingeniero
como nuevo elemento definido por el usua‐
rio.
StatusbarElement‐ RW - - Define si el elemento de la barra de estado
Visible (Página 986) referenciado mediante "StatusbarElemen‐
tIndex" se mostrará en el objeto.
StatusbarElement‐ RW - - Define el ancho de un elemento de la barra
Width (Página 987) de estado referenciado mediante "Status‐
barElementIndex" en píxeles.
StatusbarFont (Pá‐ RW - - Define la fuente de los textos de la barra
gina 987) de estado.
StatusbarFontCo‐ RW - - Define el color de fuente de los textos de
lor (Página 988) la barra de estado.

VB Scripting

fessional vanced
StatusbarShow‐ RW - - Define si en runtime se mostrarán los tool‐
Tooltips (Pági‐ tips de los elementos de la barra de estado.
na 989)
StatusbarText (Pá‐ RW - - Define el texto estándar de la barra de es‐
gina 990) tado.
StatusbarUseBack‐ RW - - Define si se debe visualizar el color de fon‐
Color (Página 991) do de la barra de estado.
StatusbarVisible RW - - Define si se debe visualizar la barra de es‐
(Página 992) tado del control.
TabIndex - - - -
TableColor (Pági‐ RW - - Define el color de fondo de las filas de la
TableColor2 (Pági‐ RW - - Define el segundo color de fondo de las
na 1003) filas de la tabla del objeto.
TableForeColor RW - - Define el color de fuente de las celdas de
(Página 1005) tabla del objeto.
TableForeColor2 RW - - Define el segundo color de fuente de las
(Página 1005) celdas de tabla del objeto.
TimeBase (Pági‐ RW - - Define la zona horaria que sirve de base
na 1039) para mostrar los valores de tiempo.
TitleColor (Pági‐ RW - - Define el color de fondo del título de la ta‐
na 1061) bla.
TitleCut (Pági‐ RW - - Define si el contenido de los campos de
na 1062) una barra de título se cortará cuando el an‐
cho de columna sea demasiado pequeño.
TitleDarkShadow‐ RW - - Define el color de la parte oscura del som‐
Color (Página 1062) breado 3D para los encabezados de co‐
lumna y fila de la tabla del objeto.
TitleForeColor (Pá‐ RW - - Define el color de fuente en los encabeza‐
gina 1063) dos de columna y fila de la tabla del objeto.
TitleGridLineColor RW - - Define el color de las líneas de separación
(Página 1064) en la barra de título de la tabla.
TitleLightShadow‐ RW - - Define el color de la parte clara del som‐
Color (Página 1065) breado 3D para los encabezados de co‐
lumna y fila de la tabla del objeto.
TitleSort (Pági‐ RW - - Define cómo se iniciará la clasificación por
na 1066) título de columna.
TitleStyle (Pági‐ RW - - Define si se empleará un color de sombrea‐
na 1067) do para el texto de los encabezados de co‐
lumna.
ToolbarAlignment RW - - Define la posición de la barra de herramien‐
(Página 1075) tas.
ToolbarBackColor RW - - Define el color de fondo de la barra de he‐
(Página 1076) rramientas.
ToolbarButtonActi‐ RW - - Define si la función enlazada con la tecla
ve (Página 1077) está activada en runtime.

VB Scripting

fessional vanced
ToolbarButtonAdd RW - - Crea un nuevo botón definido por el usua‐
(Página 1078) rio en la barra de herramientas del objeto.
ToolbarButtonAut‐ RW - - Define el permiso para la función de tecla
horization (Pági‐ seleccionada.
na 1079)
ToolbarButtonBe‐ RW - - Define si se añadirá un separador antes de
ginGroup (Pági‐ la función de teclas seleccionada.
na 1080)
ToolbarButtonClick RW - - Hace clic en un botón de la barra de herra‐
(Página 1081) mientas.
ToolbarButton‐ RW - - Define el número de botones configurados
Count (Pági‐ que contiene la barra de herramientas.
na 1081)
ToolbarButtonEna‐ RW - - Define si se puede manejar la tecla defini‐
bled (Página 1082) da por el usuario de la barra de herramien‐
tas.
ToolbarButtonHot‐ RW - - Define el método abreviado de teclado pa‐
Key (Página 1083) ra el botón seleccionado del objeto.
ToolbarButtonID RW - - Hace referencia a un botón mediante su ID.
(Página 1084)
ToolbarButtonIn‐ RW - - Hace referencia a un botón.
dex (Página 1085)
ToolbarButtonLo‐ RW - - Define si se mostrará el estado pulsado
cked (Página 1086) (enclavado) de un botón definido por el
usuario referenciado mediante "Toolbar‐
ButtonIndex".
ToolbarButtonNa‐ RW - - Define el nombre de un botón definido por
me (Página 1087) el usuario y referenciado mediante "Tool‐
barButtonIndex".
ToolbarButtonRe‐ RW - - Elimina un botón definido por el usuario y
move (Pági‐ referenciado mediante su nombre.
na 1088)
ToolbarButtonRe‐ RW - - Define el nuevo nombre de un botón defi‐
name (Pági‐ nido por el usuario y referenciado mediante
na 1088) "ToolbarButtonIndex".
ToolbarButtonRe‐ RW - - Define la posición de un botón referencia‐
pos (Página 1089) do mediante "ToolbarButtonIndex" en la
barra de herramientas del objeto.
ToolbarButtonTool‐ RW - - Define el texto para el tooltip del botón de‐
tipText (Pági‐ finido por el usuario en la barra de herra‐
na 1091) mientas.
ToolbarButtonUser‐ RW - - Define si la tecla de la barra de herramien‐
Defined (Pági‐ tas ha sido agregada por el ingeniero como
na 1092) tecla nueva definida por el usuario.
ToolbarButtonVisi‐ RW - - Define si se mostrará el botón referenciado
ble (Página 1092) mediante "ToolbarButtonIndex" en la barra
de herramientas.

VB Scripting

fessional vanced
ToolbarShowTool‐ RW - - Define si en runtime se mostrarán los tool‐
tips (Página 1094) tips de las funciones de tecla.
ToolbarUseBack‐ RW - - Define si visualizará el color de fondo de la
Color (Página 1095) barra de herramientas.
ToolbarUseHot‐ RW - - Define si las teclas de acceso rápido para
Keys (Página 1096) los botones de la barra de herramientas
están activadas.
ToolbarVisible (Pá‐ RW - - Define si se debe visualizar la barra de he‐
gina 1097) rramientas del control.
UseSelectedTitle‐ RW - - Define si se utilizará un color de selección
Color (Página 1172) para los títulos de las celdas de tabla se‐
leccionadas.
UseTableColor2 RW - - Define si se utilizará un segundo color de
(Página 1174) fila en la representación de la tabla.
VerticalGridLines RW - - Define si se deben visualizar líneas verti‐
(Página 1218) cales.
Visible (Pági‐ RW - - Define si el objeto indicado será visible.
na 1222)
Width (Pági‐ RW - - Define el ancho del objeto en píxeles.
na 1234)

sional ced
na 1270) para una propiedad con VB Script durante el runti‐
me.
na 1275)
CutRows (Página 1277) Sí - - Ejecuta la función de tecla "Cortar líneas" del visor
de recetas.
jada.
DeleteRows (Pági‐ Sí - - Ejecuta la función de tecla "Borrar líneas" del visor
na 1279) de recetas.
Exportación (Pági‐ Sí - - Ejecuta la función de tecla "Exportar fichero" o "Ex‐
na 1281) portar datos" del control.
GetColumn (Pági‐ Sí - - Devuelve el objeto de columna designado por nom‐
na 1281) bre o índice del visor de recetas como tipo "ICCA‐
xUAColumn".
GetColumnCollection Sí - - Devuelve el listado de todos los objetos de columna
(Página 1282) del visor de recetas como tipo "ICCAxCollection".

VB Scripting

sional ced
DataRowCollection".
na 1308) tion".
"ICCAxCollection".
na 1337)
na 1338) control.
na 1340) control.
na 1341) control.
PasteRows (Pági‐ Sí - - Ejecuta la función del botón "Insertar líneas" del vi‐
na 1344) sor de recetas.
ReadTags (Pági‐ Sí - - Ejecuta la función del botón "Leer variables" del vi‐
na 1351) sor de recetas.
tablas.
ServerExport (Pági‐ Sí - - Ejecuta la función del botón "Exportar fichero" del
ServerImport (Pági‐ Sí - - Ejecuta la función del botón "Importar fichero" del
na 1367)

VB Scripting

sional ced
ShowSelectArchive (Pá‐ Sí - - Ejecuta la función del botón "Seleccionar conexión
gina 1372) de datos" del visor de recetas.
ShowSelection (Pági‐ Sí - - Ejecuta la función del botón "Diálogo de selección"
na 1372) del visor de recetas.
ShowSelectTimeBase Sí - - Ejecuta la función del botón "Diálogo de base de
(Página 1373) tiempo" del visor de recetas.
ShowSort (Pági‐ Sí - - Ejecuta la función del botón "Diálogo de ordenación"
na 1374) del visor de recetas.
WriteTags (Pági‐ Sí - - Ejecuta la función del botón "Escribir variables" del
UserView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de usuarios". El objeto UserView es un elemento de la lista

ScreenItems.
Nota
El objeto "Visor de usuarios simple" no se puede dinamizar mediante un script de usuario.

VB Scripting

HMIUserView

R Lectura
- Ningún acceso

sional ced
AnimationIgnore - - - -
Appearance - - - -
na 528) en runtime.
BackColor (Página 537) - RW RW Define el color de fondo del objeto indicado.
BorderColor - - - -
BorderWidth - - - -
Bounds - - - -
Columns - - - -
ColumnTextGroup - - - -
ColumnTextLogTime - - - -
ColumnTextPassword - - - -
ColumnTextUser - - - -
DeviceStyle - - - -
EdgeStyle - - - -
runtime.
Es2rtButtonPositions - - - -
FitToSize - - - -
Flashing - - - -
IsMinPasswordValue‐ - - - -
Set

VB Scripting

sional ced
do.
Location - - - -
MinPasswordValue - - - -
Name - - - -
PaddingLeft - - - -
PaddingTop - - - -
RTPersistence - - - -
RTPersistenceAuthori‐ - - - -
zation
RTPersistenceType - - - -
ShowColumnHeaders - - - -
ShowTableGridlines - - - -
Size - - - -
StyleItem - - - -
TabIndex - - - -
TableBackColor (Pági‐ - RW RW Determina el color de fondo de las celdas de la tabla
lor
TableFont - - - -
na 1005) objeto.
TableGridLineColor (Pá‐ - RW RW Determina el color de las líneas de retícula en la
gina 1006) tabla del objeto indicado.
TableHeaderBackColor - RW RW Define el color de fondo del encabezado de la tabla
FillStyle
BackColor
lor
Width

VB Scripting

sional ced
dius
dientColor
dientOffset
TableHeaderForeColor - RW RW Define el color de texto del encabezado de la tabla
dientColor
Bottom
gLeft
gRight
Top
GradientColor
GradientOffset
Top (Página 1099) R RW RW Define el valor de la coordenada Y del objeto indica‐
do.
ma
Gradient
condGradient
VerticalScrolling - - - -
ViewType - - - -
tream

VB Scripting

sional ced
jada.
WindowSlider (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Barra de desplazamiento". El objeto WindowSlider es un elemento de


HMIWindowSlider

R Lectura
- Ningún acceso

VB Scripting

sional ced
na 528)
BackColorBottom (Pági‐ RW - - Define el color de la parte inferior/derecha del objeto.
na 541)
BackColorTop (Pági‐ RW - - Define el color de la parte superior/izquierda del ob‐
na 541) jeto.
na 542)
(Página 545) "On".
AUTOHOTSPOT RW - - Define si el fondo parpadeará en runtime.
gina 548)
na 570) brada.
na 573)
BorderFlashingEnabled - - - -
(Página 582) de.
na 587)
na 589)
Bounds - - - -
na 647)

VB Scripting

sional ced
runtime.
na 700)
na 697)
Flashing - - - -
HighLimitColor (Pági‐ RW - - Determina el color del botón superior o derecho para
na 738) desplazarse por una barra de desplazamiento.
JumpToLimitsAfterMou‐ RW - - Define si el deslizador se coloca en el valor final co‐
seClick (Página 770) rrespondiente.
(Página 800)
Location - - - -
LowLimitColor (Pági‐ RW - - Determina el color del botón inferior o izquierdo para
na 808) desplazarse por una barra de desplazamiento.
MarginToBorder (Pági‐ RW - - Define en píxeles el ancho del borde 3D.
na 810)
MaximumValue (Pági‐ RW - - Define el valor máximo de la escala en el objeto in‐
na 811) dicado.
MinimumValue (Pági‐ RW - - Define el valor mínimo de la escala en el objeto in‐
na 834) dicado.
Name - - - -
OperationSteps (Pági‐ R - - Devuelve cuántos pasos se desplaza el deslizador
na 853) de la barra de desplazamiento con un clic de ratón.
ProcessValue (Pági‐ R - - Devuelve el ajuste predeterminado para el valor que
na 886) debe mostrarse.
RelativeFillLevel (Pági‐ R - - Devuelve el porcentaje de relleno del objeto.
na 893)
ShowBadTagState (Pá‐ R - - Devuelve si el objeto se muestra atenuado cuando
gina 940) el QualityCode o el estado de la variable no sea
bueno.
ShowFillLevel (Pági‐ R - - Devuelve si se rellena el objeto indicado.
na 948)
Size - - - -
StyleSettings (Pági‐ R - - Devuelve el estilo con el que se representa el objeto.
na 996)
TabIndex - - - -

VB Scripting

sional ced
TextOrientation (Pági‐ R - - Devuelve la dirección del texto.
na 1018)
ThumbBackColor (Pági‐ R - - Devuelve el color de fondo del deslizador.
na 1021)
ToolTipText (Pági‐ R - - Devuelve el texto del tooltip.
na 1098)
Top (Página 1099) R - - Devuelve el valor de la coordenada Y.
objeto.
Visible (Página 1222) R - - Devuelve si el objeto indicado es visible.
Width (Página 1234) R - - Devuelve el ancho del objeto en píxeles.
WindowsStyle (Pági‐ R - - Devuelve si el objeto se muestra en el estilo general
na 1241) de Windows.

sional ced
jada.
Consulte también
BorderFlashingEnabled (Página 581)

VB Scripting
WLanQualityView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "WLAN Recepción". El objeto WLanQualityView es un elemento de la

lista ScreenItems.

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
Height - - - -
Location - - - -

VB Scripting

sional ced
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -

sional ced
ZoneLabelView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Zona Nombre". El objeto ZoneLabelView es un elemento de la lista

ScreenItems.

VB Scripting

HMIZoneLabelView

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
Font - - - -
Height - - - -
Location - - - -
Name - - - -
Size - - - -
TabIndex - - - -
Width - - - -

sional ced

VB Scripting
ZoneQualityView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Zona Señal". El objeto ZoneQualityView es un elemento de la lista

ScreenItems.

R Lectura
- Ningún acceso

sional ced
Bounds - - - -
Height - - - -
Location - - - -
Name - - - -

VB Scripting

sional ced
Size - - - -
TabIndex - - - -
Width - - - -

sional ced
1.5.5 Propiedades (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5.5.1 Propiedades A (Panels, Comfort Panels, RT Advanced, RT Professional)
AboveUpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color cuando se rebasa por exceso el valor límite superior.
Acceso en runtime:
● RT Advanced: Ningún acceso
● RT Professional: Lectura y escritura
Sintaxis
Object.AboveUpperLimitColor[=Color]
Object
Necesario. Objeto del tipo "ScreenItem" con las características siguientes:
● IOField
Con las siguientes características no se tiene acceso en runtime:
● GraphicIOField
● Switch

VB Scripting
● SymbolLibrary
● SymbolicIOField
Color
Opcional. Valor o constante que determina el color para el caso "Rebase por exceso del límite
superior".
Observaciones
Utilice la función "RGB" para determinar el color en formato RGB ("red, green, blue", o sea,
rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el correspondiente
valor decimal (rango de valores de 0 a 255). El color "rojo" se representa, p. ej., de la forma
siguiente:
RGB (255, 0, 0)
Además, también es posible utilizar las constantes de color VBS, tales como vbRed o
vbGreen.
Consulte también
IOField (Página 336)
GraphicIOField (Página 328)
Switch (Página 425)
SymbolLibrary (Página 434)
SymbolicIOField (Página 429)
AcceptOnExit (RT Professional)
Descripción
Define si el campo de entrada se confirma automáticamente al salir de él.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AcceptOnExit[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el campo de entrada se confirma automáticamente al salir de él.

VB Scripting
Consulte también
AcceptOnFull (RT Professional)
Descripción
Define si se sale automáticamente del campo de entrada con confirmación una vez que se
ha introducido un número determinado de valores.
Sintaxis
Object.AcceptOnFull[=BOOLEAN]
Object
● IOField
BOOLEAN
Opcional. TRUE si se sale automáticamente del campo de entrada con confirmación una vez
que se ha introducido un número determinado de valores.
Consulte también
AccessPath (RT Professional)
Descripción
Devuelve la ruta de ubicación de una imagen.
Acceso en runtime: lectura
Sintaxis
Object.AccessPath
Object
Obligatorio. Uno objeto del tipo "Screen".

VB Scripting
Ejemplo
En el siguiente ejemplo se edita la ruta de la imagen "ScreenWindow1":
'VBS67
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
MsgBox objScreen.AccessPath
Consulte también
Screen (Página 217)
ActiveProject (RT Professional)
Descripción
Devuelve el proyecto indicado.
Sintaxis
Object.ActiveProject
Object
Se necesita. Objeto del tipo "HMIRuntime".
Consulte también
HMIRuntime (Página 210)
Project (Página 216)
ActiveScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Devuelve un objeto del tipo "Screen" que representa la imagen enfocada en ese momento.
Nota
Si en un script de usuario se consulta la propiedad "ActiveScreen", es posible que la propiedad
no devuelva un objeto "Screen" válido sino "Nothing", debido p. ej. a un ScreenSaver. Se
visualizará un aviso del sistema.
Acceso en runtime: Lectura

VB Scripting
Sintaxis
Object.ActiveScreen
Object
Necesario. Objeto del tipo "HMIRuntime".
Observaciones
La imagen que se devuelve depende de si está enfocada la imagen raíz o el área permanente.
La propiedad ActiveScreen retornará NOTHING si no hay ninguna imagen resaltada. Esto
sucede, p. ej., cuando está enfocada otra ventana. Con la instrucción "If not [expresión] Is
Nothing" puede consultar si se retornará una imagen:
'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
Consulte también
ActiveScreen (RT Professional)
Descripción
Devuelve un objeto del tipo "Screen" que representa la imagen enfocada actualmente.
Nota
Si en una función se consulta la propiedad "ActiveScreen", es posible que, debido p. ej. a un
ScreenSavers, la propiedad no devuelva un objeto "Screen" válido sino "Nothing", y aparezca
un aviso del sistema.
Sintaxis
Object.ActiveScreen

VB Scripting
Object
Necesario. Objeto del tipo "HMIRuntime".
Observaciones
La imagen que se devuelve depende de si está enfocada la imagen raíz o el área permanente.
La propiedad ActiveScreen devuelve NOTHING si no hay ninguna imagen enfocada. Esto
sucede p. ej. cuando está enfocada otra ventana. Con la instrucción "If not [expresión] Is
Nothing" se puede consultar si se devuelve una imagen:
'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
Consulte también
ActiveScreenItem (RT Professional)
Descripción
Crea una referencia con el objeto de imagen enfocado actualmente.
Solo si la imagen del objeto "Screen" correspondiente está seleccionada en ese momento y
si dispone de un campo de entrada, la propiedad "ActiveScreenItem" del objeto "Screen"
tendrá asignado un objeto "ScreenItem" válido. En los demás casos, si p. ej. está seleccionada
otra imagen de la lista "Screens" o una ventana independiente dentro de WinCC u otra
aplicación, esta propiedad no recibirá ningún valor, es decir, tendrá asignado el valor "Nothing".
Utilización
El objeto "ActiveScreenItem" se utiliza para acceder en runtime a las propiedades del objeto
enfocado actualmente.
ActiveScreenItem (Panels, Comfort Panels, RT Advanced)
Descripción
Crea una referencia con el objeto de imagen resaltado actualmente.

VB Scripting
Sólo si la imagen del objeto "Screen" correspondiente está seleccionada en ese momento y
si dispone de un campo de entrada, la propiedad "ActiveScreenItem" del objeto "Screen"
tendrá asignado un objeto "ScreenItem" válido. En los demás casos, si p. ej. está seleccionada
otra imagen de la lista "Screens" o una ventana independiente dentro de WinCC u otra
aplicación, esta propiedad no recibirá ningún valor, es decir, tendrá asignado el valor "Nothing".
Utilización
El objeto "ActiveScreenItem" se utiliza para acceder en runtime a las propiedades del objeto
resaltado actualmente.
ActualPointIndex (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el número del vértice actual.
Acceso en runtime:
Sintaxis
Object.ActualPointIndex[=Int32]
Object
Necesario. Objeto del tipo "ScreenItem" con las características:
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Opcional. Valor o constante que define el número del vértice actual.
Consulte también
Polygon (Página 384)
Polyline (Página 387)
TubePolyline (Página 470)
Line (Página 341)

VB Scripting
ActualPointLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la coordenada X del vértice actual referida al origen de la imagen. El origen de la imagen
se encuentra en la parte superior izquierda del objeto. Cada vértice se identifica mediante un
índice que se obtiene a partir del número ("PointCount") de vértices existentes.
Acceso en runtime:
Sintaxis
Object.ActualPointLeft[=Int32]
Object
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Opcional. Un valor o una constante que determina la coordenada X del vértice actual en
referencia al origen de la imagen.
Observaciones
Una modificación del valor puede alterar las propiedades "Width" (ancho del objeto) y "Left"
(coordenada X de la posición del objeto).
Consulte también
Line (Página 341)

VB Scripting
ActualPointTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la coordenada Y del vértice actual en referencia al origen de la imagen. El origen
de la imagen se encuentra en la parte superior izquierda del objeto.
Acceso en runtime:
Sintaxis
Object.ActualPointTop[=Int32]
Object
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Opcional. Valor o constante que determina la coordenada Y del vértice actual en referencia
al origen de la imagen.
Observaciones
Una modificación del valor puede alterar las propiedades "Height" (altura del objeto) y "Top"
(coordenada Y de la posición del objeto).
Consulte también
Line (Página 341)
AdaptBorder (RT Professional)
Descripción
Determina si el borde del objeto se adaptará de manera dinámica al tamaño del texto.

VB Scripting
Acceso en runtime: Lectura y escritura
Sintaxis
Object.AdaptBorder[=BOOLEAN]
Object
● Button
● CheckBox
● IOField
● OptionGroup
● SymbolicIOField
BOOLEAN
Opcional.
TRUE si el borde del objeto se adapta de manera dinámica al tamaño del texto.
FALSE si el borde del objeto no se adapta de manera dinámica al tamaño del texto.
Consulte también
Button (Página 269)
CheckBox (Página 278)
OptionGroup (Página 377)
AdaptPicture (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Ningún acceso en runtime.
AdaptScreenToWindow (RT Professional)
Descripción
Indica si la imagen representada en una ventana de imagen se adaptará o no en runtime al
tamaño de la ventana de imagen.

VB Scripting
Sintaxis
Object.AdaptScreenToWindow[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
BOOLEAN
Opcional.
TRUE si la imagen se adapta al tamaño de la ventana de imagen.
FALSE si la imagen no se adapta al tamaño de la ventana de imagen.
Consulte también
ScreenWindow (Página 410)
AdaptWindowtoScreen (RT Professional)
Descripción
Indica si la ventana de imagen se adaptará a la imagen representada en ella en runtime.
Sintaxis
Object.AdaptWindowtoScreen[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Opcional.
TRUE si el tamaño de la ventana de imagen se adapta a la imagen.
FALSE si el tamaño de la ventana de imagen no se adapta a la imagen.
Consulte también

VB Scripting
Address (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la dirección web que se abrirá en el navegador HTML.
Sintaxis
Object.Address[=STRING]
Object
● HTMLBrowser
STRING
Opcional. Un valor o una constante que contiene la dirección web.
Consulte también
HTMLBrowser (Página 334)
AddressEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AdressPreview (RT Advanced)
Descripción
AdvancedButtonPositions (RT Advanced)
Descripción

VB Scripting
AdvancedView (RT Advanced)
Descripción
Alarm (RT Professional)
Descripción
AlarmAreaHeight (RT Advanced)
Descripción
AlarmAreaWidth (RT Advanced)
Descripción
AlarmClasses (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AlarmColor (RT Professional)
Descripción
AlarmID (RT Professional)
Descripción
Devuelve la AlarmID del objeto Alarm. La AlarmID es unívoca y la otorga el sistema.
AlarmID (readonly)

VB Scripting
Consulte también
Alarms (lista) (Página 202)
AlarmLog (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AlarmLogs (RT Professional)
Descripción
Devuelve un objeto del tipo "AlarmLogs".
Sintaxis
Object.AlarmLogs
Object
Obligatorio. Un objeto del tipo "Logging".
Consulte también
AlarmLowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el valor límite inferior con el que se dispara la alarma.
Sintaxis
Object.AlarmLowerLimit[=DOUBLE]
Object
● Bar

VB Scripting
DOUBLE
Opcional. Un valor o una constante que determina el valor límite inferior con el que se dispara
la alarma.
Observaciones
El tipo de evaluación (porcentual o absoluta) se determina con la propiedad
"AlarmLowerLimitRelative".
La propiedad "AlarmLowerLimitEnable" determina si está activada la vigilancia de este valor
límite.
Consulte también
Bar (Página 261)
AlarmLowerLimitColor (RT Professional)
Descripción
Define el color de barra para el valor límite "AlarmLowerLimit".
La propiedad "AlarmLowerLimitEnable" debe tener el valor TRUE si el color de la barra debe
cambiar al alcanzarse el valor límite.
Acceso en runtime:
Sintaxis
Object.AlarmLowerLimitColor[=Color]
Object
● Bar
● Slider
Color
Opcional. Un valor o una constante que determina el color de barra para valor el límite
"AlarmLowerLimit".

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
Slider (Página 415)
AlarmLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite "AlarmLowerLimit".
Sintaxis
Object.AlarmLowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "AlarmLowerLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "AlarmLowerLimit",
"AlarmLowerLimitColor" y "AlarmLowerLimitRelative":
Valor límite
Representación al alcanzarse el valor límite
Tipo de evaluación
Consulte también
Bar (Página 261)

VB Scripting
AlarmLowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el valor límite inferior con el que se dispara la alarma se evalúa en porcentaje o
de forma absoluta.
Sintaxis
Object.AlarmLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si el valor límite inferior con el que se dispara la alarma se evalúa en
porcentaje.
Consulte también
Bar (Página 261)
AlarmSource (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AlarmTextTag (RT Professional)
Descripción
AlarmUpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el valor límite superior con el que se dispara la alarma.

VB Scripting
Sintaxis
Object.AlarmUpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Un valor o una constante que determina el valor límite superior con el que se dispara
la alarma.
Observaciones
El tipo de evaluación (porcentual o absoluta) se determina con la propiedad
"AlarmUpperLimitRelative".
La propiedad "AlarmUpperLimitEnable" determina si está activada la vigilancia de este valor
límite.
Consulte también
Bar (Página 261)
AlarmUpperLimitColor (RT Professional)
Descripción
Define el color de barra para el valor límite "AlarmUpperLimit".
La propiedad "AlarmUpperLimitEnable" debe tener el valor TRUE si el color de la barra debe
Acceso en runtime:
Sintaxis
Object.AlarmUpperLimitColor[=Color]
Object
● Bar
● Slider

VB Scripting
Color
Opcional. Un valor o una constante que determina el color de barra para valor el límite
"AlarmUpperLimit".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
AlarmUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite "AlarmUpperLimit".
Sintaxis
Object.AlarmUpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "AlarmUpperLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "AlarmUpperLimit",
"AlarmUpperLimitColor" y "AlarmUpperLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación

VB Scripting
Consulte también
Bar (Página 261)
AlarmUpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el valor límite superior con el que se dispara la alarma se evalúa en porcentaje
o de forma absoluta.
Sintaxis
Object.AlarmUpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si el valor límite superior con el que se dispara la alarma se evalúa en
porcentaje.
Consulte también
Bar (Página 261)
AllFilters (RT Professional)
Descripción
AllFiltersForHitlist (RT Professional)
Descripción

VB Scripting
AllowEdit (RT Advanced)
Descripción
AllowMenu (RT Advanced)
Descripción
Ningún acceso en runtime
AllServer (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se muestran los avisos de todos los servidores disponibles.
Sintaxis
Object.AllServer[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con los siguientes rasgos:
● AlarmControl
BOOLEAN
Opcional.
TRUE si se muestran los avisos de todos los servidores disponibles.
FALSE, si se muestran sólo los avisos del servidor seleccionado.
Consulte también
AlarmControl (Página 238)
AllTagTypesAllowed (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
Analog (RT Professional)
Descripción
Determina si el reloj se visualiza en formato analógico.
Sintaxis
Object.Analog[=BOOLEAN]
Object
● Clock
BOOLEAN
Opcional. TRUE si el reloj se visualiza en formato analógico.
Consulte también
Clock (Página 290)
AngleMax (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ángulo para el final de escala en el objeto "Gauge".
Sintaxis
Object.AngleMax[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Valor o constante que determina el ángulo en grados.
Observaciones
El principio y fin de la gradación de escala se escriben en grados angulares con las
propiedades "AngleMin" y "AngleMax".

VB Scripting
El valor de la propiedad AngleMin debe ser siempre menor que el valor de la propiedad
AngleMax. El ángulo de grado cero está en la posición de las 3 en el disco de la escala. Los
valores positivos se cuentan en el sentido de las agujas del reloj.
Consulte también
Gauge (Página 324)
AngleMin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ángulo para el principio de escala en el objeto "Gauge".
Sintaxis
Object.AngleMin[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Valor o constante que determina el ángulo en grados.
Observaciones
El principio y fin de la gradación de escala se escriben en grados angulares con las
propiedades "AngleMin" y "AngleMax".
El valor de la propiedad AngleMin debe ser siempre menor que el valor de la propiedad
AngleMax.
El ángulo de grado cero está en la posición de las 3 en el disco de la escala. Los valores
positivos se cuentan en el sentido de las agujas del reloj.
Consulte también
Gauge (Página 324)
AnimationIgnore (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
Appearance (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ApplyProjectSettings (RT Professional)
Descripción
Define si se tomarán los ajustes de proyecto del editor "Avisos HMI".
Sintaxis
Object.ApplyProjectSettings[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si los bloques de aviso configurados en el editor "Avisos HMI" se aplican con sus
propiedades en el visor de avisos. Los bloques de aviso se muestran con estas propiedades
en el visor de avisos.
FALSE si no se aplican las propiedades.
Consulte también
ApplyProjectSettingsForDesignMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ArchiveName (RT Professional)
Descripción
Define el nombre del fichero.

VB Scripting
Sintaxis
Object.ArchiveName[=STRING]
Object
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nombre del fichero.
Consulte también
UserArchiveControl (Página 475)
ArchiveType (RT Professional)
Descripción
Define el tipo de fichero.
Sintaxis
Object.ArchiveType[=RecipeControlDataSourceType]
Object
RecipeControlDataSourceType
Opcional. Valor o constante que define el tipo de fichero.
Valor Nombre Explicación

0 Desconocido No define ningún tipo de fichero.
1 Receta Establece una receta como tipo de fichero.
2 Consulta de receta Establece una consulta de receta como tipo de fichero.
Consulte también

VB Scripting
AskOperationMotive (RT Professional)
Descripción
Define si también se registrará la razón de manejo de este objeto. Si el objeto se maneja en
runtime, el operador introduce el motivo del manejo en un cuadro de diálogo.
Sintaxis
Object.AskOperationMotive[=BOOLEAN]
Object
● ComboBox
● IOField
● ListBox
● SymbolicIOField
● WindowSlider
BOOLEAN
Opcional. TRUE si el motivo para el manejo de este objeto se registra en un informe.
Consulte también
ComboBox (Página 293)
Listbox (Página 344)
WindowSlider (Página 491)
AspectRatio (RT Professional)
Descripción
Determina si se conservará la relación de aspecto del Media Player en caso de modificación
de tamaño.
Sintaxis
Object.AspectRatio[=BOOLEAN]

VB Scripting
Object
Obligatorio. Objeto del tipo "ScreenItem" con los rasgos siguientes:
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se conserva la relación de aspecto del Media Player en caso de modificación de
tamaño.
FALSE si no se conserva la relación de aspecto del Media Player en caso de modificación de
tamaño.
Consulte también
MediaPlayer (Página 347)
AssignedFilters (RT Professional)
Descripción
AssignedHitlistFilters (RT Professional)
Descripción
Assignments (RT Professional)
Descripción
Establece un listado que contiene las asignaciones entre el valor de salida y el texto de salida
que realmente será mostrado. Las asignaciones dependen del tipo de lista ajustado. El tipo
de lista se define con la propiedad ListType.
Sintaxis
Object.Assignments[=STRING]
Object
● SymbolicIOField

VB Scripting
STRING
Opcional. Establece un listado que contiene las asignaciones entre el valor de salida y el texto
de salida que realmente será mostrado.
Consulte también
AssociatedS7GraphDBName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AssociatedS7GraphDBTag (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Authorization (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define los derechos de manejo.
Sintaxis
Object.Authorization[=HMIRTAuthorization]
Object
● Bar
● Button
● CheckBox*
● Circle *
● CircleSegment *
● CircularArc *
● ComboBox*
● Connector *

VB Scripting
● DateTimeField **
● Ellipse *
● EllipseSegment *
● EllipticalArc *
● GraphicIOField
● GraphicView *
● IOField
● Line *
● ListBox *
● MultiLineEdit *
● OptionGroup *
● Polygon *
● Polyline *
● RecipeView **
● Rectangle *
● RoundButton *
● S7GraphOverview *
● Slider
● StatusForce **
● Switch **
● SymbolLibrary **
● SymbolicIOField
● TextField *
● TrendView
● TubeArcObject *
● TubeDoubleTeeObject *
● TubeTeeObject *
● Tubepolyline *
● UserView **
● WindowSlider *
* Ningún acceso en RT Advanced
** Ningún acceso en RT Professional

VB Scripting

● AlarmView
● PLCCodeViewer
● PdfView
● ProtectedAreaNameView
● RangeLabelView
● SysDiagControl
HMIRTAuthorization
Opcional. Valor o constante que define los derechos de manejo.
AutoCompleteColumns (RT Professional)
Descripción
Define si se mostrarán las columnas vacías cuando el control es más ancho que las columnas
configuradas.
Sintaxis
Object.AutoCompleteColumns[=BOOLEAN]
Object
● AlarmControl
● OnlineTableControl
● TrendRulerControl
BOOLEAN
Opcional.
TRUE si se muestran las columnas vacías.
FALSE si no se muestran las columnas vacías.
Consulte también
OnlineTableControl (Página 352)
TrendRulerControl (Página 449)

VB Scripting
AutoCompleteRows (RT Professional)
Descripción
Define si se mostrarán filas vacías cuando el control sea más largo que el número de filas
configuradas.
Sintaxis
Object.AutoCompleteRows[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se muestran las filas vacías.
FALSE si no se muestran las filas vacías.
Consulte también
AutoPosition (RT Professional)
Descripción
Determina si la tabla de valores se colocará automáticamente debajo del objeto que le
suministra los datos.
Sintaxis
Object.AutoPosition[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si el objeto se posiciona automáticamente debajo del origen de los datos.
FALSE si el objeto se coloca en la posición configurada.
Consulte también
AutoScroll (RT Professional)
Descripción
Define si se utilizará el desplazamiento automático.
Sintaxis
Object.AutoScroll[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se utiliza el desplazamiento automático.
Consulte también
AutoSelectionColors (RT Professional)
Descripción
Define si el color de selección para celda y fila se realizará con los colores preestablecidos
por el sistema.

VB Scripting
Sintaxis
Object.AutoSelectionColors[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se utiliza el color de sistema.
FALSE si se emplea el color definido por el usuario.
Consulte también
AutoSelectionRectColor (RT Professional)
Descripción
Define si el borde de selección se representará en el color definido por el sistema.
Sintaxis
Object.AutoSelectionRectColor[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si se utiliza el color de sistema.
FALSE si se emplea el color definido por el usuario.
Consulte también
AutoShow (RT Professional)
Descripción
Determina si la tabla de valores se mostrará automáticamente.
Sintaxis
Object.AutoShow[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la tabla de valores se muestra automáticamente.
FALSE si la tabla de valores no se muestra automáticamente.
Consulte también
AutoSizing (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
AutoStart (RT Professional)
Descripción
AvailableStatusbarElements (RT Professional)
Descripción
AvailableToolbarButtons (RT Professional)
Descripción
AverageLast15Values (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si se muestra la media de los últimos 15 valores.
Sintaxis
Object.AverageLast15Values[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE si se muestra la media de los últimos 15 valores.
FALSE si no se muestra la media de los últimos 15 valores.
Consulte también
Bar (Página 261)

VB Scripting
AxisXBunchCount (RT Advanced)
Descripción
AxisXMarkCount (RT Advanced)
Descripción
AxisXNoOfDigits (RT Advanced)
Descripción
AxisXShowBunchValues (RT Advanced)
Descripción
AxisXStyle (RT Advanced)
Descripción
AxisY1BunchCount (RT Advanced)
Descripción
AxisY1MarkCount (RT Advanced)
Descripción

VB Scripting
AxisY1ShowBunchValues (RT Advanced)
Descripción
AxisY2BunchCount (RT Advanced)
Descripción
AxisY2MarkCount (RT Advanced)
Descripción
AxisY2ShowBunchValues (RT Advanced)
Descripción
1.5.5.2 Propiedades B (Panels, Comfort Panels, RT Advanced, RT Professional)
BackButtonVisible (RT Advanced)
Descripción
BackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fondo.
Sintaxis
Object.BackColor[=Color]

VB Scripting
Object
● AlarmControl *
● AlarmView
● Bar
● Button **
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● ComboBox *
● Connector *
● Ellipse
● EllipticalArc *
● FunctionTrendControl *
● Gauge
● GraphicIOField **
● GraphicView
● IOField
● Line
● ListBox *
● MultiLineEdit *
● OnlineTableControl *
● OnlineTrendControl *
● OptionGroup *
● Polygon
● Polyline
● RecipeView **
● Rectangle
● RoundButton *
● Slider
● StatusForce **
● Switch **

VB Scripting
● SymbolLibrary
● SymbolicIOField
● TextField
● TrendRulerControl *
● UserArchiveControl *
● UserView **
● WindowSlider *
* RT Advanced: Ningún acceso
** RT Professional: Ningún acceso

● TrendView
● TubeArcObject
Color
Opcional. Valor o constante que determina el color de fondo.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
El color de fondo no es visible si la propiedad "BorderStyle" tiene el valor "0".
Consulte también
AlarmView (Página 253)
Bar (Página 261)
Circle (Página 282)
CircleSegment (Página 285)
CircularArc (Página 288)

VB Scripting
Connector (Página 296)

DateTimeField (Página 299)
Ellipse (Página 303)
EllipseSegment (Página 306)
EllipticalArc (Página 309)
FunctionTrendControl (Página 312)
Gauge (Página 324)
GraphicView (Página 331)
Line (Página 341)
MultiLineEdit (Página 349)
OnlineTrendControl (Página 365)
RecipeView (Página 395)
Rectangle (Página 401)
RoundButton (Página 404)
StatusForce (Página 420)
TextField (Página 445)
TrendView (Página 460)
TubeArcObject (Página 466)
UserView (Página 487)

VB Scripting
BackColorBottom (RT Professional)
Descripción
Define el color de la parte inferior/derecha del objeto.
Sintaxis
Object.BackColorBottom[=Color]
Object
● WindowSlider
Color
Opcional. Valor o constante que define el color de la parte inferior/derecha del objeto .
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
BackColorTop (RT Professional)
Descripción
Define el color de la parte superior/izquierda del objeto.
Sintaxis
Object.BackColorTop[=Color]

VB Scripting
Object
● WindowSlider
Color
Opcional. Valor o constante que define el color de la parte superior/izquierda del objeto.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
BackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el patrón de relleno.
Sintaxis
Object.BackFillStyle[=FillStyle]
Object
● Bar
● Button*
● CheckBox*
● Circle
● CircleSegment *
● Clock*
● ComboBox
● Ellipse

VB Scripting
● Gauge*
● GraphicView*
● IOField*
● ListBox*
● OptionGroup*
● Polygon
● Rectangle
● RoundButton*
● Slider*
● SymbolLibrary*
● SymbolicIOField*
● TextField*
● WindowSlider*

● DateTimeField
● GraphicIOField
● Switch
FillStyle
Opcional. Valor o constante que determina el patrón de relleno.
Valor Constante VB Explicación

0 hmiFillStyleSolid El objeto se rellena con el color indicado
1 hmiFillStyleTransparent Relleno transparente
Consulte también
Bar (Página 261)
Clock (Página 290)
Gauge (Página 324)

VB Scripting

BackFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fondo para el estado de parpadeo "Off".
Acceso en runtime:
Sintaxis
Object.BackFlashingColorOff[=Color]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch

VB Scripting
Color
Opcional. Un valor o una constante que determina el color del fondo para el estado de
parpadeo "Off".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
BackFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fondo para el estado de parpadeo "On".
Acceso en runtime:
Sintaxis
Object.BackFlashingColorOn[=Color]

VB Scripting
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
Color
Opcional. Un valor o una constante que determina el color del fondo para el estado de
parpadeo "On".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)

VB Scripting

BackFlashingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el fondo parpadeará en runtime.
Acceso en runtime:
Sintaxis
Object.BackFlashingEnabled[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
BOOLEAN
Opcional. TRUE si el fondo parpadea en runtime.
Consulte también
Bar (Página 261)

VB Scripting

BackFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la frecuencia de parpadeo del fondo.
Acceso en runtime:
Sintaxis
Object.BackFlashingRate[=FlashingRate]
Object
● Bar
● Button
● CheckBox
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch

VB Scripting
FlashingRate
Opcional. Valor o constante que define la frecuencia de parpadeo del fondo.

0 hmiFlashingRateSlow La duración del intervalo de parpadeo es de 250 ms.
1 hmiFlashingRateMedium La duración del intervalo de parpadeo es de 500 ms.
2 hmiFlashingRateFast La duración del intervalo de parpadeo es de 1000 ms.
Consulte también
Bar (Página 261)
BackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Consulte también
BackPicture (RT Professional)
Descripción
Determina el gráfico de fondo.
Sintaxis
Object.BackPicture[=HmiObjectHandle]

VB Scripting
Object
● Gauge
● Slider
HmiObjectHandle
Opcional. Valor o constante que determina el gráfico de fondo.
Consulte también
Gauge (Página 324)
BackStyle (RT Professional)
Descripción
Determina el estilo de fondo.
Sintaxis
Object.BackStyle[=Int32]
Object
● Gauge
Int32
Opcional. Valor o constante que determina el estilo de fondo.

0 Compacto El fondo rectangular de la visualización está rellenado con el color de
borde indicado. El cuadrante está rellenado con el color de fondo indicado.
1 Marco transparente El fondo rectangular del reloj de medición es transparente. El cuadrante
está rellenado con el color de fondo indicado. De este modo es posible
representar una visualización en forma de círculo.
2 Transparente El fondo rectangular y el cuadrante son transparentes.
Consulte también
Gauge (Página 324)

VB Scripting
BarBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del fondo de barra en el objeto indicado.
Sintaxis
Object.BarBackColor[=Color]
Object
● Bar
● Slider
Color
Opcional. Valor o constante que determina el color del fondo de barra.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
BarBackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el patrón de relleno de la barra.
Sintaxis
Object.BarBackFillStyle[=FillStyle]

VB Scripting
Object
● Bar
FillStyle
Opcional. Valor o constante que define el patrón de relleno de la barra.

65536 hmiFillStyleTransparent Patrón de relleno transparente
0 hmiFillStyleSolid Patrón de relleno sólido
131075 hmiFillStyleBackwardDiago‐ Patrón de relleno a rayas diagonales hacia arriba a la dere‐
nal cha
131076 hmiFillStyleCross Patrón de relleno cuadriculado
131077 hmiFillStyleDiagonalCross Patrón de relleno cuadriculado diagonal
131074 hmiFillStyleForwardDiagonal Patrón de relleno a rayas diagonales hacia arriba a la iz‐
quierda
131072 hmiFillStyleHorizontal Patrón de relleno a rayas horizontales
131073 hmiFillStyleVertical Patrón de relleno a rayas verticales
196608 - hmiFillStylePattern1 - hmi‐ Patrón de relleno predefinido
196644 FillStylePattern37
Consulte también
Bar (Página 261)
BarBackFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color ###
Sintaxis
Object.BarBackFlashingColorOff[=Color]
Object
● Bar
Color
Opcional. Valor o constante que determina el color de ###

VB Scripting
BarBackFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color ###
Sintaxis
Object.BarBackFlashingColorOn[=Color]
Object
● Bar
Color
Opcional. Valor o constante que determina el color de ###
BarBackFlashingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si ###
Sintaxis
Object.BarBackFlashingEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si ###
BarBackFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la frecuencia de parpadeo ###

VB Scripting
Sintaxis
Object.BarBackFlashingRate[=FlashingRate]
Object
● Bar
FlashingRate
Opcional. Valor o constante que define la frecuencia de parpadeo ###
BarColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la barra.
Sintaxis
Object.BarColor[=Color]
Object
● Slider
Color
Opcional. Valor o constante que determina el color del regulador.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
El rango va desde el valor de "MinimumValue (Página 834)" hasta la posición del regulador.
Consulte también

VB Scripting
BarEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define ###
Acceso en runtime:
● RT Advanced: Lectura
Sintaxis
Object.BarEdgeStyle[=LineStyle]
Object
● Bar
LineStyle
Opcional. Valor o constante que ###
BarOrientation (RT Professional)
Descripción
Define la orientación de la barra.
Acceso en runtime:
Sintaxis
Object.BarOrientation[=BarOrientation]
Object
● Bar
● Slider

VB Scripting
BarOrientation
Opcional. Valor o constante que determina la orientación de la barra.

0 Arriba La barra está orientada verticalmente. El valor máximo de escala está situado en el borde
superior de la barra.
1 Abajo La barra está orientada verticalmente. El valor máximo de escala está situado en el borde
inferior de la barra.
2 Izquierda La barra está orientada horizontalmente. El valor máximo de escala está situado a la izquierda.
3 Derecha La barra está orientada horizontalmente. El valor máximo de escala está situado a la derecha.
Consulte también
Bar (Página 261)
BaseScreenName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Lee el nombre de la imagen raíz actual o da lugar a un cambio de imagen raíz definiendo un
nuevo nombre de imagen.
Sintaxis
Object.BaseScreenName[= STRING]
Object
Obligatorio. Objeto del tipo "HMIRuntime".
STRING
Opcional. Valor o constante que contiene el nombre de la imagen.
Observaciones
También es posible utilizar la propiedad para determinar la imagen que se está visualizando.
Consulte también

VB Scripting
BelowLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color para el caso "Rebase por defecto del límite inferior".
Acceso en runtime:
Sintaxis
Object.BelowLowerLimitColor[=Color]
Object
● IOField
● GraphicIOField
● Switch
● SymbolLibrary
● SymbolicIOField
Color
Opcional. Valor o constante que define el color.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
BitNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el bit cuyo estado debe modificarse para desencadenar un cambio de valor.

VB Scripting
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BitNumber[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● SymbolicIOField
Con la siguiente apariencia no se tiene acceso en runtime:
● Button
● GraphicIOField
Int32
Opcional. Un valor o una constante que determina el bit cuyo estado debe modificarse para
desencadenar un cambio de valor.
Observaciones
La variable utilizada debe ser del tipo BYTE, WORD o DWORD.
Consulte también
BlinkColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color con el que parpadeará el objeto en runtime.
Sintaxis
Object.BlinkColor[=Color]
Object
● SymbolLibrary

VB Scripting
Color
Opcional. Valor o constante que determina el color de parpadeo.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
BlinkMode (RT Professional)
Descripción
Define el tipo de gráfico intermitente para el objeto indicado.
Sintaxis
Object.BlinkMode[=SymbolLibraryBlinkMode]
Object
● SymbolLibrary
SymbolLibraryBlinkMode
Opcional. Valor o constante que define el tipo de gráfico intermitente del objeto indicado.

0 hmiSymbolLibraryFlashing‐ El parpadeo está desactivado.
None
1 hmiSymbolLibraryFlashin‐ El gráfico intermitente es invisible.
gInvisible
2 hmiSymbolLibraryFlashingS‐ El gráfico intermitente recibe una superficie a color, som‐
haded breada. El color de la superficie se corresponde con el ajus‐
te de la propiedad "BlinkColor".
3 hmiSymbolLibraryFlashing‐ El gráfico intermitente recibe una superficie a color, no som‐
Solid breada. El color de la superficie se corresponde con el ajus‐
te de la propiedad "BlinkColor".

VB Scripting
Consulte también
BlinkSpeed (RT Professional)
Descripción
Determina la frecuencia de parpadeo.
Fast - 250: la duración del intervalo de parpadeo es de 250 ms. Medium - 500: La duración
del intervalo de parpadeo es de 500 ms.
Slow - 1000: la duración del intervalo de parpadeo es de 1000 ms. El valor estándar es Medium
- 500.
Sintaxis
Object.BlinkSpeed[=FlashingRate]
Object
● SymbolLibrary
FlashingRate
Opcional. Valor o constante que define la frecuencia de parpadeo.

1 hmiFlashingRateMe‐ La duración del intervalo de parpadeo es de 500 ms.
dium
Consulte también
BlockAlignment (RT Professional)
Descripción
Define la alineación del texto dentro del título de la columna del bloque referenciado.

VB Scripting
Sintaxis
Object.BlockAlignment[=HorizontalAlignment]
Object
HorizontalAlignment
Opcional. Valor o constante que define la alineación horizontal.

0 hmiAlignmentLeft El texto del título de la columna se muestra justificado a la
izquierda.
1 hmiAlignmentCentered El texto del título de la columna se muestra centrado.
2 hmiAlignmentRight El texto del título de la columna se muestra justificado a la
derecha.
Consulte también
BlockAutoPrecisions (RT Professional)
Descripción
Determina si el número de decimales mostrados en el bloque actual se adapta
automáticamente.
Sintaxis
Object.BlockAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el número de decimales mostrados se adapta automáticamente.
FALSE si el número de decimales mostrados no se adapta automáticamente.

VB Scripting
Consulte también
BlockCaption (RT Professional)
Descripción
Determina el título del bloque actual.
Sintaxis
Object.BlockCaption[=STRING]
Object
STRING
Opcional. Valor o constante que determina el título del bloque.
Consulte también
BlockCount (RT Professional)
Descripción
Determina el número de bloques.
Sintaxis
Object.BlockCount[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de bloques.

VB Scripting
Consulte también
BlockDateFormat (RT Professional)
Descripción
Determina el formato de la fecha en el bloque actual.
Sintaxis
Object.BlockDateFormat[=STRING]
Object
STRING
Opcional. Valor o constante que determina el formato de la fecha.
Consulte también
BlockExponentialFormat (RT Professional)
Descripción
Determina si los valores del bloque actual se mostrarán en representación exponencial.
Sintaxis
Object.BlockExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si los valores se muestran en representación exponencial.

VB Scripting
FALSE si los valores se muestran en representación decimal.
Consulte también
BlockHideText (RT Professional)
Descripción
BlockHideTitleText (RT Professional)
Descripción
Determina si el título del bloque se mostrará en forma de texto.
Sintaxis
Object.BlockHideTitleText[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el título del bloque se muestra como texto.
FALSE si el título del bloque no se muestra como texto.
Consulte también
BlockId (RT Professional)
Descripción
Hace referencia a un bloque mediante su ID de bloque. Para acceder a las propiedades de
un bloque, es necesario activar "BlockId".

VB Scripting
Sintaxis
Object.BlockId[=Int32]
Object
Int32
Opcional. Valor o constante que define la ID del bloque actual.
Consulte también
BlockIndex (RT Professional)
Descripción
Hace referencia a un bloque. Para acceder a las propiedades de un bloque, es necesario
activar "BlockIndex".
Los valores válidos para "BlockIndex" se encuentran entre 0 y "BlockCount" menos 1. La
propiedad "BlockCount" indica el número de bloques configurados.
Sintaxis
Object.BlockIndex[=Int32]
Object
Int32
Opcional. Valor o constante que indica el número del bloque actual.
Consulte también
BlockLength (RT Professional)
Descripción
Determina el número de caracteres del bloque actual.

VB Scripting
Sintaxis
Object.BlockLength[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de caracteres.
Consulte también
BlockName (RT Professional)
Descripción
Define el nombre del bloque actual.
Sintaxis
Object.BlockName[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre del bloque.
Consulte también
BlockPrecisions (RT Professional)
Descripción
Determina el número de decimales del bloque actual.

VB Scripting
Sintaxis
Object.BlockPrecisions[=Int16]
Object
Int16
Opcional. Valor o constante que determina el número de decimales.
Consulte también
Blocks (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BlockShowDate (RT Professional)
Descripción
Determina que se muestre la fecha en el bloque actual.
Sintaxis
Object.BlockShowDate[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra la fecha en el bloque actual.
FALSE si no se muestra la fecha en el bloque actual.

VB Scripting
Consulte también
BlockShowIcon (RT Professional)
Descripción
Determina si el contenido del bloque actual se mostrará en forma de símbolo.
Sintaxis
Object.BlockShowIcon[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el contenido del bloque actual se muestra como símbolo.
FALSE si el contenido del bloque actual no se muestra como símbolo.
Consulte también
BlockShowTitleIcon (RT Professional)
Descripción
Determina si el título del bloque actual se mostrará en forma de símbolo.
Sintaxis
Object.BlockShowTitleIcon[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si el título del bloque actual se muestra como símbolo.
FALSE si el título del bloque actual no se muestra como símbolo.
Consulte también
BlockTimeFormat (RT Professional)
Descripción
Determina el formato de la hora en el bloque actual.
Sintaxis
Object.BlockTimeFormat[=STRING]
Object
STRING
Valor o constante que determina el formato de la hora.
Consulte también
BlockUseSourceFormat (RT Professional)
Descripción
Determina si se utiliza el formato del control conectado en el bloque actual.
Sintaxis
Object.BlockUseSourceFormat[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si se utiliza el formato del control conectado en el bloque actual.
FALSE si se utiliza el formato configurado en el bloque actual.
Consulte también
BorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fondo de la línea de borde quebrada.
Acceso en runtime:
Sintaxis
Object.BorderBackColor[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox

VB Scripting
● MultiLineEdit
● OptionGroup
● Pölygon
● Rectangle
● RoundButton
● TextField
● WindowSlider
● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SymbolicIOField
● SysDiagControl
● TrendView
● UserView
Color
Opcional. Valor o constante que define el color de fondo de la línea de borde quebrada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)

VB Scripting

Clock (Página 290)
Gauge (Página 324)
SysDiagControl (Página 436)
BorderBrightColor3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de las siguientes partes del borde para la representación tridimensional:
● Partes externas superiores e inferiores del borde
● Partes internas inferiores y derechas del borde
Acceso en runtime:
Sintaxis
Object.BorderBrightColor3D[=Color]

VB Scripting
Object
● Button
● RoundButton
● Slider*
* RT Advanced: Acceso de lectura y de escritura
● Switch
Color
Opcional. Un valor o una constante que determina el color del borde.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
BorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de línea.
Acceso en runtime:
Sintaxis
Object.BorderColor[=Color]

VB Scripting
Object
● Bar
● Button
● CheckBox
● Circle*
● CircleSegment
● ComboBox
● DateTimeField**
● Ellipse*
● EllipseSegment
● FunctionTrendControl
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OnlineTrendControl
● OptionGroup
● Polygon*
● Rectangle*
● RoundButton
● TextField*
● WindowSlider
** RT Advanced: Acceso de lectura y de escritura; RT Professional: Ningún acceso

● AlarmControl
● AlarmView
● Clock

VB Scripting
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de línea.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
Clock (Página 290)
Gauge (Página 324)

VB Scripting

BorderEnabled (RT Professional)
Descripción
Devuelve si la ventana se representa con borde en runtime.
Sintaxis
Object.BorderEnabled[=BOOLEAN]
Object
● ApplicationWindow
● Screenwindow

VB Scripting
BOOLEAN
Opcional. TRUE si la ventana se muestra con borde en runtime.
Consulte también
ApplicationWindow (Página 259)
BorderEndStyle (RT Professional)
Descripción
Define el tipo de finales de línea.
Sintaxis
Object.BorderEndStyle[=Int32]
Object
● Connector
● Line
● Polyline
Int32
Opcional. Valor o constante que define el tipo de finales de línea.
Consulte también
Line (Página 341)
BorderFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la línea de borde para el estado de parpadeo "Off".
Acceso en runtime:

VB Scripting
Sintaxis
Object.BorderFlashingColorOff[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
Color
Opcional. Valor o constante que define el color de la línea de borde para el estado de parpadeo
"Off".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
Bar (Página 261)
BorderFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la línea de borde para el estado de parpadeo "On".
Acceso en runtime:
Sintaxis
Object.BorderFlashingColorOn[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField

VB Scripting
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
Color
"On".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)

VB Scripting
BorderFlashingEnabled (RT Professional)
Descripción
Define si el límite del objeto puede parpadear en runtime.
Acceso en runtime:
Sintaxis
Object.BorderFlashingEnabled[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Switch
● WindowSlider
BOOLEAN
Opcional.
TRUE si el límite del objeto puede parpadear en runtime.

VB Scripting
FALSE si el límite del objeto no puede parpadear en runtime.
Consulte también
Bar (Página 261)
BorderFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la frecuencia de parpadeo de la línea de borde.
Acceso en runtime:
Sintaxis
Object.BorderFlashingRate[=FlashingRate]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● IOField

VB Scripting
● OptionGroup
● Polyline
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● GraphicIOField
● Switch
FlashingRate
Opcional. Valor o constante que define la frecuencia de parpadeo de la línea de borde.

Consulte también
Bar (Página 261)
BorderInnerStyle3D (RT Professional)
Descripción
Define el modo de representación de la parte interior del borde del objeto.

VB Scripting
Sintaxis
Object.BorderInnerStyle3D[=3DStyle]
Object
● Gauge
● Slider
3DStyle
Opcional. Valor o constante que define la representación de la parte interior del borde del
objeto.

0 hmiBorder3DStyleNone No hay ninguna parte interior del borde del objeto.
1 hmiBorder3DStyleRe‐ El borde del objeto se representa troquelado.
cessed
2 hmiBorder3DStyleRai‐ El borde del objeto se representa realzado.
sed
3 hmiBorder3DStyleGray El borde del objeto tiene un marco gris uniforme.
4 hmiBorder3DStyleColo‐ El borde del objeto tiene un marco de color uniforme. El color del
red borde se corresponde con el color del fondo.
Consulte también
Gauge (Página 324)
BorderInnerWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde interior en una representación tridimensional.
Sintaxis
Object.BorderInnerWidth3D[=Int32]
Object
● Slider
Int32
Opcional. Valor o constante que determina el ancho (en píxeles) del borde interior.

VB Scripting
Consulte también
BorderOuterStyle3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el modo de representación de la parte exterior del borde del objeto.
Acceso en runtime:
Sintaxis
Object.BorderOuterStyle3D[=3DStyle]
Object
● Gauge
● Slider
3DStyle
Opcional. Valor o constante que define la representación de la parte exterior del borde del
objeto.

0 hmiBorder3DStyleNone No hay ninguna parte interior del borde del objeto.
1 hmiBorder3DStyleRe‐ El borde del objeto se representa troquelado.
cessed
2 hmiBorder3DStyleRai‐ El borde del objeto se representa realzado.
sed
3 hmiBorder3DStyleGray El borde del objeto tiene un marco gris uniforme.
4 hmiBorder3DStyleColo‐ El borde del objeto tiene un marco de color uniforme. El color del
red borde se corresponde con el color del fondo.
Consulte también
Gauge (Página 324)

VB Scripting
BorderOuterWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde exterior en una representación tridimensional.
Sintaxis
Object.BorderOuterWidth3D[=Int32]
Object
● Slider
Int32
Opcional. Valor o constante que determina el ancho del borde exterior en píxeles.
Consulte también
BorderShadeColor3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de las siguientes partes del borde para la representación tridimensional:
● Partes internas superiores e inferiores del borde
● Partes externas inferiores y derechas del borde
Acceso en runtime:
Sintaxis
Object.BorderShadeColor3D[=Color]
Object
● Button
● Slider*

VB Scripting

● RoundButton
● Switch
Color
Opcional. Un valor o una constante que determina el color para el sombreado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
BorderStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el tipo de líneas de borde.
Sintaxis
Object.BorderStyle[=Int32]
Object
● Bar
● Button
● CheckBox
● Circle

VB Scripting
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● OptionGroup
Int32
Opcional. Valor o constante que define el tipo de líneas de borde.
Valor Explicación
0 Línea continua
1 Línea discontinua
2 Línea punteada
3 Línea de rayas y puntos
4 Línea punto punto raya
Consulte también
Bar (Página 261)

VB Scripting

BorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el grosor de línea.
Acceso en runtime:
Sintaxis
Object.BorderWidth[=Int32]
Object
● Ala rmControl
● Bar
● Button
● Circle *
● CircleSegment
● CheckBox
● ComboBox
● Ellipse *
● EllipseSegment
● Gauge
● GraphicIOField
● GraphicView

VB Scripting
● IOField
● ListBox
● MultiLineEdit
● Polygon *
● Rectangle *
● OptionGroup
● RoundButton
● Slider *
● SymbolicIOField *
● TextField *
● WindowSlider

● AlarmView
● Clock
● DateTimeField
● RecipeView
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Int32
Opcional. Valor o constante que establece el grosor de la línea en píxeles.
Consulte también
Bar (Página 261)

VB Scripting

Clock (Página 290)
Gauge (Página 324)
BorderWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde interior en una representación tridimensional.
Acceso en runtime:

VB Scripting
Sintaxis
Object.BorderWidth3D[=Int32]
Object
● Button
● Gauge
● RoundButton
● Bar
● IOField
● Switch
Int32
Opcional. Valor o constante que determina el ancho (en píxeles) del borde interior para la
representación en 3D.
Consulte también
Bar (Página 261)
Gauge (Página 324)
BottomMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Bounds (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
BrowserTypeUsed (RT Professional)
Descripción
BufferViewColumnOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BufferViewInternalRowOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BusyText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonBackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonBarElements (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ButtonBarHeight (RT Advanced)
Descripción
ButtonBarStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonBorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonBorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonCornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ButtonFirstGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonFirstGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonMiddleGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonPositions (RT Advanced)
Descripción
ButtonSecondGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ButtonSecondGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ColumnWidth_Date (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
BV_ColumnWidth_Event (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ColumnWidth_EventSeverity (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ColumnWidth_EventState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ColumnWidth_Number (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ColumnWidth_Time (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ItemText_Date (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ItemText_Event (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
BV_ItemText_EventSeverity (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ItemText_EventState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ItemText_Number (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ItemText_Time (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ShowItem_Date (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ShowItem_Event (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ShowItem_EventSeverity (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
BV_ShowItem_EventState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ShowItem_Number (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BV_ShowItem_Time (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
1.5.5.3 Propiedades C (Panels, Comfort Panels, RT Advanced, RT Professional)
CameraUrl (RT Professional)
Descripción
CanBeGrouped (RT Professional)
Descripción
Caption (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el texto que se mostrará en la barra de título.
Acceso en runtime:

VB Scripting
Sintaxis
Object.Caption[=STRING]
Object
● AlarmControl
● Slider *
STRING
Opcional. Valor o constante que contiene el texto que se muestra en la barra de título.
Consulte también
CaptionBackColor (RT Professional)
Descripción
Define el color de fondo de la barra de título.
Sintaxis
Object.CaptionBackColor[=Color]

VB Scripting
Object
● SymbolicIOField
Color
Opcional. Valor o constante que define el color de fondo de la barra de título.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
CaptionColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del texto que visualizará en la barra de título.
Sintaxis
Object.CaptionColor[=Color]
Object
● Gauge
● Switch
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color del texto.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)
CaptionFont (RT Professional)
Descripción
Determina la fuente.
Acceso en runtime:
Sintaxis
Object.CaptionFont[=Font]
Object
● Gauge
Con los siguientes rasgos no tiene acceso en runtime:
● Switch
Font
Opcional. Valor o constante que establece la fuente.
Consulte también
Gauge (Página 324)

VB Scripting
CaptionText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el texto que se mostrará en la barra de título.
Sintaxis
Object.CaptionText[= STRING]
Object
● Gauge
● ScreenWindow
● Switch
STRING
Opcional. Valor o constante que contiene el texto que se muestra en la barra de título.
Consulte también
Gauge (Página 324)
CaptionTop (RT Professional)
Descripción
Define la distancia del título de los instrumentos respecto al borde superior del objeto. La
rotulación del instrumento solo se puede colocar a lo largo del diámetro vertical del cuadrante.
El valor de la propiedad hace referencia a la altura del objeto. La altura determina el borde
superior del objeto y el borde inferior del texto.
Sintaxis
Object.CaptionTop[=DOUBLE]
Object
● Gauge

VB Scripting
DOUBLE
Opcional. Valor o constante que define la distancia de la rotulación del instrumento respecto
al borde superior del objeto.
Valor Explicación
0 El borde inferior del texto se encuentra sobre la delimitación superior del objeto. El texto
ya no se ve porque que se encuentra fuera del objeto.
1 el borde inferior del texto se encuentra sobre la delimitación inferior del objeto indicado.
Consulte también
Gauge (Página 324)
CellCut (RT Professional)
Descripción
Define si el contenido de las celdas se abreviará en caso de que las celdas sean demasiado
estrechas.
Sintaxis
Object.CellCut[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el contenido se abrevia.
Consulte también

VB Scripting
CellSpaceBottom (RT Professional)
Descripción
Establece la distancia inferior que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceBottom[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece la distancia inferior que se utilizará en las celdas
de la tabla.
Consulte también
CellSpaceLeft (RT Professional)
Descripción
Establece el sangrado izquierdo que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceLeft[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o parámetro que determina el sangrado izquierdo dentro de las celdas de la
tabla.
Consulte también
CellSpaceRight (RT Professional)
Descripción
Establece el sangrado derecho que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceRight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las apariencias siguientes:
● AlarmControl
Int32
Opcional. Valor o constante que establece el sangrado derecho que se utilizará en las celdas
de la tabla.

VB Scripting
Consulte también
CellSpaceTop (RT Professional)
Descripción
Establece la distancia superior que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceTop[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las apariencias siguientes:
● AlarmControl
Int32
Opcional. Valor o constante que establece la distancia superior que se utilizará en las celdas
de la tabla.
Consulte también
CenterColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color del punto central.

VB Scripting
Sintaxis
Object.CenterColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color del punto central.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)
CenterSize (RT Professional)
Descripción
Determina el diámetro del centro de la escala.
Sintaxis
Object.CenterSize[=SINGLE]
Object
● Gauge
SINGLE
Opcional. Un valor o una constante que determina el diámetro del punto redondo del centro
de la escala.
Rango de valores de 0,03 a 1

VB Scripting
1: el diámetro se corresponde con el valor inferior de los atributos de geometría "Width" o

"Height".
Consulte también
Gauge (Página 324)
ChangeMouseCursor (RT Professional)
Descripción
Define si el aspecto del puntero del ratón permanecerá invariable en runtime cuando se
encuentre sobre el símbolo.
Sintaxis
Object.ChangeMouseCursor[=BOOLEAN]
Object
● SymbolLibrary
BOOLEAN
Opcional.
TRUE si el puntero tiene el aspecto de una flecha, aunque se coloque sobre el símbolo.
FALSE si el puntero del ratón tiene el aspecto de una flecha en 3D con el símbolo de un rayo
verde. Con ello se señaliza en runtime que el objeto correspondiente puede utilizarse.
Consulte también
CheckMarkAlignment (RT Professional)
Descripción
Define si los campos se disponen justificados a la derecha.
Sintaxis
Object.CheckMarkAlignment[=CheckMarkAlignment]

VB Scripting
Object
● CheckBox
● OptionGroup
CheckMarkAlignment
Opcional. Valor o constante que determina si los campos están justificados a la derecha.
Valor Explicación
0 Los campos se disponen justificados a la izquierda.
1 Los campos se disponen justificados a la derecha.
Consulte también
CheckMarkCount (RT Professional)
Descripción
Determina el número de campos.
Sintaxis
Object.CheckMarkCount[=Int32]
Object
● CheckBox
● OptionGroup
Int32
Opcional. Un valor o una constante que determina el número de campos. Rango de valores
de 0 a 31
Consulte también

VB Scripting
ClearOnError (RT Professional)
Descripción
Determina si se borra una entrada errónea automáticamente en este objeto.
Sintaxis
Object.ClearOnError[=BOOLEAN]
Object
● IOField
BOOLEAN
Opcional. TRUE si se borra una entrada errónea automáticamente en este objeto.
Consulte también
ClearOnFocus (RT Professional)
Descripción
Determina si se borra la entrada errónea en cuanto se activa el campo E/S.
Sintaxis
Object.ClearOnFocus[=BOOLEAN]
Object
● IOField
BOOLEAN
Opcional. TRUE si se borra la entrada errónea en cuanto se activa el campo E/S.
Consulte también

VB Scripting
Closeable (RT Professional)
Descripción
Define si el objeto se puede cerrar en runtime.
Sintaxis
Object.Closeable[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si el objeto puede cerrarse en runtime.
Consulte también
Color (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de línea.
Sintaxis
Object.Color[=Color]

VB Scripting
Object
● CircularArc
● Connector
● EllipticalArc
● Line
● Polyline
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
Color
Opcional. Valor o constante que determina el color de línea.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Line (Página 341)
TubeDoubleTeeObject (Página 468)
TubeTeeObject (Página 473)

VB Scripting
ColorChangeHysteresis (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la histéresis en porcentaje respecto al valor de visualización.
La propiedad "ColorChangeHysteresisEnable" debe tener el valor TRUE para que pueda
calcularse la histéresis.
Sintaxis
Object.ColorChangeHysteresis[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Un valor o una constante que determina la histéresis en porcentaje respecto al valor
de visualización.
Consulte también
Bar (Página 261)
ColorChangeHysteresisEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto se mostrará con histéresis.
Sintaxis
Object.ColorChangeHysteresisEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si el objeto se muestra con histéresis.

VB Scripting
Consulte también
Bar (Página 261)
ColumnAdd (RT Professional)
Descripción
Crea una columna nueva. La columna recién creada se referencia automáticamente mediante
"ColumnIndex".
Sintaxis
Object.ColumnAdd[=STRING]
Object
STRING
Necesario. Valor o constante que establece el nombre de una nueva columna.
Consulte también
ColumnIndex (Página 621)
ColumnAlias (RT Professional)
Descripción
Devuelve el nombre de visualización de la columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnAlias[=STRING]
Object

VB Scripting
STRING
Opcional. Valor o constante que define el nombre de visualización de la columna.
Consulte también
ColumnAlignment (RT Professional)
Descripción
Define la alineación del contenido de la columna en una columna referenciada mediante
"ColumnIndex".
Sintaxis
Object.ColumnAlignment[=HorizontalAlignment]
Object
HorizontalAlignment
Opcional. Valor o constante que define la alineación horizontal.

0 Izquierda El texto de la columna se justifica a la izquierda.
1 Centrado El texto de la columna se centra.
2 Derecha El texto de la columna se justifica a la derecha.
Consulte también
ColumnAutoPrecisions (RT Professional)
Descripción
Define si se determinará automáticamente el número de decimales de una columna

VB Scripting
Sintaxis
Object.ColumnAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el número de decimales se define automáticamente.
FALSE si se utiliza el valor de "ColumnPrecisions".
Consulte también
ColumnCaption (RT Professional)
Descripción
Determina el título de la columna actual.
Sintaxis
Object.ColumnCaption[=STRING]
Object
STRING
Opcional. Valor o constante que determina el título de la columna actual.
Consulte también
ColumnCount (RT Professional)
Descripción
Define el número de columnas configuradas.

VB Scripting
Sintaxis
Object.ColumnCount[=Int32]
Object
Int32
Opcional. Valor o constante que define el número de columnas configuradas.
Consulte también
ColumnDateFormat (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el formato de la indicación de fecha.
Sintaxis
Object.ColumnDateFormat[=STRING]
Object
STRING
Opcional. Valor o constante que define el formato para la indicación de fecha.
Consulte también

VB Scripting
ColumnDMVarName (RT Professional)
Descripción
Define el nombre de una variable.
Sintaxis
Object.ColumnDMVarName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de una variable.
Consulte también
ColumnExponentialFormat (RT Professional)
Descripción
Define si los valores de una columna referenciada mediante "ColumnIndex" se mostrarán en
representación exponencial.
Sintaxis
Object.ColumnExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Opcional.
FALSE si los valores no se muestran en representación exponencial.

VB Scripting
Consulte también
ColumnFlagNotNull (RT Professional)
Descripción
Define si el campo del fichero de usuario asignado a una columna referenciada mediante
"ColumnIndex" debe tener un valor.
Sintaxis
Object.ColumnFlagNotNull[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se requiere un valor.
FALSE si no se requiere ningún valor.
Consulte también
ColumnFlagUnique (RT Professional)
Descripción
Define si el campo del fichero de usuario asignado a una columna referenciada mediante
"ColumnIndex" debe tener un valor único. Los valores de esta columna deben diferenciarse
entre sí.
Sintaxis
Object.ColumnFlagUnique[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si el valor debe ser unívoco.
FALSE si el valor no necesita ser unívoco.
Consulte también
ColumnHideText (RT Professional)
Descripción
Define si se ocultará el texto de una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnHideText[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el texto de la columna actual está oculto.
FALSE si el texto de la columna actual es visible.
Consulte también
ColumnHideTitleText (RT Professional)
Descripción
Define si se ocultará el encabezado de una columna referenciada mediante "ColumnIndex".

VB Scripting
Sintaxis
Object.ColumnHideTitleText[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si está oculto el encabezado de la columna referenciada.
FALSE si se muestra el encabezado de la columna referenciada.
Consulte también
ColumnIndex (RT Professional)
Descripción
Hace referencia a una columna. Para acceder a las propiedades de una columna, es necesario
activar "ColumnIndex".
Los valores válidos para "ColumnIndex" se encuentran entre 0 y "ColumnCount" menos 1. La
propiedad "ColumnCount" indica el número de columnas configuradas.
Sintaxis
Object.ColumnIndex[=Int32]
Object
Int32
Opcional. Valor o constante que define a través del índice la columna que se editará.

VB Scripting
Consulte también
ColumnCount (Página 614)
ColumnLeadingZeros (RT Professional)
Descripción
Define con cuántos ceros a la izquierda se mostrarán los valores en una columna referenciada
Sintaxis
Object.ColumnLeadingZeros[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de ceros a la izquierda. El número
máximo es 11.
Consulte también
ColumnLength (RT Professional)
Descripción
Define el número de caracteres mostrados en una columna referenciada mediante
"ColumnIndex".
Sintaxis
Object.ColumnLength[=Int32]

VB Scripting
Object
Int32
Opcional. Valor o constante que determina el número de caracteres mostrados.
Consulte también
ColumnMaxValue (RT Professional)
Descripción
Devuelve el valor máximo definido en el fichero de usuario de una columna referenciada
Sintaxis
Object.ColumnMaxValue[=STRING]
Object
STRING
Opcional. Valor o constante que devuelve el valor máximo de la columna definido en el fichero
de usuario.
Consulte también
ColumnMinValue (RT Professional)
Descripción
Devuelve el valor mínimo definido en el fichero de usuario de una columna referenciada

VB Scripting
Sintaxis
Object.ColumnMinValue[=STRING]
Object
STRING
Opcional. Valor o constante que devuelve el valor mínimo de la columna actual definido en el
fichero de usuario.
Consulte también
ColumnName (RT Professional)
Descripción
Define el nombre de una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la columna referenciada.
Consulte también

VB Scripting
ColumnOrder (RT Advanced)
Descripción
ColumnPosition (RT Professional)
Descripción
Define la posición de una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnPosition[=Int32]
Object
Int32
Opcional. Valor o constante que determina la posición de la columna.
Consulte también
ColumnPrecisions (RT Professional)
Descripción
Define el número de decimales en una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnPrecisions[=Int16]
Object

VB Scripting
Int16
Opcional. Valor o constante que define el número de decimales de la columna.
Consulte también
ColumnReadAccess (RT Professional)
Descripción
Devuelve el permiso definido en el fichero de usuario para el acceso de lectura a una columna
El número es el mismo que el asignado al permiso en el editor "User Administrator".
Sintaxis
Object.ColumnReadAccess[=Int32]
Object
Int32
Opcional. Valor o constante que devuelve el permiso para el acceso de lectura a la columna
definida en el fichero de usuario.
Consulte también
ColumnReadonly (RT Professional)
Descripción
Define si los valores de una columna referenciada mediante "ColumnIndex" son de solo lectura.
Sintaxis
Object.ColumnReadonly[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si los valores de la columna son de solo lectura.
FALSE si los valores de la columna no son de solo lectura.
Consulte también
ColumnRemove (RT Professional)
Descripción
Elimina una columna referenciada mediante su nombre.
Sintaxis
Object.ColumnRemove[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la columna referenciada que se borrará.
Consulte también
ColumnRepos (RT Professional)
Descripción
En el caso de varias columnas, define la posición de una columna referenciada mediante
"ColumnIndex".
Si ha modificado la posición de la columna con "ColumnRepos", a "ColumnIndex" se le
asignará el valor de "ColumnRepos".

VB Scripting
Sintaxis
Object.ColumnRepos[=Int32]
Object
Int32
Opcional. Valor o constante que define la posición de la columna referenciada. Rango de
valores de 0 a "ColumnCount" menos 1. Los valores fuera de este rango de valores no tienen
ningún efecto.
0: La columna referenciada se posiciona a la izquierda.
Consulte también
ColumnCount (Página 614)
ColumnResize (RT Professional)
Descripción
Define si se puede modificar el ancho de las columnas.
Sintaxis
Object.ColumnResize[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si puede modificarse el ancho de las columnas.
FALSE si no puede modificarse el ancho de las columnas.
Consulte también
Columns (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnScrollbar (RT Professional)
Descripción
Define cuándo se mostrará la barra de desplazamiento horizontal.
Sintaxis
Object.ColumnScrollbar[=ScrollbarVisibility]
Object
● AlarmControl

VB Scripting
ScrollbarVisibility
Opcional. Valor o constante que define cuándo se mostrará la barra de desplazamiento
horizontal.
Valor Explicación
0 La barra de desplazamiento horizontal no se muestra.
1 Si el área de visualización es demasiado pequeña para las columnas, se muestra la barra
de desplazamiento horizontal.
2 La barra de desplazamiento horizontal se muestra siempre.
Consulte también
ColumnSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnSettingsBufferView (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnShowDate (RT Professional)
Descripción
Define si se mostrará la fecha en una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnShowDate[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si se muestra la fecha en la columna.
FALSE si no se muestra la fecha en la columna.
Consulte también
ColumnShowIcon (RT Professional)
Descripción
Define si se mostrará un símbolo en una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnShowIcon[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra un símbolo en la columna.
FALSE si no se muestra ningún símbolo en la columna.
Consulte también
ColumnShowTitleIcon (RT Professional)
Descripción
Define si se mostrará un símbolo en una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnShowTitleIcon[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si se muestra un símbolo en la columna.
FALSE si no se muestra ningún símbolo en la columna.
Consulte también
ColumnsMoveable (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnSort (RT Professional)
Descripción
Define el tipo de clasificación en una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnSort[=SortMode]
Object
SortMode
Opcional. Valor o constante que determina el modo de clasificación.
Valor Explicación
0 Sin clasificación
1 Clasificación ascendente desde el valor menor hasta el mayor
2 Clasificación descendente desde el valor mayor hasta el menor

VB Scripting
Consulte también
ColumnSortIndex (RT Professional)
Descripción
Define el orden de clasificación en una columna referenciada mediante "ColumnIndex" en la
que las columnas se clasifican de forma consecutiva.
Sintaxis
Object.ColumnSortIndex[=Int32]
Object
Int32
Opcional. Valor o constante que determina el índice de clasificación de la columna.
Valor Explicación
0 El sentido de clasificación definido en la propiedad "ColumnSort (Página 630)" se ajusta a "Sin clasificación".
1 En el encabezado aparece el número 1. La clasificación comienza por esta columna.
2-4 En el encabezado aparece el número seleccionado. Las columnas se clasifican en el orden correspondiente.
Consulte también
ColumnStartValue (RT Professional)
Descripción
Devuelve el valor inicial definido en el fichero de usuario de una columna referenciada

VB Scripting
Sintaxis
Object.ColumnStartValue[=STRING]
Object
STRING
Opcional. Valor o constante que devuelve el valor inicial de la columna definido en el fichero
de usuario.
Consulte también
ColumnStringLength (RT Professional)
Descripción
Devuelve la longitud de la cadena de caracteres definida en el fichero de usuario de una
columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnStringLength[=Int32]
Object
Int32
Opcional. Valor o constante que devuelve la longitud de la cadena de caracteres de la columna
Consulte también
ColumnTextAckGroup (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ColumnTextAlarmState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextAlarmText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextBit (RT Advanced)
Descripción
ColumnTextClassName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextConnection (RT Advanced)
Descripción
ColumnTextDataType (RT Advanced)
Descripción
ColumnTextDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ColumnTextDateTime (RT Advanced)
Descripción
ColumnTextDbNumber (RT Advanced)
Descripción
ColumnTextDevice (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextDiagnosable (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextFormat (RT Advanced)
Descripción
ColumnTextGroup (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextLogTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ColumnTextNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextOffset (RT Advanced)
Descripción
ColumnTextPassword (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextRead (RT Advanced)
Descripción
ColumnTextTagConnection (RT Advanced)
Descripción
ColumnTextTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextTrend (RT Advanced)
Descripción

VB Scripting
ColumnTextType (RT Advanced)
Descripción
ColumnTextUser (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextValue (RT Advanced)
Descripción
ColumnTextWrite (RT Advanced)
Descripción
ColumnTextXValue (RT Advanced)
Descripción
ColumnTimeFormat (RT Professional)
Descripción
Define el formato de la indicación de hora en una columna referenciada mediante
"ColumnIndex".
Sintaxis
Object.ColumnTimeFormat[=STRING]

VB Scripting
Object
STRING
Opcional. Valor o constante que define el formato de la indicación de fecha y hora en la
columna.
Valor Explicación
Automático El formato de tiempo se generará automáticamente.
HH:mm:ss.ms Horas:minutos:segundos, p. ej., 15:35:44.240.
hh:mm:ss tt Horas:minutos:segundos, AM/PM, p. ej., 03:35:44 PM.
hh:mm:ss.ms tt Horas:minutos:segundos.milisegundos AM/PM, p. ej., 03:35:44.240 PM.
Consulte también
ColumnTitleAlignment (RT Professional)
Descripción
Define la alineación del título en una columna referenciada mediante "ColumnIndex".
Sintaxis
Object.ColumnTitleAlignment[=GridColumnHeaderHorizontalAlignment]
Object
● AlarmControl
GridColumnHeaderHorizontalAlignment
Opcional. Valor o constante que define la alineación del título de columna.

0 Izquierda El título de columna se justifica a la izquierda.
1 Centrado El título de columna se justifica en el centro.

VB Scripting

2 Derecha El título de columna se justifica a la derecha.
3 Como la tabla El título de columna se alinea como se ha definido en la propiedad "Co‐
lumnAlignment (Página 613)" para el contenido de la columna.
Consulte también
ColumnTitles (RT Professional)
Descripción
Define si se mostrará el título de las columnas.
Sintaxis
Object.ColumnTitles[=BOOLEAN]
Object
● AlarmControl
● UserArchive Control
BOOLEAN
Opcional.
TRUE si se muestra el título de las columnas.
FALSE si no se muestra el título de las columnas.
Consulte también

VB Scripting
ColumnType (RT Professional)
Descripción
Devuelve el tipo de datos definido en el fichero de usuario de una columna referenciada
Sintaxis
Object.ColumnType[=Int32]
Object
Int32
Opcional. Valor o constante que devuelve el tipo de datos de la columna definido en el fichero
de usuario.
Consulte también
ColumnVisible (RT Professional)
Descripción
Define si se mostrará la columna referenciada mediante "ColumnIndex" en el objeto.
Sintaxis
Object.ColumnVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra la columna referenciada.
FALSE si no se muestra la columna referenciada.

VB Scripting
Consulte también
ColumnWidth (RT Advanced)
Descripción
ColumnWriteAccess (RT Professional)
Descripción
Devuelve el permiso definido en el fichero de usuario para el acceso de escritura a una
columna referenciada mediante "ColumnIndex".
El número es el mismo que el asignado al permiso en el editor "User Administrator".
Sintaxis
Object.ColumnWriteAccess[=Int32]
Object
Int32
Opcional. Valor o constante que devuelve el permiso para el acceso de escritura a la columna
Consulte también
ComboboxFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
CompatibilityMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ComplexViewToolbar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ComplexViewToolbarBounds (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ComponentInfoText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ComputerName (RT Professional)
Descripción
Devuelve el nombre del ordenador en el que se habilitó el objeto Alarm.
ComputerName (readonly)
ConfiguredAlarmClasses (RT Advanced)
Descripción
ConnectionType (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el tipo del conector. Puede elegir entre dos tipos de conexión.

VB Scripting
Acceso en runtime:
Sintaxis
Object.ConnectionType[=ConnectorConnectionType]
Object
● Connector
● SmartClientView
ConnectorConnectionType
Opcional. Valor o constante que define el tipo de conector.
( 0): Automático: ambos objetos se conectan mediante una línea poligonal de partes
horizontales y verticales.
( 1): Simple: ambos objetos se conectan mediante una línea recta entre puntos de unión. Los
campos se disponen justificados a la derecha.
Consulte también
SmartClientView (Página 418)
ConnectOnStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ConnectTrendWindows (RT Professional)
Descripción
Define si se enlazan los visores de curvas configurados. El requisito para ello es que se hayan
configurado varios visores de curvas.
Los visores de curvas enlazados tienen las siguientes características:
● un eje X común;
● una barra de desplazamiento;
● una regla.

VB Scripting
Sintaxis
Object.ConnectTrendWindows[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se enlazan todos los visores de curvas configurados.
FALSE si los visores de curvas se muestran separados.
Consulte también
Context (RT Professional)
Descripción
Lee o fija el prefijo del servidor del objeto Alarm.
ContinousChange (RT Professional)
Descripción
Determina si el valor de la propiedad "ProcessValue" se transfiere al soltar el botón del ratón
o justo en el momento de cambiar la posición del deslizador en runtime.
Sintaxis
Object.ContinousChange[=BOOLEAN]
Object
● Slider

VB Scripting
BOOLEAN
Opcional. TRUE si el valor de la propiedad "ProcessValue" se transfiere al soltar el botón del
ratón o justo en el momento de cambiar la posición del deslizador en runtime.
Consulte también
ControlDesignMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la apariencia del control.
Sintaxis
Object.ControlDesignMode[=RTControlModes]
Object
● AlarmControl
RTControlModes
Opcional. Valor o constante que define la apariencia del control.

Configuración del proyecto El diseño se corresponde con la configuración del proyecto en WinCC
Explorer.
0 Simple Diseño de WinCC clásico
1 Predeterminado Diseño de WinCC V7 nuevo
Consulte también

VB Scripting

CornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
CornerStyle (RT Professional)
Descripción
Define la forma de las esquinas.
Acceso en runtime:
Sintaxis
Object.CornerStyle[=CornerStye | LineJoinStyle]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line

VB Scripting
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Tubepolyline
● WindowSlider
● Switch
● TubeArcObject
CornerStyle | LineJoinStyle
Opcional. Valor o constante que define la forma de las esquinas.
Valor Explicación
0 Línea continua
2 Línea punteada
Count (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Retorna el número de elementos en la lista indicada.
Sintaxis
Object.Count
Object
Obligatorio. Objeto del tipo "Collection".

VB Scripting
CountDivisions (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el número de segmentos en los que se dividirá la barra por medio de las marcas
grandes de la escala.
Sintaxis
Object.CountDivisions[=Int32]
Object
● Bar
Int32
Opcional. Un valor o una constante que determina el número de segmentos en los que se
dividirá la barra por medio de las marcas grandes de la escala.
0-100: el objeto puede dividirse en 100 segmentos como máximo
= 0: el número óptimo de segmentos se determina de manera automática
Consulte también
Bar (Página 261)
CountOfLinesPerAlarms (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
CountOfVisibleAlarms (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
CountSubDivisions (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el número de marcas de la escala entre dos marcas principales.

VB Scripting
Sintaxis
Object.CountSubDivisions[= Int32]
Object
● Bar
Int32
Opcional. Valor o constante que define el número de marcas de la escala.
Consulte también
Bar (Página 261)
CountVisibleItems (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina cuántas líneas contiene la lista de selección. Si el número de textos configurados
es superior a este valor, la lista de selección dispondrá de una barra de desplazamiento
vertical.
Acceso en runtime:
Sintaxis
Object.CountVisibleItems[=Int32]
Object
● ComboBox
● ListBox
● SymbolicIOField
● StatusForce
● TrendView
● UserView

VB Scripting
Int32
Opcional. Valor o constante que determina cuántas líneas contiene la lista de selección.
Consulte también
CurrentContext (RT Professional)
Descripción
Devuelve una cadena de caracteres según el uso de la función.
Si la función está incluida en una imagen de la ventana de imagen, CurrentContext devuelve
el nombre simbólico del servidor que proporciona la imagen. Ejemplo:
"WinCCProject_MyComputer::"
Si la función está incluida en la imagen raíz, se devuelve una cadena de caracteres vacía.
Sintaxis
Object.CurrentContext
Object
Se necesita. Objeto del tipo "HMIRuntime".
Consulte también
CursorControl (RT Professional)
Descripción
Determina si el puntero del ratón debe saltar al siguiente campo del orden de tabulación tras
salir del campo.

VB Scripting
Sintaxis
Object.CursorControl[=BOOLEAN]
Object
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE, si el puntero del ratón salta al siguiente campo del orden de TAB- tras salir
del campo.
Observaciones
Para ello, la propiedad "CursorMode" debe haberse puesto a TRUE.
Consulte también
Curves (RT Advanced)
Descripción
1.5.5.4 Propiedades D (Panels, Comfort Panels, RT Advanced, RT Professional)
DangerRangeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del rango de peligro en la escala del objeto "Gauge".
La propiedad "DangerRangeVisible" debe tener el valor TRUE para que se visualice el rango
de peligro.
Sintaxis
Object.DangerRangeColor[=Color]

VB Scripting
Object
● Gauge
Color
Opcional. Valor o constante que determina el color del rango de peligro.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)
DangerRangeStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define a partir de qué valor de la escala comienza el rango de peligro del objeto "Gauge".
La propiedad "DangerRangeColor" debe tener el valor TRUE para que se visualice el rango
de peligro.
Sintaxis
Object.DangerRangeStart[=SINGLE]
Object
● Gauge
SINGLE
Opcional. Valor o constante que determina el valor de la escala para el principio del rango de
peligro.

VB Scripting
Observaciones
El rango va desde el valor de "DangerRangeStart" hasta el final de la escala.
Consulte también
Gauge (Página 324)
DangerRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse el rango de peligro en la escala del objeto "Gauge".
Sintaxis
Object.DangerRangeVisible[=BOOLEAN]
Object
● Gauge
BOOLEAN
Opcional. TRUE si debe mostrarse el rango de peligro en la escala.
Observaciones
El color del rango de peligro se define con la propiedad "DangerRangeColor".
El principio del rango de peligro se define con la propiedad "DangerRangeStart".
Consulte también
Gauge (Página 324)
DataFormat (RT Professional)
Descripción
Devuelve el formato de visualización.
Sintaxis
Object.DataFormat[=IOFieldDataFormat]

VB Scripting
Object
● IOField
IOFieldDataFormat
Opcional. Valor o constante que devuelve el formato de visualización.

0 Binaria El contenido se visualiza en formato de datos "binario".
1 Decimal El contenido se visualiza en formato de datos "decimal".
2 Cadena Representa cadenas de caracteres.
3 Hexadecimal El contenido se visualiza en formato de datos "hexadecimal".
Consulte también
DataLogs (RT Professional)
Descripción
Devuelve un objeto del tipo "DataLogs".
Sintaxis
Object.DataLogs
Object
Obligatorio. Un objeto del tipo "Logging".
Consulte también
DataProviderGuid (RT Professional)
Descripción
Devuelve el GUID del control.

VB Scripting
Sintaxis
Object.DataProviderGuid
Object
Necesario. Un objeto del tipo "UserArchiveControl".
Ejemplo
Dim objRecipeview
Set objRecipeview= HMIRuntime.Screens("Screen_1").ScreenItems("Recipeview_1")
SmartTags("Tag1") = objRecipeView.DataProviderGuid
Consulte también
DataRecordNameCaption (RT Advanced)
Descripción
DataRecordNrCaption (RT Advanced)
Descripción
DataSet (RT Professional)
Descripción
Devuelve un objeto del tipo "DataSet".
Sintaxis
Object.DataSet
Object
Obligatorio. Un objeto del tipo "Screen".

VB Scripting
Consulte también
DataSource (RT Professional)
Descripción
DefaultFilterEom (RT Professional)
Descripción
DefaultHitListFilterEom (RT Professional)
Descripción
DefaultMsgFilterSQL (RT Professional)
Descripción
Define una instrucción SQL como estándar para el filtro de avisos.
Sintaxis
Object.DefaultMsgFilterSQL[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define una instrucción SQL como estándar para el filtro de
avisos.

VB Scripting
Consulte también
DefaultSort (RT Professional)
Descripción
Establece el tipo de clasificación.
Sintaxis
Object.DefaultSort[=SortMode]
Object
● AlarmControl
SortMode
Opcional. Valor o constante que establece el tipo de clasificación.
Valor Explicación
1 Los avisos se actualizan comenzando por la última línea.
2 Los avisos se actualizan comenzando por la primera línea.
Consulte también
DefaultSort2 (RT Professional)
Descripción
Establece el tipo de clasificación.
Sintaxis
Object.DefaultSort2[=SortMode]

VB Scripting
Object
● AlarmControl
SortMode
Opcional. Valor o constante que establece el tipo de clasificación.
Valor Explicación
1 Los avisos se actualizan comenzando por la última línea.
2 Los avisos se actualizan comenzando por la primera línea.
Consulte también
DefaultSort2Column (RT Professional)
Descripción
Define la columna por la cual se clasifican inicialmente las entradas de la tabla.
Si no se ha asignado ningún valor, el orden de columnas según el cual se clasifican los avisos
será el siguiente:
● Fecha/hora/número
Si, p. ej., se configura la columna "Texto de aviso" como valor, los avisos se clasificarán por
el siguiente orden de columnas:
● Texto de aviso/fecha/hora/número
Sintaxis
Object.DefaultSort2Column[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre de la columna por la cual se clasificarán
inicialmente las entradas de tabla.
Consulte también

VB Scripting
DeviceStyle (RT Professional)
Descripción
DiagnosticsContext (RT Professional)
Descripción
Define el contexto de diagnóstico.
Sintaxis
Object.DiagnosticsContext[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el contexto de diagnóstico.
Consulte también
DiagramAreaHeight (RT Advanced)
Descripción
DiagramAreaLeft (RT Advanced)
Descripción

VB Scripting
DiagramAreaTop (RT Advanced)
Descripción
DiagramAreaWidth (RT Advanced)
Descripción
DialColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la esfera del objeto indicado.
Sintaxis
Object.DialColor[=Color]
Object
● Clock
● Gauge
Color
Opcional. Valor o constante que determina el color de la esfera.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
Clock (Página 290)
Gauge (Página 324)
DialFillStyle (RT Professional)
Descripción
Determina el tipo de fondo.
Sintaxis
Object.DialFillStyle[=GaugeFillStyle]
Object
● Gauge
GaugeFillStyle
Opcional. Valor o constante que define el tipo de fondo.

0 hmiBackStyleSolid El fondo rectangular de la visualización está rellenado con el color de borde
indicado. El cuadrante está rellenado con el color de fondo indicado.
1 hmiBackStyleFrameTranspa‐ El fondo rectangular es transparente. El cuadrante está rellenado con el color
rent de fondo indicado. De este modo es posible representar una visualización en
forma de círculo.
2 hmiBackStyleTransparent El fondo rectangular y la escala circular son transparentes.
Consulte también
Gauge (Página 324)
DialPicture (RT Professional)
Descripción
Establece un gráfico para la esfera.
Sintaxis
Object.DialPicture[=HmiObjectHandle]

VB Scripting
Object
● Gauge
HmiObjectHandle
Opcional. Valor o constante que determina el gráfico de la esfera.
Consulte también
Gauge (Página 324)
DialSize (RT Professional)
Descripción
Determina el diámetro del cuadrante en relación con el valor más pequeño de los atributos
de geometría "Width" y "Height".
Sintaxis
Object.DialSize[=SINGLE]
Object
● Gauge
SINGLE
Opcional. Un valor o una constante que determina el diámetro del cuadrante en relación con
el valor más pequeño de los atributos de geometría "Width" y "Height".
Consulte también
Gauge (Página 324)
Display3D (RT Advanced)
Descripción

VB Scripting
DisplayButton2Plc (RT Advanced)
Descripción
DisplayButtonComparison (RT Advanced)
Descripción
DisplayButtonDelete (RT Advanced)
Descripción
DisplayButtonFromPlc (RT Advanced)
Descripción
DisplayButtonHelp (RT Advanced)
Descripción
DisplayButtonNew (RT Advanced)
Descripción
DisplayButtonSave (RT Advanced)
Descripción

VB Scripting
DisplayButtonSaveAs (RT Advanced)
Descripción
DisplayCentury (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
DisplayComboBox (RT Advanced)
Descripción
DisplayGridLines (RT Advanced)
Descripción
DisplayLabeling (RT Advanced)
Descripción
DisplayNumbers (RT Advanced)
Descripción
DisplayOptions (RT Professional)
Descripción
Determina si se mostrarán los avisos cuya visualización se ha ocultado.

VB Scripting
Sintaxis
Object.DisplayOptions[=AlarmDisplayOptions]
Object
● AlarmControl
AlarmDisplayOptions
Opcional. Valor o constante que define si se mostrarán los avisos cuya visualización se ha
ocultado.
Valor Explicación
0 Todos los avisos
1 solo avisos visibles
2 solo avisos ocultos
Consulte también
DisplaySize (RT Advanced)
Descripción
DisplayStatusBar (RT Advanced)
Descripción
DisplaySystemTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
DisplayTable (RT Advanced)
Descripción

VB Scripting
DoubleClickAction (RT Professional)
Descripción
Define la acción que se realizará cuando se haga doble clic en la fila de avisos en runtime.
Sintaxis
Object.DoubleClickAction[=AlarmControlActions]
Object
● AlarmControl
AlarmControlActions
Opcional. Valor o constante que define la acción que se realizará al hacer doble clic en una
fila de avisos en runtime.
Valor Descripción Explicación

0 Ninguno No se ejecutará ninguna acción.
1 Loop in Alarm Se ejecutará la función "Loop-in-Alarm".
2 Apertura del cuadro de diálogo Se ejecuta la función de tecla "Diálogo de comentario".
comentario
3 Abrir diálogo de texto informativo Se ejecuta la función de tecla "Diálogo de texto informati‐
vo".
4 Depende de la columna La acción ejecutada se rige por la columna donde haya
hecho el doble clic.
Consulte también
DrawInsideFrame (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si la línea de borde se traza dentro del borde o simétricamente respecto al borde a
partir de un grosor de línea superior a 1.
Acceso en runtime:

VB Scripting
Sintaxis
Object.DrawInsideFrame[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● OptionGroup
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● Switch
● TubeArcObject
BOOLEAN
Opcional. TRUE si la línea de borde se traza a partir de un grosor de línea superior a 1 dentro
del borde.
Drive (RT Professional)
Descripción

VB Scripting
1.5.5.5 Propiedades E-F (Panels, Comfort Panels, RT Advanced, RT Professional)
EdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el estilo de línea.
Acceso en runtime:
Sintaxis
Object.EdgeStyle[=LineStyle]
Object
● Bar
● Button
● CheckBox
● Circle *
● CircleSegment
● ComboBox
● Ellipse *
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField *
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon *
● Rectangle *
● RoundButton
● SymbolicIOField
● TextField *
● WindowSlider

VB Scripting

● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
LineStyle
Opcional. Un valor o una constante que determina el estilo de línea. Rango de valores de -1
a 4.
Los objetos "Ellipse", "Circle", "Rectangle" y "Polygon" admiten los estilos de línea:

0 hmiLineStyleSolid Línea continua
1 hmiLineStyleDash Línea discontinua
2 hmiLineStyleDot Línea de puntos
3 hmiLineStyleDashDot Línea de rayas y puntos
4 hmiLineStyleDashDot‐ Línea punto punto raya
Dot
Los objetos "TextField"" y "IOField" solo admiten los estilos de línea:

-1 hmiLineStyleNone Sin línea
Consulte también
Bar (Página 261)

VB Scripting

Gauge (Página 324)
EditOnFocus (RT Professional)
Descripción
Determina si pueden introducirse datos inmediatamente cuando el campo de entrada está
seleccionado con la tecla <Tab>.
Sintaxis
Object.EditOnFocus[=BOOLEAN]

VB Scripting
Object
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE si pueden introducirse datos inmediatamente cuando el campo de entrada
está seleccionado con la tecla <Tab>.
Consulte también
Enabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el objeto indicado se podrá manejar en runtime.
Sintaxis
Object.Enabled[=BOOLEAN]
Object
● AlarmControl *
● AlarmView **
● Bar
● Button
● ChannelDiagnose *
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● Clock
● ComboBox *
● Connector *

VB Scripting
● DiscSpaceView *
● Ellipse
● EllipticalArc *
● FunctionTrendControl **
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox *
● MediaPlayer
● MultiLineEdit *
● OptionGroup *
● PLCCodeViewer **
● PdfView **
● Polygon
● Polyline
● ProDiagOverview ***
● RecipeView **
● Rectangle
● RoundButton *
● S7GraphOverview **
● Slider
● SmartClientView **
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField
● SysDiagControl ****
● TextField
● TrendView **
● TubeArcObject *

VB Scripting
● TubeTeeObject *
● Tubepolyline *
● UserView
● WindowSlider *
*** RT Advanced: Acceso de lectura
**** Solo acceso de lectura

BOOLEAN
Opcional. T RUE si el objeto indicado se puede manejar.
Consulte también
Bar (Página 261)
ChannelDiagnose (Página 277)
Clock (Página 290)
DiskSpaceView (Página 301)

VB Scripting
Gauge (Página 324)

Line (Página 341)
PLCCodeViewer (Página 382)
S7GraphOverview (Página 408)

VB Scripting

EnableDelete (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si pueden borrarse datos en runtime.
Sintaxis
Object.EnableDelete[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si pueden borrarse datos en runtime.
FALSE si no pueden borrarse datos en runtime.
Consulte también
EnableEdit (RT Professional)
Descripción
Determina si se pueden modificar los datos mostrados en runtime.
Sintaxis
Object.EnableEdit[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si los datos pueden modificarse en runtime.
FALSE si los datos no pueden modificarse en runtime.
Consulte también
EnableInsert (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si pueden insertarse datos en runtime.
Sintaxis
Object.EnableInsert[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si pueden insertarse datos en runtime.
FALSE si no pueden insertarse datos en runtime.
Consulte también
EnableNavigateButtons (RT Advanced)
Descripción

VB Scripting
EnableNavigateKeys (RT Advanced)
Descripción
EncryptCommunication (RT Advanced)
Descripción
EndAngle (RT Professional)
Descripción
Define el ángulo en el que se desvía del origen (0°) el punto final.
Sintaxis
Object.EndAngle[=Int32]
Object
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Opcional. Valor o constante que define el ángulo en el cual el punto final se desviará de la
posición cero (0°).
Consulte también

VB Scripting
EndLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EndStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la forma con la que se representa el final de línea.
Sintaxis
Object.EndStyle[=LineEndStyle]
Object
● Connector
● Line
● Polyline
LineEndStyle
Opcional. Un valor o una constante que determina el final de línea.

0 hmiLineEndStyleNone La línea no tiene ningún símbolo de fin.
65536* hmiLineEndStyleArrow La línea termina con una punta de flecha vacía.
131072 hmiLineEndStyleFilledArrow La línea termina con una punta de flecha rellena.
196608* hmiLineEndStyleFilledArrowReversed La línea termina con una punta de flecha invertida.
262144* hmiLineEndStyleLine La línea termina con una línea vertical.
327680* hmiLineEndStyleCircle La línea termina con un círculo.
393216* hmiLineEndStyleFilledCircle La línea termina con un círculo relleno.
* Solo RT Professional
Consulte también
Line (Página 341)

VB Scripting
EndTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EnterButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EntryNameCaption (RT Advanced)
Descripción
EntryNameColumnWidth (RT Advanced)
Descripción
EntryValueColFirst (RT Advanced)
Descripción
EntryValueColumnWidth (RT Advanced)
Descripción
EntryValueFieldLength (RT Advanced)
Descripción

VB Scripting
EntryValuePos (RT Advanced)
Descripción
ErrorColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de los errores en la vista general de GRAPH.
Sintaxis
Object.ErrorColor[=Color]
Object
● S7GraphOverview
Color
Opcional. Valor o constante que define el color de los errores.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
ErrorDescription (RT Professional)
Descripción
Devuelve una de las siguientes descripciones de error en inglés:
Impresión Descripción
"" Aceptar
"Operation Failed" Error de ejecución
"Variable not found" Error de variable
"Server down" Servidor no disponible
"An error occured for one or several tags" Multi Tag Error (error en una o varias variables)
Para obtener una descripción del error debe ejecutarse primero el método Read.
Nota
Si el error se produce al acceder a través del objeto TagSet, evalúe la propiedad
ErrorDescription para cada variable del objeto TagSet.
Sintaxis
Object.ErrorDescription
Object
Obligatorio. Un objeto del tipo "Tag".
Ejemplo
El siguiente ejemplo muestra la descripción del error para la variable "Tag1":
'VBS72
Dim objTag
objtag.Read
MsgBox objTag.ErrorDescription

VB Scripting
El siguiente ejemplo agrega a la lista TagSet dos variables y presenta la propiedad

ErrorDescription como Trace:
'VBS179
Dim group
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "ErrorDescription: " & group.ErrorDescription & vbNewLine
Se puede acceder a la propiedad ErrorDescription de una variable contenida en la lista del

siguiente modo:
HMIRuntime.Trace "ErrorDescription: " & group("Motor1").ErrorDescription & vbNewLine
Consulte también
Tag (Página 230)
TagSet (lista) (Página 234)
Errorflag (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si se muestra una descripción del error en la vista de dispositivos/vista detallada.
Sintaxis
Object.Errorflag[=BOOLEAN]
Object
● S7GraphOverview
BOOLEAN
Opcional.
TRUE si se muestra una definición del error en la vista de dispositivos/vista detallada.
FALSE si no se muestra ninguna definición del error en la vista de dispositivos/vista detallada.
Consulte también

VB Scripting
ES2RT_ButtonPositions (RT Advanced)
Descripción
ES2RT_ColumnOrder (RT Advanced)
Descripción
ES2RT_ColumnWidth (RT Advanced)
Descripción
ES2RT_EntryNameColumnWidth (RT Advanced)
Descripción
ES2RT_EntryValueColumnWidth (RT Advanced)
Descripción
ES2RT_ListAreaHeight (RT Advanced)
Descripción
ES2RT_ListAreaWidth (RT Advanced)
Descripción

VB Scripting
ES2RT_MessageAreaHeight (RT Advanced)
Descripción
ES2RT_MessageAreaWidth (RT Advanced)
Descripción
ES2RT_StoreAsCheckBack (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Es2rtButtonPositions (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Es2rtTableBounds (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EscButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EsPreviewType (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
EvenRowBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ExportDelimiter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ExportDirectoryChangeable (RT Professional)
Descripción
Define si el directorio para la exportación de datos se podrá modificar en runtime.
Sintaxis
Object.ExportDirectoryChangeable[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el directorio para la exportación de datos se puede modificar en runtime.
FALSE si el directorio para la exportación de datos no se puede modificar en runtime.
Consulte también

VB Scripting

ExportDirectoryname (RT Professional)
Descripción
Determina el directorio en el cual se exportarán los datos runtime.
Sintaxis
Object.ExportDirectoryname[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el directorio.
Consulte también

VB Scripting
ExportFileExtension (RT Professional)
Descripción
Define la extensión del archivo de exportación. Hasta el momento solamente es compatible
la extensión "csv".
Sintaxis
Object.ExportFileExtension[=STRING]
Object
● AlarmControl
STRING
Opcional. Define la extensión del archivo de exportación.
Consulte también
ExportFilename (RT Professional)
Descripción
Define el nombre del archivo al cual se exportarán los datos de runtime.

VB Scripting
Sintaxis
Object.ExportFilename[=STRING]
Object
● AlarmControl
STRING
Opcional. Define el nombre del archivo al cual se exportarán los datos de runtime.
Consulte también
ExportFilenameChangeable (RT Professional)
Descripción
Define si el nombre del archivo de exportación se podrá modificar en runtime.
Sintaxis
Object.ExportFilenameChangeable[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si el nombre del archivo de exportación se puede modificar en runtime.
FALSE si el nombre del archivo de exportación no se puede modificar en runtime.
Consulte también
ExportFormat (RT Professional)
Descripción
ExportFormatGuid (RT Professional)
Descripción
Define la asignación de número de ident. y Export-Provider.
Sintaxis
Object.ExportFormatGuid[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Opcional. Valor o constante que define la asignación de número de identidad y Export-
Provider.
Consulte también
ExportFormatName (RT Professional)
Descripción
Determina el formato de archivo para la exportación. Actualmente sólo está disponible el
formato de archivo "csv" para la exportación de datos.
Sintaxis
Object.ExportFormatName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el formato de archivo para la exportación.

VB Scripting
Consulte también
ExportParameters (RT Professional)
Descripción
Define los parámetros del formato seleccionado en el cuadro de diálogo de propiedades.
Acceso en runtime: lectura y escritura.
Sintaxis
Object.ExportParameters
Object
● AlarmControl
ExportParameters
Opcional. Valor o constante que establece los parámetros del formato seleccionado mediante
el cuadro de diálogo de propiedades.
Consulte también

VB Scripting
ExportSelection (RT Professional)
Descripción
Define qué datos de runtime del control se exportarán.
Sintaxis
Object.ExportSelection[=ExportRange]
Object
● AlarmControl
ExportRange
Opcional. Valor o constante que define qué datos de runtime del control se exportarán.

0 Todo Todos los datos runtime del Control se exportarán.
1 Selección Los datos runtime seleccionados del Control se exportarán.
Consulte también
ExportShowDialog (RT Professional)
Descripción
Determina si el cuadro de diálogo para la exportación de datos se mostrará en runtime.

VB Scripting
Sintaxis
Object.ExportShowDialog[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si el cuadro de diálogo se muestra en runtime.
Consulte también
ExtendedZoomingEnable (RT Professional)
Descripción
Determina si el operador puede ampliar o reducir la imagen en runtime girando la rueda del
ratón.
Sintaxis
Object.ExtendedZoomingEnable[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional. TRUE si el operador puede ampliar o reducir la imagen en runtime.
Ejemplo
El siguiente ejemplo muestra cómo se activa el zoom avanzado para la imagen NewPDL1:
'VBS155
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
objScreen.ExtendedZoomingEnable = 1
Consulte también
ExtraHeightOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FieldLength (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FileName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el nombre del archivo que se cargará.
Acceso en runtime:
Sintaxis
Object.FileName[=STRING]

VB Scripting
Object
● MediaPlayer
● PdfView
STRING
Opcional. Valor o constante que determina el nombre del archivo que se va a cargar.
Consulte también
FillColorMode (RT Professional)
Descripción
Determina el tipo de primer plano para el objeto indicado.
Sintaxis
Object.FillColorMode[=SymbolLibraryColorMode]
Object
● SymbolLibrary
SymbolLibraryColorMode
Opcional. Valor o constante que determina el tipo de primer plano del objeto.
Va‐ Constante VB Explicación

lor
0 hmiSymbolLibraryAppearanceOriginal La superficie es gris.
1 hmiSymbolLibraryAppearanceShaded La representación está sombreada.
2 hmiSymbolLibraryAppearanceSolid La representación es sólida.
3 hmiSymbolLibraryAppearanceTranspa‐ La representación es gris.
rent
Consulte también

VB Scripting
FillPattern (RT Professional)
Descripción
FillPatternColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del patrón de relleno.
Acceso en runtime:
Sintaxis
Object.FillPatternColor[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowSlider
*: Solo acceso de lectura

VB Scripting

● AlarmControl
● ComboBox
● DateTimeField
● ListBox
Color
Opcional. Valor o constante que determina el color del patrón de relleno.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)

VB Scripting

FillStyle (RT Advanced)
Descripción
Define si se visualizará el color de fondo de una línea quebrada.
Sintaxis
Object.FillStyle[=LineFillStyle]
Object
● Line
● Polyline
LineFillStyle
Opcional. Valor o constante que determina el patrón de relleno.

0 hmiLineFillStyleTransparent Fondo transparente
1 hmiLineFillStyleSolid El fondo del objeto se rellena con el color indicado
Consulte también
Line (Página 341)

VB Scripting
FillingDirection (RT Professional)
Descripción
Define la dirección de llenado.
Sintaxis
Object.FillingDirection[=FillDirection]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowSlider
FillDirection
Opcional. Valor o constante que define la dirección de llenado.
Filter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
FilterSQL (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define una instrucción SQL para el criterio de filtro.
Sintaxis
Object.FilterSQL[=STRING]
Object
STRING
Opcional. Valor o constante que determina la instrucción SQL para el criterio de filtro.
Consulte también
FilterTag (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FilterText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FirstConnectedObject (RT Professional)
Descripción

VB Scripting
FirstConnectedObjectIndex (RT Professional)
Descripción
Define el número de índice del punto del conector superior.
Sintaxis
Object.FirstConnectedObjectIndex[=Int]
Object
● Connector
Int
Opcional. Valor o constante que define el número de índice del punto de conexión superior.
Consulte también
FirstConnectedObjectName (RT Professional)
Descripción
Define el nombre del objeto que está acoplado en el punto de conexión superior.
Sintaxis
Object.FirstConnectedObjectName[=String]
Object
● Connector
String
Opcional. Valor o constante que define el nombre del objeto que está acoplado al punto de
conexión superior.
Consulte también

VB Scripting
FirstGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FirstGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FitToLargest (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FitToSize (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FitToSizeLowerRows (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FitToSizeUpperRows (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FixedAspectRatio (RT Professional)
Descripción
Determina si al modificar el tamaño del símbolo se mantiene la proporción de página o si es
variable.

VB Scripting
Sintaxis
Object.FixedAspectRatio[=BOOLEAN]
Object
● SymbolLibrary
BOOLEAN
Opcional. TRUE si al modificar el tamaño del símbolo se mantiene la proporción de página.
Consulte también
Flashing (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el objeto indicado parpadeará en runtime.
Acceso en runtime:
Sintaxis
Object.Flashing[=FlashingType]
Object
● Clock
● Gauge
● Slider
● AlarmView
● Bar
● Button
● CheckBox
● Circle

VB Scripting
● CircleSegment
● CircularArc
● Connector
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● ScreenWindow
● SmartClientView
● StatusForce
● Switch
● SymbolicIOField
● SymbolLibrary
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● UserView
● WindowSlider
FlashingType
Opcional. Valor o constante que define si el objeto parpadea en runtime.
Nombre Explicación
Ninguno El objeto no parpadea en runtime.
Predeterminado El objeto parpadea en runtime.

VB Scripting
FlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la línea de borde para el estado de parpadeo "Off".
Acceso en runtime:
Sintaxis
Object.FlashingColorOff[=Color]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField

VB Scripting

● Bar
● Switch
● TubeArcObject
Color
"Off".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Line (Página 341)
Bar (Página 261)

VB Scripting

FlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la línea de borde para el estado de parpadeo "On".
Acceso en runtime:
Sintaxis
Object.FlashingColorOn[=Color]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField

VB Scripting

● Bar
● Switch
● TubeArcObject
Color
"On".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Line (Página 341)
Bar (Página 261)

VB Scripting

FlashingEnabled (RT Professional)
Descripción
Define si se activa el parpadeo del objeto en runtime.
Acceso en runtime:
Sintaxis
Object.FlashingEnabled[=BOOLEAN]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● TextField

VB Scripting

● Bar
● Switch
● TubeArcObject
BOO LEAN
Opcional.
TRUE si está activado el parpadeo del objeto en runtime.
FALSE si no está activado el parpadeo del objeto en runtime.
Consulte también
Line (Página 341)
Bar (Página 261)

VB Scripting
FlashingOnLimitViolation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la frecuencia de parpadeo de la línea de borde.
Acceso en runtime:
Sintaxis
Object.FlashingRate[=FlashingRate]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton

VB Scripting
● TextField
* Solo acceso de lectura

● Bar
● Switch
● TubeArcObject
FlashingRate
Opcional. Valor o constante que define la frecuencia de parpadeo de la línea de borde.

Consulte también
Line (Página 341)
Bar (Página 261)

VB Scripting

FlashTransparentColor (RT Professional)
Descripción
Define el color del objeto de mapa de bits de una imagen intermitente que se ajustará a
"transparente".
Sintaxis
Object.FlashTransparentColor[=Color]
Object
● GraphicIOField
Color
Opcional. Un valor o una constante que define el color del objeto de mapa de bits de una
imagen intermitente que se ajusta como "transparente".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Flip (RT Professional)
Descripción
Define si el símbolo se volteará por su eje central vertical u horizontal.

VB Scripting
Sintaxis
Object.Flip[=SymbolLibraryFlip]
Object
● SymbolLibrary
SymbolLibraryFlip
Opcional. Valor o constante que define si el símbolo se voltea por su eje central vertical u
horizontal.

0 hmiSymbolLibraryFlipNone El símbolo no se voltea.
1 hmiSymbolLibraryFlipHori‐ El símbolo se voltea horizontalmente.
zontal
2 hmiSymbolLibraryFlipVerti‐ El símbolo se voltea verticalmente.
cal
3 hmiSymbolLibraryFlipBoth El símbolo se voltea horizontal y verticalmente.
Consulte también
FocusColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del borde del foco cuando está resaltado el objeto correspondiente.
Acceso en runtime:
● RT Advanced: Lectura y escritura
● RT Professional: Ningún acceso
Sintaxis
Object.FocusColor[=Color]
Object
● AlarmView
● Button
● GraphicIOField
● RecipeView
● Slider *

VB Scripting
● StatusForce
● Switch
● TrendView
* RT Professional: Acceso de lectura y de escritura
● SymbolicIOField
Color
Opcional. Valor o constante que determina el color para el borde del foco.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
FocusWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde del foco cuando está resaltado el objeto correspondiente.
Acceso en runtime:

VB Scripting
Sintaxis
Object.FocusWidth[=Int32]
Object
● AlarmView
● Button
● GraphicIOField
● RecipeView
● Slider *
● StatusForce
● Switch
● TrendView
* RT Professional: Acceso de lectura y de escritura
● SymbolicIOField
Int32
Opcional. Un valor o una constante que determina el ancho del borde en píxeles. Rango de
valores de 1 a 10.
Consulte también
Font (RT Professional)
Descripción
Define la fuente.

VB Scripting
El objeto Font tiene las subpropiedades

● Size (tamaño de fuente)
● Bold (negrita Sí/No)
● Name (tipo de fuente)
● Italic (cursiva Sí/No)
● Underline (subrayado Sí/No)
● StrikeThrough (tachado Sí/No)
Si se asignan directamente dos propiedades de Font, se aceptará únicamente la propiedad
default "Name".
Acceso en runtime:
Sintaxis
Object.Font.[Size|Bold|Name|Italic|Underline|StrikeThrough][=Value]
Object
● AlarmControl
● Bar
● Clock
● Slider
Con las características siguientes no se tiene acceso en runtime:
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup

VB Scripting
● RangeLabelView
● RecipeView
● RoundButton
● SmartClientView
● Switch
● SymbolicIOField
● TextField
● TrendView
● ZoneLabelView
Value
Opcional. Valor o constante que determina la subpropiedad indicada.
Ejemplo
'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
Consulte también
Clock (Página 290)
Bar (Página 261)

VB Scripting

ProtectedAreaNameView (Página 391)
RangeLabelView (Página 392)
ZoneLabelView (Página 496)
FontBold (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el texto se mostrará en negrita.
Sintaxis
Object.FontBold[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField

VB Scripting
*: Solo acceso de lectura.
BOOLEAN
Opcional. TRUE si el texto se muestra en negrita.
FontItalic (RT Professional)
Descripción
Define si el texto se muestra en cursiva.
Sintaxis
Object.FontItalic[=BOOLEAN]
Object
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
BOOLEAN
Opcional. TRUE si el texto se muestra en cursiva.
Consulte también

VB Scripting

FontName (RT Professional)
Descripción
Define la fuente.
Sintaxis
Object.FontName[=STRING]
Object
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● OptionGroup
● RoundButton
● TextField

● MultiLineEdit
STRING

VB Scripting
Consulte también
Bar (Página 261)
FontSize (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el tamaño de fuente del texto.
Sintaxis
Object.FontSize[=Int32]
Object
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
*: Solo acceso de lectura.

VB Scripting
Int32
Opcional. Valor o constante que define el tamaño de fuente del texto.
FontUnderline (RT Professional)
Descripción
Define si el texto se muestra subrayado.
Sintaxis
Object.FontUnderline[=BOOLEAN]
Object
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● TextField
BOOLEAN
Opcional. TRUE si el texto se muestra subrayado.
ForeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fuente del texto.
Sintaxis
Object.ForeColor[=Color]

VB Scripting
Object
● Bar
● Button
● CheckBox **
● ComboBox **
● DateTimeField *
● IOField
● ListBox **
● MultiLineEdit **
● OptionGroup **
● RecipeView *
● RoundButton ***
● Slider
● Switch *
● SymbolLibrary
● SymbolicIOField ****
● TextField
* RT Professional: Ningún acceso
** RT Advanced: Ningún acceso
*** RT Advanced: Ningún acceso; RT Professional: Solo acceso de lectura
**** RT Professional: Solo acceso de lectura
● AlarmView
Color
Opcional. Valor o constante que define el color de fuente del texto.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
Bar (Página 261)
ForeColorTransparency (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Format (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FormatPattern (RT Professional)
Descripción
Determina el formato del valor de salida.

VB Scripting
Sintaxis
Object.FormatPattern[=STRING]
Object
● IOField
STRING
Opcional. Un valor o una constante que determina el formato del valor de salida.
Consulte también
FrameColor (RT Professional)
Descripción
Determina el color de fondo del indicador gauge.
Ajuste además "Gráfico de fondo" a "Ninguno".
Acceso en runtime:
Sintaxis
Object.FrameColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color de fondo del indicador gauge.
Observaciones
siguiente:
RGB (255, 0, 0)

VB Scripting
vbGreen.
Free (RT Professional)
Descripción
FreePercent (RT Professional)
Descripción
Devuelve en porcentaje los valores medidos de la memoria libre. Los valores pueden
consultarse en runtime. Los valores no pueden predefinirse.
Sintaxis
Object.FreePercent[=Int32]
Object
● DiscSpaceView
Int32
Opcional. Un valor o una constante que devuelve en porcentaje los valores medidos de la
memoria libre.
Consulte también
1.5.5.6 Propiedades G-H (Panels, Comfort Panels, RT Advanced, RT Professional)
Gradation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la diferencia de valor entre dos marcas principales del objeto "Gauge".

VB Scripting
Sintaxis
Object.Gradation[=SINGLE]
Object
● Gauge
SINGLE
Opcional. Valor o constante que determina la diferencia de valor.
Consulte también
Gauge (Página 324)
GraphDirection (RT Professional)
Descripción
Define el borde de la ventana de curvas en el que se mostrarán los valores actuales.
Sintaxis
Object.GraphDirection[=GraphDirection]
Object
GraphDirection
Opcional. Valor o constante que define el borde de la ventana de curvas en que se
mostraránlos valores actuales.
Valor Explicación
0 Los valores positivos serán desplazados hacia la derecha y hacia arriba.
-1 Los valores positivos serán desplazados hacia la izquierda y hacia arriba.
-2 Los valores positivos serán desplazados hacia la derecha y hacia arriba.
-3 Los valores positivos serán desplazados hacia la derecha y hacia abajo.
Consulte también

VB Scripting
GridlineAxis (RT Advanced)
Descripción
GridLineColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el color de las líneas de cuadrícula.
Acceso en runtime:
Lectura y escritura
Sintaxis
Object.GridLineColor[=Color]
Object
● AlarmControl
● AlarmView *
* RT Advanced: Acceso de lectura y de escritura; RT Professional: Ningún acceso

● TrendView
Color
Opcional. Valor o constante que establece el color de las líneas de cuadrícula.
Observaciones
siguiente:
RGB (255, 0, 0)

VB Scripting
vbGreen.
Consulte también
GridlineEnabled (RT Advanced)
Descripción
GridlineFillColor (RT Advanced)
Descripción
GridlineStyle (RT Advanced)
Descripción
GridLineWidth (RT Professional)
Descripción
Define en píxeles el grosor de la línea de separación.
Sintaxis
Object.GridLineWidth[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el grosor de la línea de separación.
Consulte también
GSCRuntimeAllowed (RT Professional)
Descripción
HeaderFont (RT Advanced)
Descripción
Height (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la altura.
Acceso en runtime: Lectura y escritura.
Sintaxis
Object.Height[=Int32]

VB Scripting
Object
Necesario. Objeto del tipo "ScreenItem". Esta es una propiedad estándar del objeto
ScreenItem, por lo que está disponible en todas las apariencias.
En "Runtime Advanced" y "Panel Runtime", en las siguientes apariencias no se tiene acceso:
● AlarmView
● Bar
● BatteryView
● Button
● CameraControl
● Clock
● DateTimeField
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● MediaPlayer
● PDFView
● PLCCodeViewer
● Polygon
● Polyline
● ProDiagOverview
● RangeLabelView
● RangeQualityView
● RecipeView
● S7GraphOverview
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolicIOField
● SymbolLibrary

VB Scripting
● SysDiagControl
● TextField
● TrendView
● UserView
● WLanQualityView
● ZoneLabelView
● ZoneQualityView
Int32
Opcional. Valor o constante que determina la altura en píxeles.
Ejemplo
El siguiente ejemplo divide por la mitad la altura de todos los objetos de la imagen "NewPDL1",
cuyo nombre empieza con "Circle":
'VBS75
Dim objScreen
Dim objCircle
Dim lngIndex
Dim strName
lngIndex = 1
For lngIndex = 1 To objScreen.ScreenItems.Count
'
'Searching all circles
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
If "Circle" = Left(strName, 6) Then
'
'to halve the height of the circles
Set objCircle = objScreen.ScreenItems(strName)
objCircle.Height = objCircle.Height / 2
End If
Next
Consulte también
Line (Página 341)

VB Scripting

Bar (Página 261)
Clock (Página 290)
Gauge (Página 324)
ScriptDiagnostics (Página 413)

VB Scripting

BatteryView (Página 268)
ZoneQualityView (Página 498)
WLanQualityView (Página 495)
RangeQualityView (Página 394)
HelpText (Panels, Comfort Panels, RT Advanced)
Descripción
Indica el tooltip que se visualiza en runtime como ayuda de manejo del objeto indicado.
Sintaxis
Object.HelpText[=STRING]
Object
● Button
● DateTimeField
● GraphicIOField

VB Scripting
● IOField
● Switch
● SymbolicIOField
● TrendView
STRING
Opcional. Valor o constante que indica el contenido del tooltip que se visualiza en runtime
como ayuda de manejo del objeto indicado.
Consulte también
HiddenInput (RT Professional)
Descripción
Determina si se muestra el valor al realizar la entrada o bien un * para cada carácter.
Sintaxis
Object.HiddenInput[=BOOLEAN]
Object
● IOField
BOOLEAN
Opcional. TRUE si el valor no se muestra al realizar la entrada. Para cada carácter se muestra
un *.
Consulte también

VB Scripting
HighlightColor (RT Professional)
Descripción
Define el color de selección en la vista general de GRAPH.
Sintaxis
Object.HighlightColor[=Color]
Object
● S7GraphOverview
Color
Opcional. Valor o constante que define el color de selección.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
HighLimitColor (RT Professional)
Descripción
Determina el color del botón superior o derecho para desplazarse por una barra de
desplazamiento.
Sintaxis
Object.HighLimitColor[=Color]

VB Scripting
Object
● WindowSlider
Color
Opcional. Un valor o una constante que determina el color del botón superior o derecho para
desplazarse por una barra de desplazamiento.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Hitlist (RT Professional)
Descripción
HitlistColumnAdd (RT Professional)
Descripción
Crea un bloque de aviso nuevo de la estadística de avisos. El bloque de aviso recién creado
se referencia automáticamente mediante "HitlistColumnIndex".
Sintaxis
Object.HitlistColumnAdd[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Necesario. Valor o constante que determina el nombre del nuevo bloque de aviso de la
estadística de avisos mediante "HitlistColumnName".
Consulte también
HitlistColumnIndex (Página 740)
HitlistColumnCount (RT Professional)
Descripción
Define el número de bloques de aviso configurados en la estadística de avisos.
Sintaxis
Object.HitlistColumnCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de bloques de aviso configurados en la
estadística de avisos.
Consulte también
HitlistColumnIndex (RT Professional)
Descripción
Hace referencia a uno de los bloques de aviso seleccionados para la estadística de avisos.
Para acceder a las propiedades de un bloque de aviso, es necesario activar
"HitlistColumnIndex".
Los valores válidos para "HitlistColumnIndex" se encuentran entre 0 y "HitlistColumnCount"
menos 1. La propiedad "HitlistColumnCount" indica el número de bloques de aviso
configurados.

VB Scripting
Sintaxis
Object.HitlistColumnIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define a través del índice el bloque de aviso que se editará.
Consulte también
HitlistColumnCount (Página 738)
HitlistColumnName (RT Professional)
Descripción
Define el nombre de un bloque de aviso de la estadística de avisos referenciado mediante
"HitlistColumnIndex". No se puede modificar el nombre.
Sintaxis
Object.HitlistColumnName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el nombre del bloque de aviso referenciado de la
Consulte también

VB Scripting
HitlistColumnRemove (RT Professional)
Descripción
Borra un bloque de aviso de la estadística de avisos referenciado mediante su nombre.
Sintaxis
Object.HitlistColumnRemove[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del bloque de aviso referenciado de la
estadística de avisos que se borrará.
Consulte también
HitlistColumnRepos (RT Professional)
Descripción
Define la posición de un bloque de aviso referenciado mediante "HitlistColumnIndex" en la
Si ha modificado la posición del bloque de aviso con "HitlistColumnRepos", a
"HitlistColumnIndex" se le asignará el valor de "HitlistColumnRepos".
Sintaxis
Object.HitlistColumnRepos[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define la posición del bloque de aviso referenciado en la
estadística de avisos. Rango de valores de 0 a "HitlistColumnCount" menos 1. Los valores
fuera de este rango de valores no tienen ningún efecto.

VB Scripting
0: El bloque de aviso referenciado se posiciona a la izquierda.
Consulte también
HitlistColumnCount (Página 738)
HitlistColumnSort (RT Professional)
Descripción
Establece cómo se clasificará en la lista de aciertos el bloque de aviso referenciado en
"HitlistColumnIndex".
Sintaxis
Object.HitlistColumnSort[=SortMode]
Object
● AlarmControl
SortMode
Opcional. Valor o constante que define qué datos de runtime del control se exportarán.
Valor Explicación
Consulte también
HitlistColumnSortIndex (RT Professional)
Descripción
Define la secuencia de clasificación del bloque de aviso de la estadística de avisos
referenciado mediante "HitlistColumnIndex".
Si ajusta el valor a "0", el criterio de clasificación se eliminará de "HitlistColumnSort".

VB Scripting
Sintaxis
Object.HitlistColumnSortIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Define la secuencia de clasificación del bloque de aviso referenciado de la
Consulte también
HitlistColumnVisible (RT Professional)
Descripción
Define si el bloque de aviso referenciado mediante "HitlistColumnIndex" se mostrará en la
Sintaxis
Object.HitlistColumnVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el bloque de aviso referenciado se mostrará en la estadística de avisos.
FALSE si el bloque de aviso referenciado no se muestra en la estadística de avisos.
Consulte también

VB Scripting
HitlistDefaultSort (RT Professional)
Descripción
Define la clasificación predeterminada en las columnas de la tabla de la estadística de avisos.
Sintaxis
Object.HitlistDefaultSort[=SortMode]
Object
● AlarmControl
SortMode
Opcional. Valor o constante que define la clasificación predeterminada de las columnas de la
tabla de la estadística de avisos.
Valor Explicación
0 La lista se clasifica en orden ascendente de la frecuencia.
1 La lista se clasifica en orden descendente de la frecuencia.
Consulte también
HitlistFilter (RT Professional)
Descripción
HitlistMaxSourceItems (RT Professional)
Descripción
Define el número máximo de registros del fichero de avisos que se utilizan para crear la
estadística de avisos. El valor puede elegirse libremente entre "0 - 10000".
Sintaxis
Object.HitlistMaxSourceItems[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número máximo de registros del fichero de avisos
que se usarán para crear la estadística de avisos.
Consulte también
HitlistMaxSourceItemsWarn (RT Professional)
Descripción
Define que se emita una advertencia cuando se alcance el número máximo de registros en
el visor de avisos.
Sintaxis
Object.HitlistMaxSourceItemsWarn[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE si se emite un aviso cuando se alcance el número máximo de registros en el visor de
avisos.
FALSE si no se emite ningún aviso cuando se alcance el número máximo de registros en el
visor de avisos.
Consulte también
HitListRelTime (RT Professional)
Descripción
Define si el periodo de cálculo de la estadística de avisos posee una limitación temporal.

VB Scripting
Sintaxis
Object.HitListRelTime [=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE si se utiliza el rango de tiempo indicado para la estadística.
FALSE si no se utiliza el rango de tiempo indicado.
Consulte también
HitListRelTimeFactor (RT Professional)
Descripción
Define el factor de tiempo (con el tipo de tiempo "HitlistRelTimeFactorType (Página 748)") que
determina el periodo para crear la estadística de avisos.
Sintaxis
Object.HitListRelTimeFactor[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el factor de tiempo.
Consulte también

VB Scripting
HitlistRelTimeFactorType (RT Professional)
Descripción
Define la unidad de tiempo (con el factor de tiempo "HitlistRelTimeFactor") que determina el
rango de tiempo para el que se visualiza la estadística de avisos.
Sintaxis
Object.HitListRelTimeFactorType[=AlarmControlTimeUnit)
Object
● AlarmControl
AlarmControlTimeUnit
Opcional. Valor o constante que determina la unidad de tiempo.
Valor Nombre
0 Minuto
1 Hora
2 Día
3 Semana
4 Mes
Consulte también
HomeButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
HorizontalAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la alineación horizontal del texto.

VB Scripting
Sintaxis
Object.HorizontalAlignment[=HorizontalAlignment]
Object
● Button
● CheckBox *
● ComboBox *
● IOField
● ListBox *
● MultiLineEdit *
● OptionGroup *
● RoundButton ***
● Switch **
● SymbolicIOField ****
● TextField
*** RT Advanced: Ningún acceso; RT Professional: Solo acceso de lectura
**** RT Professional: Solo acceso de lectura
HorizontalAlignment
Opcional. Valor o constante que determina la orientación horizontal del texto.

0 hmiAlignmentLeft El texto se justifica a la izquierda en el objeto.
1 hmiAlignmentCentered El texto se centra horizontalmente en el objeto.
2 hmiAlignmentRight El texto se justifica a la derecha en el objeto.
Consulte también

VB Scripting

HorizontalGridLines (RT Professional)
Descripción
Define si se deben visualizar líneas horizontales.
Sintaxis
Object.HorizontalGridLines[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualizan líneas de separación horizontales.
FALSE si no se visualizan líneas de separación horizontales.
Consulte también
HorizontalPictureAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
HorizontalScrollBarPosition (RT Professional)
Descripción
Define la posición del deslizador en la barra de desplazamiento horizontal. La imagen se
representa desplazando horizontalmente el deslizador de la barra de desplazamiento.
Para visualizar la imagen recortada, con barras de desplazamiento en el borde izquierdo y
superior de la imagen, utilice las propiedades "LeftOffset (Página 787)" y "TopOffset
(Página 1102)" para el origen de la sección.
Sintaxis
Object.HorizontalScrollBarPosition[=Int32]
Object
● ScreenWindow
Int32
Opcional. Valor o constante que determina la posición horizontal del deslizador en la barra de
desplazamiento.
Consulte también
HorizontalScrollingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Hotkey (RT Professional)
Descripción
HourNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la longitud de la aguja horaria.

VB Scripting
Sintaxis
Object.HourNeedleHeight[=Int32]
Object
● Clock
Int32
Opcional. Valor o constante que determina la longitud de la aguja horaria.
Indique la longitud de la aguja horaria en tantos por ciento, referidos al radio de la esfera.
Consulte también
Clock (Página 290)
HourNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el ancho de la aguja horaria.
Sintaxis
Object.HourNeedleWidth[=Int32]
Object
● Clock
Int32
Opcional. Valor o constante que determina el ancho de la aguja horaria.
Indique el ancho en tantos por ciento, referidos a la longitud doble de la aguja horaria.
Consulte también
Clock (Página 290)

VB Scripting
1.5.5.7 Propiedades I-J (Panels, Comfort Panels, RT Advanced, RT Professional)
IconSpace (RT Professional)
Descripción
Establece la distancia entre símbolo y texto en las celdas de la tabla. El valor será efectivo
cuando se muestren símbolos y texto.
Sintaxis
Object.IconSpace[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor que establece la distancia.
Consulte también
Index (RT Professional)
Descripción
Determina el índice del campo de texto seleccionado.
Sintaxis
Object.Index[=Int32]

VB Scripting
Object
● CheckBox
● ComboBox
● ListBox
● OptionGroup
Int32
Opcional. Un valor o una constante que determina el índice del campo de texto seleccionado.
Consulte también
IndipendentWindow (RT Professional)
Descripción
InfoArea_BackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_ColumnsMovable (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_DefaultTextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
InfoArea_ErrorTextBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_ErrorTextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_FocusFrameColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_FocusFrameWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_Font (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_RootNodeText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_SelectionBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
InfoArea_SelectionForegroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_ShowGridLines (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_TableHeaderBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InfoArea_TableHeaderTextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InnerBackColorOff (RT Advanced)
Descripción
Define el color debajo del deslizador del objeto "Switch" cuando el objeto está en estado OFF.
Sintaxis
Object.InnerBackColorOff[=Color]
Object
● Switch
Color
Opcional. Valor o constante que determina el color del estado OFF.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
InnerBackColorOn (RT Advanced)
Descripción
Define el color debajo del deslizador del objeto "Switch" cuando el objeto está en estado ON.
Sintaxis
Object.InnerBackColorOn[=Color]
Object
● Switch
Color
Opcional. Valor o constante que determina el color del estado ON.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
InnerDialColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InnerDialInnerDistance (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InnerDialOuterDistance (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InnerHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define ###
Acceso en runtime:
Sintaxis
Object.InnerHeight[=Int32]
Object
● Button
● IOField
● RoundButton*
Int32

VB Scripting
InnerWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define ###
Sintaxis
Object.InnerWidth[=Int32]
Object
● Button
● RoundButton*
Int32
InputAddressText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InputValue (RT Professional)
Descripción
Define el valor de entrada. El valor no se muestra en el objeto al activar la propiedad.
Para que el valor introducido se muestre en el objeto debe configurarse la función de sistema
"DefinirPropiedadVíaPropiedad" en el evento "Objeto modificado":
Parámetros relevantes Valor

Nombre de la propiedad Valor de proceso
de destino
Nombre de la propiedad Valor de entrada
Esta función de sistema resulta útil si no hay ninguna conexión de variable configurada en el
valor de salida y, pese a ello, el usuario solicita el valor introducido, p. ej., mediante un script.

VB Scripting
Sintaxis
Object.InputValue[=Int32]
Object
● IOField
Int32
Opcional. Valor o constante que establece el valor de entrada.
InspectorViewInternalColumnOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
InspectorViewRowOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Instance (RT Professional)
Descripción
Devuelve una instancia del objeto Alarm.
IntegerDigits (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el número de dígitos a la izquierda de la coma (de 0 a 20).
Sintaxis
Object.IntegerDigits[=Int32]

VB Scripting
Object
● Bar
Int32
Opcional. Un valor o una constante que determina el número de dígitos a la izquierda de la
coma (de 0 a 20).
Consulte también
Bar (Página 261)
Interval (RT Professional)
Descripción
Determina los intervalos de tiempo para la actualización de los valores medidos mostrados.
El valor se indica en minutos.
Sintaxis
Object.Interval[=Int32]
Object
● DiscSpaceView
Int32
Opcional. Un valor o una constante que determina los intervalos de tiempo para la
actualización de los valores medidos mostrados.
Consulte también
IsActive (RT Professional)
Descripción

VB Scripting
IsImageMiddleAligned (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IsMinPasswordValueSet (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IsRunningUnderCE (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IsVerticalScrollBarEnabled (RT Advanced)
Descripción
ItemBorderStyle (RT Professional)
Descripción
Define el tipo de línea de las líneas de separación en la lista de selección.
Sintaxis
Object.ItemBorderStyle[=Int32]
Object
● SymbolicIOField

VB Scripting
Int32
Opcional. Valor o constante que define el tipo de línea de las líneas de separación en la lista
de selección.

-1 hmiLineStyleNone La lista de selección no tiene líneas de separación.
0 hmiLineStyleSolid La lista de selección tiene líneas de separación continuas.
1 hmiLineStyleDash La lista de selección tiene líneas de separación discontinuas.
2 hmiLineStyleDot La lista de selección tiene líneas de separación punteadas.
3 hmiLineStyleDashDot La lista de selección tiene líneas de separación punto raya.
4 hmiLineStyleDashDotDot La lista de selección tiene líneas de separación punto punto raya.
Consulte también
ItemText_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_ErrorText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_HardwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ItemText_IMDataVersion (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_ManufacturerID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ItemText_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_RevisionCounter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_SerialNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ItemText_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ItemText_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
IV_ShowItem_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_ErrorText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_HardwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_IMDataVersion (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
IV_ShowItem_ManufacturerID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
IV_ShowItem_RevisionCounter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_SerialNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
IV_ShowItem_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
IV_ShowItem_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
JumpToLimitsAfterMouseClick (RT Professional)
Descripción
Determina si el deslizador se coloca en el valor final correspondiente. El valor final es el valor
mínimo o máximo. Para colocar el deslizador sobre el valor final, el usuario hace clic en el
área situada fuera del actual ajuste del regulador.
Sintaxis
Object.JumpToLimitsAfterMouseClick[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las características:
● WindowSlider
BOOLEAN
Opcional. TRUE si el deslizador se coloca en el valor final correspondiente.

VB Scripting
Consulte también
1.5.5.8 Propiedades K-L (Panels, Comfort Panels, RT Advanced, RT Professional)
KeyboardOnline (RT Advanced)
Descripción
LabelColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de rotulación de la escala.
Sintaxis
Object.LabelColor[=Color]
Object
● Slider
Color
Opcional. Valor o constante que determina el color de rotulación de la escala.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
Language (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el idioma actual de runtime.
Sintaxis
Object.Language[= LONG]
Object
LONG
Opcional. Valor o constante que contiene el código de país.
Observaciones
En VBS, el idioma de runtime se indica con un código de país, p. ej. 1031 para alemán, 2057
para inglés, etc. Encontrará una relación de todos los códigos de país en los principios básicos
de VBScript, en el tema "Cuadro de Id. de configuración regional (LCID)".
Consulte también
LargeTickLabelingStep (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve el intervalo en que se rotulan secciones de la escala.
Sintaxis
Object.LargeTickLabelingStep[=Int32]
Object
● Bar
Int32
Opcional. Valor o constante que devuelve el intervalo en que se rotulan secciones de la escala.

VB Scripting
Consulte también
Bar (Página 261)
LargeTicksBold (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si las marcas largas de una escala se muestran en negrita.
Sintaxis
Object.LargeTicksBold[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE, si las marcas largas de una escala se muestran en negrita.
Consulte también
Bar (Página 261)
LargeTicksSize (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la longitud de las marcas largas de una escala.
Sintaxis
Object.LargeTicksSize[=Int32]
Object
● Bar
Int32
Opcional. Un valor o una constante que determina la longitud de las marcas largas de una
escala.

VB Scripting
Consulte también
Bar (Página 261)
LastConnectedObject (RT Professional)
Descripción
LastConnectedObjectIndex (RT Professional)
Descripción
Define el número de índice del punto de conexión al último objeto conectado.
Sintaxis
Object.LastConnectedObjectIndex[=Int]
Object
● Connector
Int
Opcional. Valor o constante que determina el número de índice del punto de conexión al último
objeto conectado.
Consulte también
LastConnectedObjectName (RT Professional)
Descripción
Define el nombre del objeto que está acoplado en el punto de conector inferior.
Sintaxis
Object.LastConnectedObjectName[=String]

VB Scripting
Object
● Connector
String
Opcional. Valor o constante que define el nombre del objeto que está acoplado al punto de
conexión inferior.
Consulte también
LastError (RT Professional)
Descripción
Devuelve un código de error acerca del éxito de la última operación, p. ej. información acerca
del proceso de escribir o leer una variable:
Código en modo de escritura hexadecimal Descripción

0x00000000 Aceptar
0x80040001 Error de ejecución
0x80040002 Error de variable
0x80040003 Servidor no disponible
0x80040004 Multi Tag Error; error en una o varias variables
Para obtener una descripción del error debe ejecutarse primero el método Read.
Nota
Si el error se produce al acceder a través del objeto TagSet, evalúe la propiedad LastError
para cada variable del objeto TagSet.
Para obtener una indicación sobre la calidad del valor proporcionado, utilice la propiedad
"QualityCode". Para obtener una descripción del error, utilice la propiedad "ErrorDescription".
Sintaxis
Object.LastError
Object

VB Scripting
Ejemplo
El siguiente ejemplo muestra el código de error para la variable "Tag1":
'VBS77
Dim objTag
objTag.Read
MsgBox objTag.LastError
El siguiente ejemplo agrega a la lista TagSet dos variables y presenta la propiedad LastError
como Trace:
'VBS178
Dim group
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "LastError: " & group.LastError & vbNewLine
Se puede acceder a la propiedad LastError de una variable contenida en la lista del siguiente
modo:
HMIRuntime.Trace "LastError: " & group("Motor1").LastError & vbNewLine
Consulte también
Tag (Página 230)
TagSet (lista) (Página 234)
Layer (RT Advanced, RT Professional)
Descripción
Dentro de la imagen, devuelve el nivel en el que se encuentra un objeto. En total hay 32 niveles
disponibles, siendo el nivel "0" el nivel inferior, y el nivel "31" el nivel superior.
Dentro de un nivel, los objetos que han sido proyectados primero estarán en el fondo.
Sintaxis
Object.Layer[=Int32]

VB Scripting
Object
● AlarmControl *
● AlarmView **
● ApplicationWindow *
● Bar
● BatteryView ***
● Button
● CameraControl ***
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● Clock
● ComboBox *
● Connector *
● DiscSpaceView *
● Ellipse
● EllipticalArc *
● FunctionTrendControl **
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox *
● MediaPlayer
● MultiLineEdit *
● OptionGroup *
● Polygon

VB Scripting
● Polyline
● ProDiagOverview ****
● ProtectedAreaNameView ***
● RangeLabelView ***
● RangeQualityView ***
● RecipeView **
● Rectangle
● RoundButton *****
● S7GraphOverview
● ScreenWindow *
● Slider
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField ******
● SysDiagControl *******
● TextField
● TrendView **
● TubeArcObject *
● TubeTeeObject *
● Tubepolyline *
● UserView
● WLanQualityView ***
● WindowSlider *
● ZoneLabelView ***
● ZoneQualityView ***
*** Solo Panel RT: Acceso de lectura y de escritura
**** RT Advanced: Acceso de lectura; RT Professional: Acceso de lectura y de escritura
***** RT Advanced: Ningún acceso; RT Professional: Acceso de lectura
****** RT Advanced: Acceso de lectura y de escritura; RT Professional: Acceso de lectura

VB Scripting
****** Solo acceso de lectura

Int32
Opcional. Valor o constante que devuelve el nivel de la imagen en el que se encuentra un
objeto.
Observaciones
Nota
La propiedad Layer indica el nivel en el que se encuentra el objeto. El nivel "0" se muestra
como nivel "0".
Durante el acceso, las capas son enumeradas en VBS del 1 hacia arriba. Por tanto, acceda
al nivel "1" con layers(2).
Ejemplo
El siguiente ejemplo indica el nombre y el nivel de todos los objetos de la imagen "NewPDL1":
'VBS78
Dim objScreen
Dim objScrItem
Dim lngAnswer
Dim lngIndex
Dim strName
lngIndex = 1
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
lngAnswer = MsgBox(strName & " is in layer " & objScrItem.Layer,vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
Consulte también

VB Scripting
Bar (Página 261)

CameraControl (Página 275)
Clock (Página 290)
Gauge (Página 324)
Line (Página 341)

VB Scripting

LayerDeclutteringEnable (RT Professional)
Descripción
Indica si los niveles de una imagen se muestran o se ocultan en función de un zoom mínimo
o máximo configurado.

VB Scripting
Sintaxis
Object.LayerDeclutteringEnable
Object
Ejemplo:
El ejemplo muestra la propiedad LayerDecluttering de la imagen "NewPDL1" como Trace.
'VBS156
Dim objScreen
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
Consulte también
Layers (RT Professional)
Descripción
Devuelve un objeto del tipo "Layers".
Sintaxis
Object.Layers
Object
Consulte también
Left (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el valor de la coordenada X.

VB Scripting
Sintaxis
Object.Left[=Int32]
Object
● AlarmControl *
● AlarmView **
● ApplicationWindow *
● Bar
● BatteryView ***
● Button
● CheckBox *
● Circle
● CircleSegment *
● CircularArc *
● Clock
● ComboBox *
● Connector *
● DiscSpaceView *
● Ellipse
● EllipticalArc *
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox *
● MediaPlayer
● MultiLineEdit *
● OnlineTableControl *
● OnlineTrendControl *

VB Scripting
● OptionGroup *
● Polygon
● Polyline
● ProDiagOverview ***
● ProtectedAreaNameView ***
● RangeLabelView ***
● RangeQualityView ***
● RecipeView**
● Rectangle
● RoundButton *****
● S7GraphOverview **
● ScreenWindow *
● Slider
● StatusForce **
● Switch **
● SymbolLibrary
● SymbolicIOField ******
● SysDiagControl *******
● TextField
● TrendView **
● TubeArcObject *
● TubeTeeObject *
● Tubepolyline *
● UserArchiveControl *
● UserView
● WLanQualityView ***
● WindowSlider *
● ZoneLabelView ***
● ZoneQualityView ***

VB Scripting
*** Solo Panel RT: Acceso de lectura y de escritura

**** RT Advanced: Acceso de lectura; RT Professional: Acceso de lectura y de escritura
***** RT Advanced: Ningún acceso; RT Professional: Acceso de lectura
****** RT Advanced: Acceso de lectura y de escritura; RT Professional: Acceso de lectura
Int32
Opcional. Valor o constante que contiene el valor de la coordenada X en píxeles (medido
desde el borde superior izquierdo de la imagen).
Observaciones
La coordenada X hace referencia al ángulo superior izquierdo del recuadro que rodea al objeto.
En runtime se vigilan también los límites de la imagen. Si el valor de coordenada asignado
excede el tamaño de la pantalla, el script de usuario se cancelará con un mensaje de error.
Consulte también
Bar (Página 261)
BorderWidth (Página 587)
CameraControl (Página 275)
Clock (Página 290)

VB Scripting
Gauge (Página 324)

Line (Página 341)

VB Scripting

LeftMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
LeftOffset (RT Professional)
Descripción
Determina el desplazamiento horizontal del punto cero de la visualización de una imagen que
es más grande que la ventana de imagen. El desplazamiento está referido al borde izquierdo
de la ventana de imagen.
La imagen se muestra recortada. Las barras de desplazamiento de la imagen están ubicadas
en el borde izquierdo y borde superior de la imagen.
Si desea representar la imagen en la ventana de imagen con el desplazamiento horizontal y
vertical de las barras de desplazamiento de la imagen, utilice para el desplazamiento las
propiedades "HorizontalScrollBarPosition (Página 749)" y "VerticalScrollBarPosition
(Página 1219)".
Sintaxis
Object.LeftOffset[=Int32]
Object
● Screenwindow
Int32
Opcional. Valor o constante que determina el desplazamiento horizontal del punto cero de la
visualización de la imagen desde el borde izquierdo de la ventana de imagen.

VB Scripting
Consulte también
Limit4LowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el valor límite inferior para "Reserve4".
La propiedad "Limit4LowerLimitEnabled" debe haberse puesto a TRUE para que pueda
vigilarse el valor límite "Reserve4".
Sintaxis
Object.Limit4LowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite inferior para "Reserve4".
Observaciones
La propiedad "Limit4LowerLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Consulte también
Bar (Página 261)
Limit4LowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color para el valor límite inferior "Reserve4".
La propiedad "Limit4LowerLimitEnabled" debe tener el valor TRUE si el color de la barra debe
Sintaxis
Object.Limit4LowerLimitColor[=Color]

VB Scripting
Object
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite inferior
"Reserve4".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
Limit4LowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite inferior "Reserve4".
Sintaxis
Object.Limit4LowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite inferior "Reserve4".

VB Scripting
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit4LowerLimit",
"Limit4LowerLimitColor" y "Limit4LowerLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)
Limit4LowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el valor límite inferior "Reserve4" se evaluará en porcentaje o de forma absoluta.
Sintaxis
Object.Limit4LowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE si se evalúa el valor límite inferior "Reserve4" en porcentaje.
FALSE si se evalúa el valor límite inferior "Reserve4" de forma absoluta.
Consulte también
Bar (Página 261)
Limit4UpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el valor límite superior para "Reserve4".
La propiedad "Limit4UpperLimitEnabled" debe haberse puesto a TRUE para que pueda

VB Scripting
Sintaxis
Object.Limit4UpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite superior para "Reserve4".
Observaciones
La propiedad "Limit4UpperLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Consulte también
Bar (Página 261)
Limit4UpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color para el valor límite superior "Reserve4".
La propiedad "Limit4UpperLimitEnabled"" debe tener el valor TRUE si el color de la barra debe
Sintaxis
Object.Limit4UpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite superior
"Reserve4".

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
Limit4UpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite superior "Reserve4".
Sintaxis
Object.Limit4UpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior "Reserve4".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit4UpperLimit",
"Limit4UpperLimitColor" y "Limit4UpperLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)

VB Scripting
Limit4UpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el valor límite superior "Reserve4" se evaluará en porcentaje o de forma absoluta.
Sintaxis
Object.Limit4UpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
Consulte también
Bar (Página 261)
Limit5LowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el valor límite inferior para "Reserve5".
La propiedad "Limit5LowerLimitEnabled" debe haberse puesto a TRUE para que pueda
Sintaxis
Object.Limit5LowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite inferior para "Reserve5".

VB Scripting
Observaciones
La propiedad "Limit5LowerLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Consulte también
Bar (Página 261)
Limit5LowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color para el valor límite inferior "Reserve5".
La propiedad "Limit5LowerLimitEnabled" debe tener el valor TRUE si el color de la barra debe
Sintaxis
Object.Limit5LowerLimitColor[=Color]
Object
● Bar
Color
"Reserve5".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)

VB Scripting
Limit5LowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite inferior "Reserve5".
Sintaxis
Object.Limit5LowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite inferior "Reserve5".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit5LowerLimit",
"Limit5LowerLimitColor" y "Limit5LowerLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)
Limit5LowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el valor límite inferior "Reserve5" se evalúa en porcentaje o de forma absoluta.
Sintaxis
Object.Limit5LowerLimitRelative[=BOOLEAN]
Object
● Bar

VB Scripting
BOOLEAN
Opcional.
Consulte también
Bar (Página 261)
Limit5UpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el valor límite superior para "Reserve5".
La propiedad "Limit5UpperLimitEnabled" debe haberse puesto a TRUE para que pueda
Sintaxis
Object.Limit5UpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite superior para "Reserve5".
Observaciones
La propiedad "TypeLimitHigh5" determina si el objeto se evalúa de forma porcentual o
absoluta.
Consulte también
Bar (Página 261)
Limit5UpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color para el valor límite superior "Reserve5".

VB Scripting
La propiedad "Limit5UpperLimitEnabled" debe tener el valor TRUE si el color de la barra debe

Sintaxis
Object.Limit5UpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Un valor o una constante que define el color del valor límite superior "Reserve5".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
Limit5UpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite superior "Reserve5".
Sintaxis
Object.Limit5UpperLimitEnabled[=BOOLEAN]
Object
● Bar

VB Scripting
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior "Reserve5".
Consulte también
Bar (Página 261)
Limit5UpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el valor límite superior "Reserve5" se evaluará en porcentaje o de forma absoluta.
Sintaxis
Object.Limit5UpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE si se evalúa el valor límite superior "Reserve5" en porcentaje.
FALSE si se evalúa el valor límite superior "Reserve5" de forma absoluta.
Consulte también
Bar (Página 261)
LimitRangeCollection (RT Professional)
Descripción
LineAlarmView (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
LineBackgroundColor (RT Professional)
Descripción
LineColor (RT Professional)
Descripción
Define el color de las líneas de separación de la ventana.
Sintaxis
Object.LineColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de las líneas de separación de la ventana.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting

LineEndShapeStyle (RT Professional)
Descripción
Define la forma de los finales de línea.
Acceso en runtime:
Sintaxis
Object.LineEndShapeStyle[=LineEndShapeStyle]
Object
Necesario. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup

VB Scripting
● Polygon
● Polyline
● Rectangle
● RoundButton *
● TextField
● WindowSlider
● Switch
● TubeArcObject
LineEndShapeStyle
Opcional. Valor o constante que determina la forma de los finales de línea.
Valor Explicación
0 Redondo
1 Justificado
2 Cuadrado
Consulte también
Bar (Página 261)
Line (Página 341)

VB Scripting

LinesPerDiagEntry (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
LineStyle (RT Professional)
Descripción
LineWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el grosor de línea.
Acceso en runtime:
Sintaxis
Object.LineWidth[=Int32]

VB Scripting
Object
● AlarmControl
● CircularArc
● Connector
● EllipticalArc
● Line *
● Polyline *
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● Polygon
Int32
Opcional. Valor o constante que establece el grosor de la línea en píxeles.
Consulte también
Line (Página 341)

VB Scripting

LineWrap (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ListAreaHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ListAreaLeft (RT Advanced)
Descripción
ListAreaTop (RT Advanced)
Descripción
ListAreaWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
LoadDataImmediately (RT Professional)
Descripción
Determina si los valores de variables para el intervalo de tiempo que se representa se cargan
desde los ficheros al abrir una imagen.

VB Scripting
Sintaxis
Object.LoadDataImmediately[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los valores de variables para el intervalo de tiempo que se representa se
cargan desde los ficheros al abrir una imagen.
Consulte también
LocalCursor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Location (RT Professional)
Descripción
LockSquaredExtent (RT Professional)
Descripción
Determina si el tamaño del reloj puede ajustarse con el ratón.

VB Scripting
Sintaxis
Object.LockSquaredExtent[=BOOLEAN]
Object
● Clock
● Gauge
BOOLEAN
Opcional. TRUE si el tamaño del reloj puede ajustarse en cada proporción de página deseada
arrastrando el ratón en los puntos de selección.
Consulte también
Clock (Página 290)
Gauge (Página 324)
Logging (RT Professional)
Descripción
Devuelve un objeto del tipo "Logging".
Sintaxis
Object.Logging
Object
Obligatorio. Un objeto del tipo "HMIRuntime".
Consulte también
LogOperation (RT Professional)
Descripción
Determina si después de una operación con este objeto se visualiza un aviso en el sistema
de avisos.

VB Scripting
Sintaxis
Object.LogOperation[=BOOLEAN]
Object
● CheckBox
● ComboBox
● IOField
● ListBox
● OptionGroup
● WindowSlider
BOOLEAN
Opcional. TRUE, si después de una operación con este objeto se visualiza un aviso en el
sistema de avisos.
LongDateTimeFormat (RT Advanced)
Descripción
LongTermArchiveConsistency (RT Professional)
Descripción
Determina cómo se mostrarán los avisos en el visor de avisos cuando esté configurada la
visualización "Ficheros de largo plazo".
Sintaxis
Object.LongTermArchiveConsistency[= BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.

VB Scripting
TRUE si se muestran los últimos 1000 avisos en el cliente de todos los servidores o pares de
servidores redundantes en la vista "Ficheros a largo plazo".
FALSE si se muestran 1000 avisos en la vista "Ficheros a largo plazo" en el sistema
monopuesto, en el servidor o en el cliente por cada servidor o par de servidores redundantes.
Consulte también
Look3D (RT Advanced)
Descripción
LowerLimit (RT Professional)
Descripción
Determina el valor límite inferior para valores de entrada.
Sintaxis
Object.LowerLimit[=DOUBLE]
Object
● IOField
DOUBLE
Opcional. Un valor o una constante que determina el valor límite inferior para valores de
entrada.
Consulte también
LowLimitColor (RT Professional)
Descripción
Determina el color del botón inferior o izquierdo para desplazarse por una barra de
desplazamiento.

VB Scripting
Sintaxis
Object.LowLimitColor[=Color]
Object
● WindowSlider
Color
Opcional. Un valor o una constante que determina el color del botón inferior o izquierdo para
desplazarse por una barra de desplazamiento.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
1.5.5.9 Propiedades M-N (Panels, Comfort Panels, RT Advanced, RT Professional)
Machine (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
MachineName (RT Advanced)
Descripción
Determina la ID de red del dispositivo que debe vigilarse.
Introduzca el nombre o el puerto del dispositivo como ID de red.

VB Scripting
Sintaxis
Object.MachineName[=STRING]
Object
● SmartClientView
STRING
Opcional. Valor o constante que contiene la ID de red.
Consulte también
MaintainAspectRatio (RT Professional)
Descripción
MaintainOriginalSize (RT Professional)
Descripción
MarginToBorder (RT Professional)
Descripción
Determina el ancho del borde 3D en píxeles. El valor para el ancho depende del tamaño del
objeto.
Sintaxis
Object.MarginToBorder[=Int32]
Object
● WindowSlider

VB Scripting
Int32
Opcional. Un valor o una constante que determina el ancho del borde 3D en píxeles.
Consulte también
MaximumNumberOfTimeAxes (RT Professional)
Descripción
MaximumNumberOfTimeColumns (RT Professional)
Descripción
MaximumNumberOfValueAxes (RT Professional)
Descripción
MaximumNumberOfValueColumns (RT Professional)
Descripción
MaximumValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el valor máximo de la escala en el objeto indicado.
Sintaxis
Object.MaximumValue[=DOUBLE | Int32 | SINGLE]

VB Scripting
Object
● Bar
● Gauge
● Slider
● WindowSlider*
DOUBLE | Int32 | SINGLE

Opcional. Un valor o una constante que determina el valor máximo. El tipo de datos depende
de la apariencia:
● DOUBLE: Bar
● Int32: Slider, WindowsSlider
● SINGLE: Gauge
MaxNrOfCurves (RT Advanced)
Descripción
MaxNumberOfComboBoxCharacters (RT Advanced)
Descripción
MaxToolbarRows (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
MenuButtonVisible (RT Advanced)
Descripción

VB Scripting
MenuToolBarConfig (RT Professional)
Descripción
Define el archivo de configuración con menú personalizado y barras de herramientas.
Sintaxis
Object.MenuToolBarConfig[=HmiObjectHandle]
Object
● ScreenWindow
HmiObjectHandle
Opcional. Un valor o una constante que define el archivo de configuración con menú definido
por el usuario y barras de herramientas.
MessageAreaHeight (RT Advanced)
Descripción
MessageAreaLeft (RT Advanced)
Descripción
MessageAreaTop (RT Advanced)
Descripción
MessageAreaWidth (RT Advanced)
Descripción

VB Scripting
MessageBlockAlignment (RT Professional)
Descripción
Define cómo se alineará el nombre de un bloque de aviso referenciado mediante
"MessageBlockIndex" en el título de la columna.
Ajuste además "ApplyProjectSettings" a "FALSE".
Sintaxis
Object.MessageBlockAlignment [=HorizontalAlignment]
Object
● AlarmControl
HorizontalAlignment
Opcional. Valor o constante que define la alineación.

0 Izquierda El nombre del bloque en el título de la columna se muestra
justificado a la izquierda.
1 Centrado El nombre del bloque en el título de la columna se muestra
centrado.
2 Derecha El nombre del bloque en el título de la columna se muestra
justificado a la derecha.
Consulte también
ApplyProjectSettings (Página 522)
MessageBlockAutoPrecisions (RT Professional)
Descripción
Define si se determinará automáticamente el número de decimales de un bloque de aviso
referenciado mediante "MessageBlockIndex".
Sintaxis
Object.MessageBlockAutoPrecisions[=BOOLEAN]

VB Scripting
Object
● AlarmControl
BOOLEAN
Opcional.
FALSE si se utiliza el valor de "MessageBlockPrecisions".
Consulte también
MessageBlockIndex (Página 820)
MessageBlockCaption (RT Professional)
Descripción
Define el nombre de un bloque de aviso referenciado mediante "MessageBlockIndex" en el
título de la columna. El nombre introducido es efectivo en todos los idiomas de runtime.
Sintaxis
Object.MessageBlockCaption[=STRING]
Object
● AlarmControl
STRING
Opcional. Define el nombre del título de la columna para el bloque de aviso seleccionado.
Consulte también

VB Scripting
MessageBlockCount (RT Professional)
Descripción
Define el número de bloques de aviso configurados.
Sintaxis
Object.MessageBlockCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de bloques de aviso configurados.
Consulte también
MessageBlockDateFormat (RT Professional)
Descripción
Define qué formato de fecha se utilizará para los avisos.
Sintaxis
Object.MessageBlockDateFormat[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Opcional. Valor o constante que define qué formato de fecha se utilizará para visualizar los
avisos.
Valor Explicación
Automático El formato de fecha se generará automáticamente.
dd.MM.yy Día.Mes.Año, p. ej., 24.12.10.
dd.MM.yyyy Día.Mes.Año, p. ej., 24.12.2010.
dd/MM/yy Día/Mes/Año, p. ej., 24/12/10.
dd/MM/yyyy Día/Mes/Año, p. ej., 24/12/2010.
Consulte también
MessageBlockExponentialFormat (RT Professional)
Descripción
Define si los valores de un bloque de aviso referenciado mediante "MessageBlockIndex" se
mostrarán en representación exponencial.
Sintaxis
Object.MessageBlockExponentialFormat[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
FALSE si los valores se mostrarán en representación decimal.
Consulte también

VB Scripting
MessageBlockFlashOn (RT Professional)
Descripción
Define si el contenido de un bloque de aviso referenciado mediante "MessageBlockIndex"
parpadeará en runtime cuando aparezca un aviso.
Sintaxis
Object.MessageBlockFlashOn[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el contenido del bloque de aviso parpadea.
FALSE si el contenido del bloque de aviso no parpadea.
Consulte también
MessageBlockHideText (RT Professional)
Descripción
Define si el contenido de un bloque de aviso referenciado mediante "MessageBlockIndex" se
mostrará como texto.
Sintaxis
Object.MessageBlockHideText[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si el contenido no se muestra en forma de texto.
FALSE si el contenido se muestra en forma de texto.
Consulte también
MessageBlockHideTitleText (RT Professional)
Descripción
Define si el título de un bloque de aviso referenciado mediante "MessageBlockIndex" se
mostrará en forma de texto.
Sintaxis
Object.MessageBlockHideTitleText[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el título no se mostrará en forma de texto.
FALSE si el título se mostrará en forma de texto.
Consulte también
MessageBlockId (RT Professional)
Descripción
Define la asignación de clave ID y bloque de aviso en el visor de avisos.

VB Scripting
Sintaxis
Object.MessageBlockId[=Int32]
Object
● AlarmControl
Int32
Opcional. Define la asignación de clave ID y bloque de aviso en el visor de avisos.
Consulte también
MessageBlockIndex (RT Professional)
Descripción
Hace referencia a un bloque de aviso. Para acceder a las propiedades de un bloque de aviso,
es necesario activar "MessageBlockIndex".
Los valores válidos para "MessageBlockIndex" se encuentran entre 0 y "MessageBlockCount"
menos 1. La propiedad "MessageBlockCount" indica el número de bloques de aviso
configurados.
Sintaxis
Object.MessageBlockIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define a través del índice el bloque de aviso que se editará.
Consulte también
MessageBlockCount (Página 814)

VB Scripting
MessageBlockLeadingZeros (RT Professional)
Descripción
Define si las entradas de un bloque de aviso referenciado mediante "MessageBlockIndex" se
mostrarán con ceros a la izquierda.
Sintaxis
Object.MessageBlockLeadingZeros[=Int32]
Object
● AlarmControl
Int32
Opcional.
1 si se muestran las entradas del bloque de aviso con ceros a la izquierda.
0 si se muestran las entradas del bloque de aviso sin ceros a la izquierda.
Consulte también
MessageBlockLength (RT Professional)
Descripción
Define la longitud en caracteres del contenido de un bloque de aviso referenciado mediante
"MessageBlockIndex".
Sintaxis
Object.MessageBlockLength[=Int32]
Object
● AlarmControl

VB Scripting
Int32
Opcional. Valor que establece la longitud del bloque de aviso.
Consulte también
MessageBlockName (RT Professional)
Descripción
Define el nombre de un bloque de aviso referenciado mediante "MessageBlockIndex".
Sintaxis
Object.MessageBlockName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del bloque de aviso referenciado.
MessageBlockPrecisions (RT Professional)
Descripción
Define el número de decimales de los valores de un bloque de aviso referenciado mediante
"MessageBlockIndex".
Sintaxis
Object.MessageBlockPrecisions[=Int16]
Object
● AlarmControl

VB Scripting
Int16
Opcional. Determina el número de decimales.
Consulte también
MessageBlockSelected (RT Professional)
Descripción
Define si está marcado un bloque de aviso referenciado mediante "MessageBlockIndex".
Ajuste además "ApplyProjectSettings (Página 522)" a "FALSE".
Sintaxis
Object.MessageBlockSelected[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si el bloque de aviso está marcado.
Consulte también
MessageBlockShowDate (RT Professional)
Descripción
Define si en el bloque de aviso "Hora" se mostrará la fecha además de la hora.
Sintaxis
Object.MessageBlockShowDate[=BOOLEAN]

VB Scripting
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualizan la fecha y la hora.
FALSE si se visualiza la hora.
Consulte también
MessageBlockShowIcon (RT Professional)
Descripción
Define si el contenido de un bloque de aviso referenciado mediante "MessageBlockIndex" se
mostrará como símbolo.
Sintaxis
Object.MessageBlockShowIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el contenido se mostrará en forma de símbolo.
FALSE si el contenido no se mostrará en forma de símbolo.
Consulte también

VB Scripting
MessageBlockShowTitleIcon (RT Professional)
Descripción
Define si el título de un bloque de aviso referenciado mediante "MessageBlockIndex" se
Sintaxis
Object.MessageBlockShowTitleIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el título se mostrará en forma de símbolo.
FALSE si el título no se mostrará en forma de símbolo.
Consulte también
MessageBlockTextId (RT Professional)
Descripción
Define el nombre de un bloque de aviso referenciado mediante "MessageBlockIndex" con
ayuda de una ID de texto obtenida en la librería de textos. Si se cambia el idioma runtime, el
nombre se ajustará automáticamente.
Sintaxis
Object.MessageBlockTextId[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Define el nombre del bloque de aviso seleccionado con ayuda de un ID de texto.
MessageBlockTimeFormat (RT Professional)
Descripción
Define qué formato de tiempo o de duración se utilizará para visualizar los avisos.
Sintaxis
Object.MessageBlockTimeFormat[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define qué formato de tiempo o de duración se utilizará para
visualizar los avisos.
Los siguientes formatos de tiempo están a disposición:
Valor Explicación
HH:mm:ss Horas:Minutos:Segundos, por ejemplo 15:35:44
HH:mm:ss.ms Horas:Minutos:Segundos.milisegundos, por ejemplo 15:35:44.240.
hh:mm:ss tt Horas:Minutos:Segundos, AM/PM, por ejemplo 03:35:44 PM.
hh:mm:ss.ms tt Horas:Minutos:Segundos.milisegundos, AM/PM, por ejemplo 03:35:44.240
PM.
Los siguientes formatos de duración están a disposición:
Valor Explicación
Automático El formato de duración se generará automáticamente.
d H:mm:ss Día Horas:Minutos:Segundos, por ejemplo 1 2:03:55.
H:mm:ss. Horas:Minutos:Segundos, por ejemplo 26:03:55.
m:ss Minutos:Segundos, ejemplo: 1563:55.
s Segundos, por ejemplo 93835.

VB Scripting
Consulte también
MessageBlockType (RT Professional)
Descripción
Define el tipo de un bloque de aviso referenciado mediante "MessageBlockIndex".
Sintaxis
Object.MessageBlockType[=AlarmBlockType]
Object
● AlarmControl
AlarmBlockType
Opcional. Valor o constante que devuelve el tipo del bloque de aviso.
Valor Explicación
0 El bloque de aviso es un bloque de sistema.
1 El bloque de aviso es un bloque de textos de usuario.
2 El bloque de aviso es un bloque de parámetros.
3 El bloque de aviso pertenece a los bloques de aviso de la estadística de avisos.
Consulte también
MessageColumnAdd (RT Professional)
Descripción
Crea un bloque de aviso nuevo. El bloque de aviso recién creado se referencia
automáticamente mediante "MessageColumnIndex".

VB Scripting
Sintaxis
Object.MessageColumnAdd[=STRING]
Object
● AlarmControl
STRING
Necesario. Valor o constante que define el nombre del nuevo bloque de aviso mediante
"MessageColumnName".
Consulte también
MessageColumnIndex (Página 829)
MessageColumnCount (RT Professional)
Descripción
Define el número de bloques de aviso configurados.
Sintaxis
Object.MessageColumnCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de bloques de aviso configurados.
Consulte también

VB Scripting
MessageColumnIndex (RT Professional)
Descripción
Hace referencia a uno de los bloques de aviso seleccionados para la lista de avisos. Para
acceder a las propiedades de un bloque de aviso, es necesario activar
"MessageColumnIndex".
Los valores válidos para "MessageColumnIndex" se encuentran entre 0 y
"MessageColumnCount" menos 1. La propiedad "MessageColumnCount" indica el número
de bloques de aviso configurados.
Sintaxis
Object.MessageColumnIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina el bloque de aviso seleccionado para la lista de
avisos a través del índice.
Consulte también
MessageColumnCount (Página 826)
MessageColumnName (RT Professional)
Descripción
Define el nombre de un bloque de aviso referenciado mediante "MessageColumnIndex".
Sintaxis
Object.MessageColumnName[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Opcional. Valor o constante que define el nombre del bloque de aviso referenciado.
Consulte también
MessageColumnRemove (RT Professional)
Descripción
Borra un bloque de aviso referenciado mediante su nombre.
Sintaxis
Object.MessageColumnRemove[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del bloque de aviso referenciado que se
borrará.
Consulte también
MessageColumnRepos (RT Professional)
Descripción
Define la posición de un bloque de aviso referenciado mediante "MessageColumnIndex" en
varios bloques de aviso.
Si ha modificado la posición del bloque de aviso con "MessageColumnRepos", a
"MessageColumnIndex" se le asignará el valor de "MessageColumnRepos".
Sintaxis
Object.MessageColumnRepos[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o constante que define la posición del bloque de aviso referenciado. Rango
de valores de 0 a "MessageColumnCount" menos 1. Los valores fuera de este rango de
valores no tienen ningún efecto.
0: El bloque de aviso referenciado se posiciona a la izquierda.
Consulte también
MessageColumnCount (Página 826)
MessageColumnSort (RT Professional)
Descripción
Define cómo se clasificará el contenido de un bloque de aviso referenciado mediante
Sintaxis
Object.MessageColumnSort[=SortMode]
Object
● AlarmControl
SortMode
Opcional. Valor o constante que define la clasificación del bloque de aviso referenciado.
Valor Explicación
Consulte también

VB Scripting
MessageColumnSortIndex (RT Professional)
Descripción
Define la secuencia de clasificación del bloque de aviso referenciado en
"MessageColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se eliminará de
"MessageColumnSort".
Sintaxis
Object.MessageColumnSortIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Define la secuencia de clasificación del bloque de aviso referenciado en
Consulte también
MessageColumnVisible (RT Professional)
Descripción
Define si se visualizará el bloque de aviso referenciado mediante "MessageColumnIndex".
Sintaxis
Object.MessageColumnVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza el bloque de aviso referenciado.
FALSE si no se visualiza el bloque de aviso referenciado.

VB Scripting
Consulte también
MessageListType (RT Professional)
Descripción
Determina qué contenidos se muestran.
Sintaxis
Object.MessageListType[=AlarmListType]
Object
● AlarmControl
AlarmListType
Opcional. Valor o constante que define los contenidos.
Valor Explicación
0 Al abrir una imagen se muestran los avisos pendientes en estos momentos.
1 Al abrir una imagen se activa el visor "Fichero de corto plazo". El visor de avisos muestra
avisos archivados y pendientes en estos momentos.
Cuando entran nuevos avisos se actualiza inmediatamente la visualización.
2 Al abrir una imagen se activa el visor "Fichero de largo plazo". El visor de avisos muestra
sólo avisos archivados que puede comentar el usuario.
3 Al abrir una imagen se muestran solo los avisos actualmente bloqueados.
4 Al abrir una imagen se muestran los cálculos estadísticos configurados de avisos archiva‐
dos.
5 Al abrir una imagen se muestran solo los avisos cuya visualización se ha inhibido.
Consulte también
MiddleGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
MinimumNumberOfTimeAxes (RT Professional)
Descripción
MinimumNumberOfTimeColumns (RT Professional)
Descripción
MinimumNumberOfValueAxes (RT Professional)
Descripción
MinimumNumberOfValueColumns (RT Professional)
Descripción
MinimumValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el valor mínimo de la escala en el objeto indicado.
Sintaxis
Object.MinimumValue[=DOUBLE | Int32 | SINGLE]
Object
● Bar
● Gauge
● Slider
● WindowSlider*

VB Scripting

Opcional. Un valor o una constante que determina el valor mínimo. El tipo de datos depende
de la apariencia:
● DOUBLE: Bar
● Int32: Slider, WindowsSlider
● SINGLE: Gauge
MinNrOfCurves (RT Advanced)
Descripción
MinPasswordValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
MinuteNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la longitud del minutero.
Sintaxis
Object.MinuteNeedleHeight[=Int32]
Object
● Clock
Int32
Opcional. Valor o constante que determina la longitud del minutero.
Indique la longitud del minutero en tantos por ciento, referidos al radio de la esfera.
Consulte también
Clock (Página 290)

VB Scripting
MinuteNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el ancho del minutero.
Sintaxis
Object.MinuteNeedleWidth[=Int32]
Object
● Clock
Int32
Opcional. Valor o constante que determina el ancho del minutero.
Indique el ancho en tantos por ciento, referidos a la longitud doble del minutero.
Consulte también
Clock (Página 290)
Mode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el modo de comportamiento de un objeto de texto en runtime.
Acceso en runtime:
Sintaxis
Object.Mode[=Type]
Object
● Button
● IOField
● RoundButton*

VB Scripting

● DateTimeField
● GraphicIOField
● Switch
Type
Opcional. Valor o constante que define el modo de comportamiento de un objeto de texto en
runtime.
Valor Constante VB Descripción

0 hmiIOFieldOutput Campo de salida
1 hmiIOFieldInput Campo de entrada
2 hmiIOFieldInOutput Campo de entrada y salida
MonitorNumber (RT Professional)
Descripción
Devuelve el número del monitor cuyos contenidos se muestran en la ventana de imagen.
El número de monitor hace referencia al número de monitores configurado en Microsoft
Windows: "Panel de control > Pantalla > Configuración > Visualización"
Sintaxis
Object.MonitorNumber[=Int32]
Object
● Screenwindow
Int32
Opcional. Valor o constante que define el número del monitor mostrado.
Consulte también

VB Scripting
Moveable (RT Professional)
Descripción
Define si el objeto se puede desplazar en runtime.
Sintaxis
Object.Moveable[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si la ventana puede moverse en runtime.
FALSE si la ventana está fija en runtime.
Consulte también
MsgFilterSQL (RT Professional)
Descripción
Define uno o varios Statements SQL para la selección personalizada de los avisos. Varias
selecciones personalizadas se vinculan con "OR". Si ha configurado una selección fija
"DefaultMsgFilterSQL", los Statements SQL de "DefaultMsgFilterSQL" y "MsgFilterSQL" se
vinculan con "AND".

VB Scripting
Sintaxis
Object.MsgFilterSQL[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que establece las instrucciones SQL para la selección
personalizada de los avisos.
Consulte también
Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve el nombre de objeto como STRING. El valor devuelto depende del objeto utilizado.
Sintaxis
Object.Name[=STRING]
Object
● Clock
● DiscSpaceView *
● Gauge
● Slider
● AlarmControl
● AlarmView
● BatteryView
● Bar

VB Scripting
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● ProDiagOverview
● Polygon
● Polyline
● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview

VB Scripting
● ScreenWindow
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowSlider
● ZoneLabelView
● ZoneQualityView
String
Opcional. Valor o constante que devuelve el nombre del objeto.
Observaciones
En función del objeto indicado se devuelven los siguientes nombres de objeto:
● Tag: Nombre de la variable sin prefijo de servidor ni de variable.
● Project: Nombre del proyecto de runtime actual.
● DataItem: Nombre del objeto DataItem.

VB Scripting
● Layer: Nombre del nivel.

● FunctionTrendControl : Nombre de la curva referenciada mediante la propiedad "Index".
Nota
En la lista "Tags" se puede acceder a una variable mediante la propiedad "Name". Los
nombres de las variables están estructurados en WinCC según el siguiente esquema:
<Prefijo de variable><Nombre de variable>
Si solo se indica el nombre de variable, el prefijo de variable se toma del contexto de la
ventana de imagen.
Ejemplo
El siguiente ejemplo indica el nombre del proyecto de runtime actual como Trace:
Tabla 1-129
'VBS160
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
NameColumnWidth (RT Advanced)
Descripción
NavigateTo (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el módulo al que se salta.
Sintaxis
Object.NavigateTo[=String]
Object
● PLCCodeViewer
● SysDiagControl *
* RT Advanced: Ningún acceso; RT Professional: Solo acceso de lectura

VB Scripting
String
Opcional. Valor o constante que determina el módulo.
NavigationButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
NavigationPath_Font (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
NavigationPath_RootText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
NavigationPath_TextColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
NavigationpathDiagbufferDetailText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
NavigationpathDiagbufferText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
NeedleBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de línea de las agujas.
Sintaxis
Object.NeedleBorderColor[=Color]
Object
● Clock
Color
Opcional. Valor o constante que determina el color de línea de la aguja.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Clock (Página 290)
NeedleColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de la aguja.
Para ello, defina además que se represente el color de la aguja mediante "NeedleFillStyle".
Sintaxis
Object.NeedleColor[=Color]

VB Scripting
Object
● Clock
Color
Opcional. Valor o constante que determina el color de las agujas.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Clock (Página 290)
NeedleFillStyle (RT Professional)
Descripción
Define si los punteros deben mostrarse opacos o transparentes.
Sintaxis
Object.NeedleFillStyle[=THmiFillStyle]
Object
● Clock
THmiFillStyle
Opcional. Valor o constante que determina si las agujas se muestran con relleno o
transparentes.

0 hmiFillStyleSolid Las agujas se muestran transparentes y con un borde en el color
del primer plano.
65536 hmiFillStyleTransparent Las agujas se muestran con el color de relleno de la aguja y con
un borde en el color del primer plano.

VB Scripting
Consulte también
Clock (Página 290)
NeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
NoHitTest (RT Professional)
Descripción
NormalColor (RT Professional)
Descripción
Determina el color de la memoria ocupada en el visor de memoria cuando el grado de
ocupación de memoria no es crítico.
Sintaxis
Object.NormalColor[=Color]
Object
● DiscSpaceView
Color
Opcional. Valor o constante que determina el color del visor de memoria en el rango normal.
Observaciones
rojo, verde, azul). Introduzca para cada uno de los tres valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). El color "rojo" se representa, p. ej.,
de la forma siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
NormalRangeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del rango normal en la escala del objeto "Gauge".
La propiedad "NormalRangeVisible" debe tener el valor TRUE para que se visualice el rango
normal.
Sintaxis
Object.NormalRangeColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color del rango normal.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)
NormalRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse el rango normal en la escala del objeto "Gauge".

VB Scripting
Sintaxis
Object.NormalRangeVisible[=BOOLEAN]
Object
● Gauge
BOOLEAN
Opcional. TRUE si debe mostrarse el rango normal en la escala.
Observaciones
El color del rango normal se define con la propiedad "NormalRangeColor".
Consulte también
Gauge (Página 324)
NumberOfButtons (RT Professional)
Descripción
NumberOfLines (RT Advanced)
Descripción
NumberOfVisibleLines (RT Professional)
Descripción
Determina el número de filas visibles en el visor de código PLC.
Sintaxis
Object.NumberOfVisibleLines[=Int32]

VB Scripting
Object
● PLCCodeViewer
Int32
Opcional. Valor o constante que determina el número de filas en el visor de código PLC.
Consulte también
NumberStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
1.5.5.10 Propiedades O-P (Panels, Comfort Panels, RT Advanced, RT Professional)
Object (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ObjectSizeDeclutteringEnable (RT Professional)
Descripción
Indica si sólo se muestran objetos dentro de un rango de tamaño definido.
Sintaxis
Object.ObjectSizeDeclutteringEnable
Object

VB Scripting
Ejemplo
El ejemplo muestra las propiedades Decluttering de la imagen "NewPDL1" como Trace.
'VBS157
Dim objScreen
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
Consulte también
ObjectSizeDeclutteringMax (RT Professional)
Descripción
Devuelve como LONG el rango de tamaño superior para suprimir la visualización de objetos
Sintaxis
Object.ObjectSizeDeclutteringMax
Object
Ejemplo
'VBS157
Dim objScreen
Consulte también

VB Scripting
ObjectSizeDeclutteringMin (RT Professional)
Descripción
Devuelve como LONG el rango de tamaño inferior para suprimir la visualización de objetos
Sintaxis
Object.ObjectSizeDeclutteringMin
Object
Ejemplo
'VBS157
Dim objScreen
Consulte también
OcxGuid (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
OCXState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
OcxStateForEs2Rt (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Online (RT Professional)
Descripción
Define el inicio y paro de la actualización.
Sintaxis
Object.Online[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la representación actualizada se detiene. Los valores se guardan en la memoria
intermedia y se añaden en cuanto vuelve a activarse el botón.
FALSE si la representación actualizada se continúa.
Consulte también
OnValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
OperationSteps (RT Professional)
Descripción
Establece cuántos pasos se desplaza el deslizador de la barra de desplazamiento con un clic
de ratón.
Sintaxis
Object.OperationSteps[=Int32]
Object
Necesario. Objeto del tipo ""ScreenItem" con la apariencia:
● WindowSlider
Int32
Opcional. Valor o constante que establece cuántos pasos se desplaza el deslizador de la barra
de desplazamiento con un clic de ratón.
Consulte también
OperatorAlarms (RT Professional)
Descripción
OperatorMessageId (RT Professional)
Descripción
Define la asignación por la clave ID y el evento de activación en el visor de avisos.
Sintaxis
Object.OperatorMessageId[=Int32]
Object
● AlarmControl

VB Scripting
Int32
Opcional. Valor o constante que define la asignación de números de ident. y eventos de
disparo en el visor de avisos.

0 Lock Evento de activación "Bloquear"
1 Unlock Evento de activación "Habilitar"
2 Hide Evento de activación "Ocultar"
3 Unhide Evento de activación "Mostrar"
4 Quit Evento de activación "Acusar"
Consulte también
OperatorMessageIndex (RT Professional)
Descripción
Hace referencia al evento de aviso para un aviso de operador. Esta propiedad permite asignar
los valores de otras propiedades a un determinado aviso de operador.
Sintaxis
Object.OperatorMessageIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el evento de aviso de un aviso de operador.
Valor Explicación
0 Evento de aviso "Bloquear"
1 Evento de aviso "Habilitar"
2 Evento de aviso "Ocultar"
3 Evento de aviso "Mostrar"
4 Evento de aviso "Acusar"
Consulte también

VB Scripting
OperatorMessageName (RT Professional)
Descripción
Define el nombre referenciado con el evento "OperatorMessageIndex" en eventos para avisos
de operador.
Sintaxis
Object.OperatorMessageName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre (referenciado con el evento
"OperatorMessageIndex") en eventos de aviso de avisos de operador.
Valor Explicación
Lock El evento de aviso "Bloquear".
Unlock El evento de aviso "Habilitar".
Hide El evento de aviso "Ocultar".
Unhide El evento de aviso "Mostrar".
Quit El evento de aviso "Acusar".
Consulte también
OperatorMessageNumber (RT Professional)
Descripción
Determina un número para el aviso de operador del evento de aviso seleccionado si no se
utiliza el aviso de operador de WinCC.
Sintaxis
Object.OperatorMessageNumber[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Determina un número para el aviso de operador del evento de aviso seleccionado.
Consulte también
OperatorMessageSelected (RT Professional)
Descripción
Activa los eventos de aviso en la lista en la que se habilitarán los avisos de operador.
Sintaxis
Object.OperatorMessageSelected[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si los eventos de aviso están activados en la lista en que se activan los avisos de
operador.
Consulte también
OperatorMessageSource1 (RT Professional)
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 1" del aviso de operador configurado aquí.

VB Scripting
Sintaxis
Object.OperatorMessageSource1[=STRING]
Object
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 1" del aviso de operador configurado aquí.
Ejemplo
Se desea generar un aviso de operador al bloquear un aviso. El contenido de "Bloque de
textos de usuario 1" del aviso bloqueado (p. ej., "Motor averiado") debe mostrarse en el
"Bloque de valor de proceso 1" del aviso de operador. Para ello, seleccione en Valor de
proceso "1" el "Bloque de textos de usuario 1" como bloque de aviso del aviso manejado.
Consulte también
Descripción
Sintaxis
Object
● AlarmControl
STRING

VB Scripting
Ejemplo
Consulte también
Descripción
Sintaxis
Object
● AlarmControl
STRING
Ejemplo
Consulte también

VB Scripting
Descripción
Sintaxis
Object
● AlarmControl
STRING
Ejemplo
Consulte también
Descripción
Sintaxis

VB Scripting
Object
● AlarmControl
STRING
Ejemplo
Consulte también
Descripción
Sintaxis
Object
● AlarmControl
STRING
Ejemplo

VB Scripting
Consulte también
Descripción
Sintaxis
Object
● AlarmControl
STRING
Ejemplo
Consulte también
Descripción
Sintaxis

VB Scripting
Object
● AlarmControl
STRING
Ejemplo
Consulte también
Descripción
Sintaxis
Object
● AlarmControl
STRING
Ejemplo

VB Scripting
Consulte también
Descripción
Sintaxis
Object
● AlarmControl
STRING
Ejemplo
Consulte también
OperatorMessageSourceType1 (RT Professional)
Descripción
Define si el contenido del bloque de aviso del aviso de operador se transferirá como texto o
como valor.
Sintaxis
Object.OperatorMessageSourceType1[=TransferAs]

VB Scripting
Object
● AlarmControl
TransferAs
Opcional. Valor o constante que determina cómo se mostrará el bloque de aviso en el aviso
de operador.
Están disponibles los siguientes ajustes:

0 Texto El bloque de aviso se muestra en forma de texto.
1 Valor El bloque de aviso se muestra en forma de valor.
Consulte también
Descripción
como valor.
Sintaxis
Object
● AlarmControl
TransferAs
de operador.


VB Scripting
Consulte también
Descripción
como valor.
Sintaxis
Object
● AlarmControl
TransferAs
de operador.

Descripción
como valor.
Sintaxis
Object
● AlarmControl

VB Scripting
TransferAs
de operador.

Consulte también
Descripción
como valor.
Sintaxis
Object
● AlarmControl
TransferAs
de operador.

Consulte también

VB Scripting
Descripción
como valor.
Sintaxis
Object
● AlarmControl
TransferAs
de operador.

Consulte también
Descripción
como valor.
Sintaxis
Object
● AlarmControl

VB Scripting
TransferAs
de operador.

Consulte también
Descripción
como valor.
Sintaxis
Object
● AlarmControl
TransferAs
de operador.

Consulte también

VB Scripting
Descripción
como valor.
Sintaxis
Object
● AlarmControl
TransferAs
de operador.

Consulte también
Descripción
como valor.
Sintaxis
Object
● AlarmControl

VB Scripting
TransferAs
de operador.

Consulte también
OutputAddressText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PaddingBottom (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PaddingLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PaddingRight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PaddingTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
PageMode (RT Professional)
Descripción
Determina si el paso de página es posible en la lista de ficheros a largo plazo. De esta forma
se pueden mostrar todos los avisos del archivo cíclico en la lista de archivos a largo plazo por
páginas. Con la propiedad "PageModeMessageNumber" se determina el número de avisos
que se mostrarán por página. Si el paso de página está activo se podrán utilizar los botones
para pasar página de la barra de herramientas.
Sintaxis
Object.PageMode[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si puede pasarse página en la lista de ficheros a largo plazo.
FALSE si no puede pasarse página en la lista de ficheros a largo plazo.
Consulte también
PageModeMessageNumber (RT Professional)
Descripción
Define la cantidad de avisos que se mostrarán por página cuando se pase de página en la
lista de ficheros a largo plazo.
Sintaxis
Object.PageModeMessageNumber[=Int32]
Object
● AlarmControl

VB Scripting
Int32
Opcional. Valor o constante que establece el número de avisos por página.
Consulte también
Password (RT Advanced)
Descripción
Determina la contraseña para configurar el control remoto.
Sintaxis
Object.Password[=STRING]
Object
● SmartClientView
STRING
Opcional. Valor o constante que contiene la contraseña para configurar la vigilancia remota.
Consulte también
PasswordsMustBeEncrypted (RT Advanced)
Descripción
Path (RT Professional)
Descripción
Devuelve como STRING la ruta del proyecto actual sin el nombre del archivo. En un cliente
WinCC sin proyecto propio se devuelve la ruta en formato UNC, sino la ruta local.

VB Scripting
Sintaxis
Object.Path
Object
Obligatorio. Un objeto del tipo "Project".
Ejemplo
El siguiente ejemplo muestra la ruta del proyecto como Trace:
'VBS161
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
Consulte también
Project (Página 216)
PathHeaderBackColor (RT Professional)
Descripción
PathHeaderFont (RT Professional)
Descripción
Define la fuente del encabezado.
Sintaxis
Object.PathHeaderFont[=Font]
Object
● PLCCodeViewer
● S7GraphOverview
Font
Opcional. Valor o constante que define la fuente del encabezado.

VB Scripting
Consulte también
PathHeaderTextColor (RT Professional)
Descripción
Define el color de fuente del encabezado de la vista general de GRAPH.
Sintaxis
Object.PathHeaderTextColor[=Color]
Object
● S7GraphOverview
Color
Opcional. Valor o constante que define el color de fuente del encabezado de la vista general
de S7-GRAPH.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
PercentageAxis (RT Professional)
Descripción
Determina que se muestre un eje adicional con una escala porcentual en el visor de curvas.

VB Scripting
Sintaxis
Object.PercentageAxis[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si un eje se muestra con una escala porcentual.
FALSE si se muestran solo ejes de valores y de tiempo.
Consulte también
PercentageAxisAlignment (RT Professional)
Descripción
Define la alineación del eje porcentual.
Sintaxis
Object.PercentageAxisAlignment[=AxisAlignment]
Object
AxisAlignment
Opcional. Valor o constante que determina la alineación del eje porcentual.
Valor Nombre Descripción

0 Izquierda El eje con escala porcentual está alineado a la izquierda.
1 Derecha El eje con escala porcentual está alineado a la derecha.
Consulte también

VB Scripting
PercentageAxisColor (RT Professional)
Descripción
Determina el color de fuente y de línea del eje porcentual.
Sintaxis
Object.PercentageAxisColor[=Color]
Object
Color
Opcional. Valor o constante que define el color del eje porcentual.
Observaciones
RGB (255, 0, 0)
vbGreen.
Consulte también
Picture (RT Professional)
Descripción
Define la imagen de la colección de gráficos de WinCC que se mostrará en el objeto en runtime.
Sintaxis
Object.Picture[=HmiObjectHandle]

VB Scripting
Object
● Clock
● GraphicView
HmiObjectHandle
Opcional. Valor o constante que define la imagen de la colección de gráficos de WinCC que
se mostrará en el objeto en runtime.
PictureAlignment (RT Professional)
Descripción
Define el modo de representación de la imagen de fondo en el sinóptico de proceso.
Sintaxis
Object.PictureAlignment[=PictureAlignment]
Object
● Button
● RoundButton*
PictureAlignment
Opcional. Valor o constante que determina el modo de representación de la imagen de fondo
en el sinóptico de proceso.
PictureAreaBottomMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PictureAreaLeftMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
PictureAreaRightMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PictureAreaTopMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PictureAutoSizing (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PictureDeactivated (RT Professional)
Descripción
Define el gráfico de la colección de gráficos de WinCC que se muestra en estado
"Desactivado".
Sintaxis
Object.PictureDeactivated[=HmiObjectHandle]
Object
● Roundbutton
HmiObjectHandle
Opcional. Un valor o una constante que determina el gráfico que se mostrará en el estado
"Desactivado".
Consulte también

VB Scripting
PictureList (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PictureOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el gráfico que se mostrará en el estado "Off".
Acceso en runtime:
Sintaxis
Object.PictureOff[=HmiObjectHandle]
Object
● Button
● GraphicIOField
● RoundButton*
● Switch
HmiObjectHandle
Opcional. Un valor o una constante que determina el gráfico que se mostrará en el estado
"Off".
Observaciones
Para poder incorporar el gráfico (*.BMP o *.DIB), este debe encontrarse en la carpeta "GraCS"
del proyecto actual.
PictureOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece la imagen que se muestra en el estado "On".

VB Scripting
Acceso en runtime:
Sintaxis
Object.PictureOn[=HmiObjectHandle]
Object
● Button
● GraphicIOField
● RoundButton*
● Switch
HmiObjectHandle
Opcional. Valor o constante que establece la imagen que se muestra en el estado "On".
Observaciones
Para poder incorporar la imagen (*.BMP o *.DIB), esta debe encontrarse en la carpeta "GraCS"
del proyecto actual.
PictureRotation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PictureSizeMode (RT Professional)
Descripción
Define la adaptación del tamaño entre el Media Player y los contenidos que representar.
Sintaxis
Object.PictureSizeMode[=PictureSizeMode]

VB Scripting
Object
● MediaPlayer
PictureSizeMode
Opcional. Valor o constante que define la adaptación del tamaño entre el Media Player y los
contenidos que representar.
Valor Nombre Descripción

0 Adaptar tamaño del ob‐ Determina que el tamaño del Media Player se adapte al tamaño
jeto al contenido de los contenidos que representar.
1 Adaptar contenido al ta‐ Determina que los contenidos que representar se adapten al ta‐
maño del objeto maño del Media Player.
Consulte también
PlayCount (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PlayEndless (RT Professional)
Descripción
Determina que el archivo de medios se reproduzca sin fin.
Sintaxis
Object.PlayEndless[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si el archivo de medios se reproduce sin fin.
FALSE si el archivo de medios se reproduce una sola vez.

VB Scripting
Consulte también
PLCFilter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PlcUDTFilter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PointerColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la aguja en el objeto "Gauge".
Sintaxis
Object.PointerColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color de las agujas.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
Gauge (Página 324)
Points (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
PointsCount (RT Professional)
Descripción
Determina el número de vértices de la polilínea o del polígono.
Acceso en runtime:
Sintaxis
Object.PointsCount[=Int32]
Object
● Polygon
● Polyline
● Tubepolyline
● Connector
● Line
Int32
Opcional. Un valor o una constante que determina el número de vértices de la polilínea.
PopupMenuEnabled (RT Professional)
Descripción

VB Scripting
PositionFont (RT Professional)
Descripción
Define la fuente de la rotulación del deslizador.
Sintaxis
Object.PositionFont[=Font]
Object
● Slider
Font
Precision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el número de decimales (de 0 a 20).
Sintaxis
Object.Precision[=Int32]
Object
● Bar
Int32
Opcional. Un valor o una constante que determina el número de decimales (de 0 a 20).
Consulte también
Bar (Página 261)

VB Scripting
PreferredUseOnAck (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Pressed (RT Professional)
Descripción
Determina si el objeto indicado se representa pulsado.
Sintaxis
Object.Pressed[=BOOLEAN]
Object
● Button
● RoundButton*
BOOLEAN
Opcional. TRUE si el objeto indicado se representa pulsado.
PrintJob (RT Professional)
Descripción
Establece un trabajo de impresión creado en el editor "Informes".
Sintaxis
Object.PrintJob[=HmiObjectHandle]
Object
● AlarmControl

VB Scripting
HmiObjectHandle
Opcional. Valor o constante que determina el diseño de la impresión.
Consulte también
ProcessTag (RT Professional)
Descripción
ProcessValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el ajuste predeterminado para el valor que debe mostrarse.
En runtime se utiliza este valor si al iniciar la imagen no está conectada o actualizada la
variable asociada.
Acceso en runtime:
Sintaxis
Object.ProcessValue[=DOUBLE | Int32 | Object | SINGLE]
Object
● Bar
● CheckBox

VB Scripting
● Gauge
● GraphicIOField
● IOField
● OptionGroup
● Slider
● WindowsSlider*
● Button
● DateTimeField
● Switch
● SymbolLibrary

Opcional. Un valor o una constante que contiene el valor predeterminado. El tipo de datos
depende de las características:
● DOUBLE: Bar
● Int32: CheckBox, GraphicIOField, OptionGroup, Slider, SymbolicIOField, WindowsSlider
● Object: IOField
● SINGLE: Gauge
Observaciones
Si se quieren asignar SmartTags a la propiedad "ProcessValue", debe formular la asignación
del siguiente modo:
'Ejemplos para la asignación de SmartTags
'Example 1
IOField.ProcessValue = SmartTags("TagName").Value
'Example 2
HmiRuntime.Screens("Screen_1").ScreenItems("IOField_1").ProcessValue =
SmartTags("Tag_1").Value
ProgID (RT Professional)
Descripción
En controles de otros fabricantes que no son WinCC se retornará como tipo la ProgID
independiente de la versión.

VB Scripting
ProhibitDataRecordTagInOnlySimpleView (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
1.5.5.11 Propiedades Q-R (Panels, Comfort Panels, RT Advanced, RT Professional)
QualityCode (RT Professional)
Descripción
Devuelve como SHORT la medida para la calidad de un valor de variable tras la lectura de la
variable. Después de que se escribe una variable, el valor no tendrá validez.
Sintaxis
Object.QualityCode
Object
Ejemplo
El siguiente ejemplo edita la calidad del valor leído cuando no se ha presentado ningún error
durante la lectura:
'VBS83
Dim objTag
Dim lngLastErr
objTag.Read
lngLastErr = objTag.LastError
If 0 = lngLastErr Then
MsgBox objTag.QualityCode
End If
Consulte también
Tag (Página 230)

VB Scripting
Radius (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el radio.
Sintaxis
Object.Radius[=Int32]
Object
● Circle
● CircleSegment
● CircularArc
● RoundButton
Int32
Opcional. Valor o constante que determina el radio en píxeles.
RadiusHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el eje menor.
Sintaxis
Object.RadiusHeight[=Int32]
Object
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject
● Circle

VB Scripting
Int32
Opcional. Valor o constante que determina el eje menor (en píxeles).
Consulte también
RadiusWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el eje mayor.
Sintaxis
Object.RadiusWidth[=Int32]
Object
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject
● Circle
Int32
Opcional. Valor o constante que determina el eje mayor (en píxeles).
Consulte también

VB Scripting
Recipe (RT Advanced)
Descripción
RecipeName (RT Advanced)
Descripción
Retorna el nombre de la receta que se muestra en ese momento en el "Visor de recetas".
Sintaxis
Object.RecipeName[=STRING]
Object
● RecipeView
STRING
Opcional. Valor o constante que devuelve el nombre de la receta.
Consulte también
RecipeNameCaption (RT Advanced)
Descripción
RecipeNrCaption (RT Advanced)
Descripción

VB Scripting
RecipeNrColFirst (RT Advanced)
Descripción
RecipeNumber (RT Advanced)
Descripción
Devuelve el número de la receta que aparece en ese momento en el "Visor de recetas".
Sintaxis
Object.RecipeNumber[=Int32]
Object
● RecipeView
Int32
Opcional. Valor o constante que devuelve el número de la receta.
Consulte también
RecordName (RT Advanced)
Descripción
Devuelve el nombre del registro de receta que aparece en ese momento en el "Visor de
recetas".
Sintaxis
Object.RecordName[=STRING]
Object
● RecipeView

VB Scripting
STRING
Opcional. Valor o constante que devuelve el nombre del registro de receta.
Consulte también
RecordNrColFirst (RT Advanced)
Descripción
RecordNumber (RT Advanced)
Descripción
Devuelve el número del registro de receta que aparece en ese momento en el "Visor de
recetas".
Sintaxis
Object.RecordNumber[=Int32]
Object
● RecipeView
Int32
Opcional. Valor o constante que devuelve el número del registro de receta.
Consulte también
RelativeFillLevel (RT Professional)
Descripción
Determina el porcentaje de relleno del objeto.

VB Scripting
Sintaxis
Object.RelativeFillLevel[=Int32]
Object
● Button
● CheckBox
● Circle
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton*
● TextField
● WindowsSlider*
● CircleSegment
Int32
Opcional. Un valor o una constante que determina el porcentaje con el que se rellena el objeto.
RenameButtonVisible (RT Advanced)
Descripción
ReSizeable (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
RightMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Rotation (RT Professional)
Descripción
Define el ángulo de giro en grados. El ángulo de giro se mide en sentido antihorario.
Sintaxis
Object.Rotation[=SymbolLibraryRotation]
Object
● SymbolLibrary
SymbolLibraryRotation
Opcional. Valor o constante que define el ángulo de rotación en grados.

0 hmiSymbolLibraryRotationNone El objeto gira 0 grados.
90 hmiSymbolLibraryRotation90Degree El objeto gira 90 grados.
RotationAngle (RT Professional)
Descripción
Determina el ángulo de rotación en grados.
Sintaxis
Object.RotationAngle[=Int32]

VB Scripting
Object
● Line
● Polygon
● Polyline
● TextField
● TubeTeeObject
Int32
Opcional. Un valor o una constante que determina el ángulo de rotación en grados.
Observaciones
El objeto gira en runtime en el sentido de las agujas del reloj en torno al punto de referencia.
Consulte también
Line (Página 341)
RotationCenterLeft (RT Professional)
Descripción
Define la coordenada X del punto en torno al que gira el objeto en runtime.
Sintaxis
Object.RotationCenterLeft[=Int32]
Object
● Line
● Polygon
● Polyline
● TextField*

VB Scripting
Int32
Opcional. Un valor o una constante que determina la coordenada X del punto de giro alrededor
del cual gira el objeto en runtime.
Observaciones
El valor de la coordenada X es relativo a la anchura del objeto. Indique el valor en porcentaje
partiendo del borde izquierdo del rectángulo que abarca el objeto.
RotationCenterTop (RT Professional)
Descripción
Define la coordenada Y del punto de giro en torno al que gira el objeto en runtime.
Sintaxis
Object.RotationCenterTop[=Int32]
Object
● Line
● Polygon
● Polyline
● TextField*
Int32
Opcional. Un valor o una constante que determina la coordenada Y del punto de giro alrededor
del cual gira el objeto en runtime.
Observaciones
El valor de la coordenada Y es relativo a la anchura del objeto. Indique el valor en porcentaje
partiendo del borde superior del rectángulo que abarca el objeto.
RoundCornerHeight (RT Professional)
Descripción
Define el radio angular. Introduzca el valor en porcentaje respecto a la media altura del objeto.

VB Scripting
Sintaxis
Object.RoundCornerHeight[=Int32]
Object
● Rectangle
Int32
Opcional. Valor o constante que determina el radio angular.
RoundCornerWidth (RT Professional)
Descripción
Define el radio angular. Introduzca el valor en porcentaje respecto a la media anchura del
objeto.
Sintaxis
Object.RoundCornerWidth[=Int32]
Object
● Rectangle
Int32
Opcional. Valor o constante que determina el radio angular.
RowScrollbar (RT Professional)
Descripción
Define cuándo se mostrará la barra de desplazamiento vertical.
Sintaxis
Object.RowScrollbar[=ScrollbarVisibility]

VB Scripting
Object
● AlarmControl
ScrollbarVisibility
Opcional. Valor o constante que define cuándo se mostrará la barra de desplazamiento
vertical.
Valor Explicación
0 La barra de desplazamiento vertical no se muestra.
1 La barra de desplazamiento vertical se muestra si el área de visualización es demasiado
pequeña para todas las filas.
2 La barra de desplazamiento vertical se muestra siempre.
Consulte también
RowTitleAlignment (RT Professional)
Descripción
Define cómo se alinearán los títulos de fila.
Sintaxis
Object.RowTitleAlignment[=HorizontalAlignment]
Object
● AlarmControl

VB Scripting
HorizontalAlignment
Opcional. Valor o constante que define la alineación de los títulos de las filas.

0 Izquierda Los títulos de las filas se justificarán a la izquierda.
1 Centrado Los títulos de las filas se justificarán centrados.
2 Derecha Los títulos de las filas se justificarán a la derecha.
Consulte también
RowTitles (RT Professional)
Descripción
Define si se mostrarán encabezados de columna numerados.
Sintaxis
Object.RowTitles[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si se muestran encabezados de columna numerados.
Consulte también

VB Scripting
RTPersistence (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si se conservarán las configuraciones online tras cambiar de imagen.
Ajuste también "RTPersistenceType" a 1 o 2.
Acceso en runtime:
Sintaxis
Object.RTPersistence[=RTPersistence]
Object
● AlarmControl
● SysDiagControl
● UserView
RTPersistence
Opcional. Valor o constante que define si las configuraciones online se conservarán después
de un cambio de imagen.
Valor Explicación
0 Las configuraciones online actuales se rechazarán en el próximo cambio de imagen.
1 Las configuraciones online actuales se conservarán en el próximo cambio de imagen.
2 Se perderán todas las modificaciones que hayan sido configuradas online hasta el momen‐
to. La imagen se asigna al contenido configurado originalmente.
RTPersistenceAuthorization (RT Professional)
Descripción
Determina la autorización que es necesaria en runtime para la configuración online.

VB Scripting
Acceso en runtime:
Sintaxis
Object.RTPersistenceAuthorization[=HmiObjectHandle]
Object
● AlarmControl
Con los siguientes rasgos no tiene acceso en runtime:
● SysDiagControl
● UserView
HmiObjectHandle
Opcional. Valor o constante que define los derechos de usuario en runtime.
Consulte también
RTPersistenceType (RT Professional)
Descripción
Define cómo se conservarán las configuraciones online de WinCC.

VB Scripting
Acceso en runtime:
● RT Professional: Lectura
Sintaxis
Object.RTPersistenceType
Object
● AlarmControl
● SysDiagControl
● UserView
RTPersistenceType
Opcional. Valor o constante que define cómo se conservarán las configuraciones online de
WinCC.
Valor Explicación
0 Las configuraciones online se rechazan. Se perderán después del siguiente cambio de
imagen.
1 Las configuraciones online se conservarán durante el runtime. Se perderán al finalizar.
2 Las configuraciones online se conservarán permanentemente. Estarán disponibles también
después del reinicio.
RulerColor (RT Advanced)
Descripción
Define el color de la escala graduada (línea auxiliar) en la rotulación del eje.
Sintaxis
Object.RulerColor[=Color]

VB Scripting
Object
● TrendView
Color
Opcional. Valor o constante que determina el color de la gradación de la escala.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
RulerColumns (RT Professional)
Descripción
RulerType (RT Professional)
Descripción
Determina el modo de representación de la tabla de valores.
Sintaxis
Object.RulerType[=TrendRulerControlType]
Object

VB Scripting
TrendRulerControlType
Opcional. Valor o constante que determina el modo de representación de la tabla de valores.

0 Regla Determina que se muestre una ventana de regla. La ventana de regla muestra los
valores de coordenadas de las curvas en la regla o los valores de una línea seleccio‐
nada en la tabla.
1 Valores extremos Determina que se muestre la ventana del área de estadísticas. La ventana del área
de estadísticas muestra los valores de los límites inferior y superior de las curvas entre
dos reglas o del área seleccionada en la tabla.
2 Estadísticas Determina que se muestre una ventana de estadísticas. La ventana de estadísticas
muestra el análisis estadístico de la curva entre dos reglas o de los valores seleccio‐
nados en la tabla.
Consulte también
1.5.5.12 Propiedades S (Panels, Comfort Panels, RT Advanced, RT Professional)
S7Device (RT Advanced)
Descripción
ScaleColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de la escala.
Sintaxis
Object.ScaleColor[=Color]
Object
● Bar
● TrendView

VB Scripting
Color
Opcional. Valor o constante que determina el color de la escala.
Observaciones
Objeto "ScreenItem" con la característica "Bar": para que se muestre el color, la propiedad
"ShowScale" debe estar configurada con TRUE.
siguiente:
RGB (255, 0, 0)
vbGreen.
ScaleDenominator (Panels, Comfort Panels, RT Advanced)
Descripción
Define el contador para la escala en el cliente.
Sintaxis
Object.ScaleDenominator=[Int]
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "SmartClientView".
Int
Opcional. Valor o constante que determina el valor.
Consulte también
ScaleDenominator (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ScaleGradation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la distancia entre dos marcas grandes de la escala.
Sintaxis
Object.ScaleGradation[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que determina la distancia entre dos marcas grandes de la escala.
Consulte también
Bar (Página 261)
ScaleLabelColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de rotulación en la gradación de la escala del objeto "Gauge".
Sintaxis
Object.ScaleLabelColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color de la rotulación en la gradación de la escala.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)
ScaleLabelFieldLength (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ScaleLabelFont (RT Professional)
Descripción
Define la fuente de la rotulación de la escala.
Sintaxis
Object.ScaleLabelFont[=Font]
Object
● Gauge
Font
Opcional. Valor o constante que define la fuente de la rotulación de la escala.
ScaleLabelingDoubleLined (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ScaleNumerator (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ScalePosition (RT Professional)
Descripción
Determina la posición de la escala.
Ajuste además "ShowScale" a "TRUE".
Acceso en runtime:
Sintaxis
Object.ScalePosition[=ScalePosition]
Object
● Bar
● Slider
ScalePosition
Opcional. Valor o constante que define la posición de la escala.

0 hmiScalePositionLeftUp Para una barra vertical, la escala se muestra arriba. Para una barra horizontal la
escala se muestra a la izquierda.
1 hmiScalePositionRightDown Para una barra vertical, la escala se muestra abajo. Para una barra horizontal la
escala se muestra a la derecha.
ScaleStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ScaleTickColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la gradación de la escala del objeto "Gauge".
Sintaxis
Object.ScaleTickColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color de la gradación de la escala.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
ScaleTickLabelPosition (RT Professional)
Descripción
Determina el diámetro del círculo imaginario en el que se encuentra la rotulación de la división
de la escala.
Sintaxis
Object.ScaleTickLabelPosition[=DOUBLE]
Object
● Gauge

VB Scripting
DOUBLE
Opcional. Un valor o una constante que determina el diámetro del círculo imaginario en el que
se encuentra la rotulación de la división de la escala.
Rango de valores de 0 a 1
0: la rotulación se encuentra en el centro del cuadrante.
1: el diámetro del círculo imaginario para la rotulación es el valor menor de las propiedades
de geometría "Width" y "Height". Por tanto, una parte de la rotulación puede encontrarse fuera
de la delimitación del objeto y, en consecuencia, ser invisible.
Consulte también
Gauge (Página 324)
ScaleTickLength (RT Professional)
Descripción
Determina la anchura de las divisiones principales de la escala. El valor remite a la mitad del
valor inferior de las propiedades geométricas "Width" y "Height".
La anchura de las marcas para la graduación precisa es 0,5 * ancho de escala.
Sintaxis
Object.ScaleTickLength[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Valor o constante que determina la anchura de las divisiones principales de la escala.
Rango de valores de 0 al fondo de escala.
0: No existe ninguna graduación de la escala. Tampoco es visible la división de la escala en
rangos.
Fondo de escala: la graduación de la escala va desde el punto central del cuadrante hasta el
fondo de escala establecido.
Consulte también
Gauge (Página 324)

VB Scripting
ScaleTickPosition (RT Professional)
Descripción
Determina el diámetro del círculo imaginario en el que se encuentra la división de la escala.
Las marcas principales de la división de la escala se encuentran en este círculo con sus
extremos orientados hacia fuera.
Sintaxis
Object.ScaleTickPosition[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina el diámetro del círculo imaginario en el que
se encuentra la división de la escala.
Rango de valores de 0 a 1
0: la división de la escala se encuentra en el centro del cuadrante.
1: el diámetro del círculo imaginario para la división de la escala es el valor menor de las
propiedades de geometría "Width" y "Height".
Consulte también
Gauge (Página 324)
Scaling (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ScalingType (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el tipo de escala de barras.
Ajuste además "ShowScale" a "TRUE".

VB Scripting
Sintaxis
Object.ScalingType[=BarScalingType]
Object
● Bar
BarScalingType
Opcional. Valor o constante que establece el tipo de escala de barras.
Valor Constante VB Descripción Explicación

0 hmiBarScalingLinear Lineal Las marcas grandes están distribuidas uniformemente por la es‐
cala. La distancia entre las marcas grandes corresponde al valor
de "LargeTicksSize".
1 hmiBarScalingLogarithmic Logarítmico La distribución de las marcas grandes en la escala responde a
una función logarítmica.
Se acentúa considerablemente la representación de los valores
bajos.
2 hmiBarScalingNegativeLoga‐ Logarítmico ne‐ La distribución de las marcas grandes en la escala responde a
rithmic gativo una función logarítmica negativa. Se acentúa considerablemente
la representación de los valores altos.
3 hmiBarScalingAutomatic Automático Las marcas grandes están distribuidas uniformemente por la es‐
cala. La distancia entre las marcas grandes se establece auto‐
máticamente.
4 hmiBarScalingTangent Tangente La distribución de las marcas grandes en la escala acentúa la
representación de los valores bajos y altos.
5 hmiBarScalingQuadratic Cuadrático La distribución de las marcas grandes en la escala responde a
una función cuadrática. Se acentúa la representación de los va‐
lores altos.
6 hmiBarScalingCubic Cúbico La distribución de las marcas grandes en la escala responde a
una función cúbica. Esto hace que se acentúe la representación
de los valores altos.
Consulte también
Bar (Página 261)
ScreenItems (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la lista de ScreenItems.
Sintaxis
Object.ScreenItems

VB Scripting
Object
Obligatorio. Objeto del tipo "ScreenItems"..
Consulte también
ScreenItems (lista) (Página 222)
ScreenName (RT Professional)
Descripción
Determina la imagen que se muestra en la ventana de imagen en runtime.
Sintaxis
Object.ScreenName[=HmiObjectHandle]
Object
● ScreenWindow
HmiObjectHandle
Opcional. Valor o constante que determina la imagen que se muestra en la ventana de imagen
en runtime.
Consulte también
Screens (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la lista de Screens. La lista de Screens contiene dos elementos, a saber: El primer
elemento (índice 0) representa el área permanente. El segundo elemento (índice 1) representa
la imagen raíz. Estos dos elementos se pueden direccionar también a través de sus nombres.
Utilice "Overview" para el área permanente y "Base" para la imagen raíz.
Nota
La ventana de avisos y el indicador de avisos no están contenidos en la lista Screens, aunque
estén marcados en runtime.

VB Scripting
Sintaxis
Object.Screens
Object
Necesario. Objeto del tipo "Screens".
Consulte también
Screens (lista) (Página 224)
ScreenScaleMode (RT Professional)
Descripción
Define el modo de escala de la imagen visualizada.
Sintaxis
Object.ScreenScaleMode[=ScreenScaleModeType]
Object
● ScreenWindow
ScreenScaleModeType
Opcional. Valor o constante que determina el modo de escala de la imagen mostrada.
ScrollBarOrientation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
SecondGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
SecondGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
SecondNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la longitud del segundero.
Sintaxis
Object.SecondNeedleHeight[=Int32]
Object
● Clock
Int32
Opcional. Valor o constante que determina la longitud del segundero.
Indique la longitud del segundero en tantos por ciento, en relación al radio de la esfera.
Consulte también
Clock (Página 290)
SecondNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el ancho del segundero.
Sintaxis
Object.SecondNeedleWidth[=Int32]
Object
● Clock

VB Scripting
Int32
Opcional. Valor o constante que determina el ancho del segundero. Indique el ancho en tantos
por ciento, en relación a la longitud doble del segundero.
Consulte también
Clock (Página 290)
SecurityForSimpleViewEnabled (RT Advanced)
Descripción
SegmentColoring (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el tipo de cambio de color con el que se indicará el rebase por exceso de valores límite.
Sintaxis
Object.SegmentColoring[=THmiBarColorType]
Object
● Bar
THmiBarColorType
Opcional. Valor o constante que determina el tipo de cambio de color. Rango de valores de
0 a 1.

0 hmiBarColorEntire El color se cambia en toda la barra.
1 hmiBarColorSegmented El color se cambia por segmentos.
Consulte también
Bar (Página 261)

VB Scripting
SelectArchiveName (RT Professional)
Descripción
Determina que en runtime se muestre primero el cuadro de diálogo de selección para el origen
de los datos del visor de recetas.
Sintaxis
Object.SelectArchiveName[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra en la imagen el cuadro de diálogo de selección para el origen de los datos
del visor de recetas.
FALSE si no aparece en la imagen ningún cuadro de diálogo de selección para el origen de
los datos del visor de recetas.
Consulte también
SelectBackColor (RT Professional)
Descripción
Define el color de fondo de la entrada de texto seleccionada.
Sintaxis
Object.SelectBackColor[=Color]
Object
● SymbolicIOField

VB Scripting
Color
Opcional. Valor o constante que define el color de fondo de la entrada de texto seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectedCellColor (RT Professional)
Descripción
Define el color de fondo de la celda seleccionada.
Sintaxis
Object.SelectedCellColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color de fondo.
Observaciones
siguiente:

VB Scripting
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectedCellForeColor (RT Professional)
Descripción
Define el color de fuente de la celda seleccionada.
Sintaxis
Object.SelectedCellForeColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color de fuente.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
SelectedID (RT Professional)
Descripción
Devuelve la ID del registro seleccionado en el visor de recetas.
Sintaxis
Object.SelectedID[=Int32]
Object
Int32
Opcional. Valor o constante que devuelve la ID del registro seleccionado.
Valor Explicación
0 No se ha seleccionado ningún registro válido, p. ej., en caso de error de conexión.
-1 Se ha seleccionado la línea de edición.
Consulte también
SelectedIndex (RT Professional)
Descripción
Define el índice cuyo texto correspondiente se muestra resaltado en el cuadro combinado o
el cuadro de lista.
El valor máximo es el número de líneas (NumberLines) del objeto.

VB Scripting
Sintaxis
Object.SelectedIndex[=Int32]
Object
● ComboBox
● ListBox
Int32
Opcional. Valor o constante que determina el índice del texto resaltado.
Consulte también
SelectedRowColor (RT Professional)
Descripción
Define el color de fondo de la fila seleccionada.
Sintaxis
Object.SelectedRowColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color de fondo.
Observaciones
siguiente:

VB Scripting
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectedRowForeColor (RT Professional)
Descripción
Define el color de fuente de la fila seleccionada.
Sintaxis
Object.SelectedRowForeColor[=Color]
Object
● AlarmControl
Color
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
SelectedText (RT Professional)
Descripción
Define el texto para la entrada referenciada mediante "SelectedIndex".
Sintaxis
Object.SelectedText[=STRING]
Object
● ComboBox
● ListBox
STRING
Opcional. Valor o constante que define el texto de una entrada.
Consulte también
SelectedTitleColor (RT Professional)
Descripción
Define el color de fondo del título de tabla seleccionado.
Ajuste además "UseSelectedTitleColor" a "TRUE".
Sintaxis
Object.SelectedTitleColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el fondo.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectedTitleForeColor (RT Professional)
Descripción
Define el color de fuente del título de tabla seleccionado.
Ajuste además "UseSelectedTitleColor" a "TRUE".
Sintaxis
Object.SelectedTitleForeColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectForeColor (RT Professional)
Descripción
Define el color de la entrada de texto seleccionada.
Sintaxis
Object.SelectForeColor[=Color]
Object
● SymbolicIOField

VB Scripting
Color
Opcional. Valor o constante que define el color de la entrada de texto seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectionBackColor (RT Advanced)
Descripción
Determina el color de fondo de las celdas seleccionadas.
Sintaxis
Object.SelectionBackColor[=Color]
Object
Necesario. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmView
● RecipeView*
● StatusForce
● UserView
● TrendView
Color
Opcional. Valor o constante que determina el color de fondo de la fila seleccionada.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
SelectionColoring (RT Professional)
Descripción
Define si se utilizarán colores de selección para celdas o filas.
Sintaxis
Object.SelectionColoring[=GridSelectionColoring]
Object
● AlarmControl
GridSelectionColoring
Opcional. Valor o constante que determina si se utilizarán colores de selección para celdas o
filas.

0 Ninguno Ningún color de selección para celda y fila.
1 Celda Color de selección para celdas.
2 Fila Color de selección para filas.
3 Celda y fila Color de selección para celda y fila.
Consulte también

VB Scripting
SelectionForeColor (RT Advanced)
Descripción
Determina el color de primer plano de las celdas seleccionadas.
Sintaxis
Object.SelectionForeColor[=Color]
Object
● AlarmView
● RecipeView*
● StatusForce
● UserView
● TrendView
Color
Opcional. Valor o constante que determina el color de fondo de la fila seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
SelectionRect (RT Professional)
Descripción
Define si se utilizará un borde de selección para las celdas o filas seleccionadas.

VB Scripting
Sintaxis
Object.SelectionRect[=GridSelectionBorder]
Object
● AlarmControl
GridSelectionBorder
Opcional. Valor o constante que define si se utilizará un borde de selección para las celdas o
filas seleccionadas.

0 Ninguno No se utilizará el borde de selección para las celdas y filas selecciona‐
das.
1 Celda Se utilizará el borde de selección para las celdas seleccionadas.
2 Fila Se utilizará el borde de selección para las filas seleccionadas.
Consulte también
SelectionRectColor (RT Professional)
Descripción
Define el color del rectángulo de selección en la ventana de avisos.
Ajuste también "SelectionType" a "1" o "2".
Sintaxis
Object.SelectionRectColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
SelectionRectWidth (RT Professional)
Descripción
Establece el grosor de la línea del rectángulo de selección en la ventana de avisos cuando
SelectionType sea "1".
Sintaxis
Object.SelectionRectWidth[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el grosor de la línea.
Consulte también
SelectionType (RT Professional)
Descripción
Determina cuántas líneas pueden seleccionarse.
Sintaxis
Object.SelectionType[=GridSelectionType]
Object
● AlarmControl
GridSelectionType
Opcional. Valor o constante que establece el número de líneas que pueden seleccionarse.

VB Scripting

0 Ninguno No se selecciona ninguna línea.
1 Selección individual Puede seleccionarse una línea.
2 Selección múltiple Pueden seleccionarse varias líneas.
Consulte también
SeparateLineForAlarmText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
SeparatorBackColor (RT Professional)
Descripción
Define el color de fondo de las líneas de separación discontinuas en la lista de selección.
Sintaxis
Object.SeparatorBackColor[=Color]
Object
● SymbolicIOField
Color
Opcional. Valor o constante que define el color de fondo de las líneas de separación
discontinuas en la lista de selección.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
SeparatorColor (RT Professional)
Descripción
Define el color de los separadores en la lista de selección.
Sintaxis
Object.SeparatorColor[=Color]
Object
● S7GraphOverview
Color
Opcional. Valor o constante que determina el color de las líneas de separación en la lista de
selección.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
SeparatorCornerStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la forma de las esquinas de la línea de separación.
Sintaxis
Object.SeparatorCornerStyle[=CornerStyle]
Object
● SymbolicIOField
CornerStyle
Opcional. Valor o constante que devuelve la forma de las esquinas de la línea de separación.
Valor Explicación
0 Línea continua
2 Línea de puntos
SeparatorLineEndShapeStyle (RT Professional)
Descripción
Devuelve la forma de los finales de la línea de separación.
Sintaxis
Object.SeparatorLineEndShapeStyle[=LineEndShapeStyle]
Object
● SymbolicIOField

VB Scripting
LineEndShapeStyle
Opcional. Valor o constante que devuelve la forma de los finales del separador.
Valor Nombre
-1 Justificado
0 Redondo
1 Cuadrado
SeparatorStyle (RT Professional)
Descripción
Define el tipo de línea de los separadores en la lista de selección.
Sintaxis
Object.SeparatorStyle[=LineStyle]
Object
● SymbolicIOField
LineStyle
Opcional. Valor o constante que define el tipo de línea de las líneas de separación en la lista
de selección.

-1 hmiLineStyleNone La lista de selección no tiene líneas de separación.
0 hmiLineStyleSolid La lista de selección tiene líneas de separación continuas.
1 hmiLineStyleDash La lista de selección tiene líneas de separación disconti‐
nuas.
2 hmiLineStyleDot La lista de selección tiene líneas de separación punteadas.
3 hmiLineStyleDashDot La lista de selección tiene líneas de separación punto raya.
4 hmiLineStyleDashDotDot La lista de selección tiene líneas de separación punto punto
raya.
SeparatorWidth (RT Professional)
Descripción
Define el ancho de las líneas de separación de la lista de selección.

VB Scripting
Sintaxis
Object.SeparatorWidth[=Int32]
Object
● SymbolicIOField
Int32
Opcional. Valor o constante que determina el ancho de las líneas de separación en la lista de
selección.
Consulte también
ServerNames (RT Professional)
Descripción
Define los servidores de un sistema distribuido de los que el objeto recibe datos. Se indica de
esta forma: NameServer1;NameServer2;NameServer3.
Sintaxis
Object.ServerNames[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina los servidores de un sistema distribuido de los que
el objeto recibe datos.
Consulte también

VB Scripting
ServerPrefix (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el servidor en el que se encuentra la imagen que se mostrará en la ventana de imagen
en runtime, o devuelve el nombre del servidor.
Indique el nombre del servidor seguido dos veces de doble punto: "<Nombre del servidor>::".
No se comprueba si el servidor existe de verdad.
Sintaxis
Object.ServerPrefix[=String]
Object
● ScreenWindow
String
Opcional. Valor o constante que define el nombre del servidor.
ServerScale (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
SetOfVisibleColumns (RT Advanced)
Descripción
Shared (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ShareSpaceWithSourceControl (RT Professional)
Descripción
Define que el rango de representación del origen de los datos se adapte al tamaño de la tabla
de valores.
Sintaxis
Object.ShareSpaceWithSourceControl[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el tamaño de la fuente de datos se adapta al tamaño de la tabla de valores.
FALSE si el tamaño del origen de los datos no se adapta al tamaño de la tabla de valores.
Consulte también
ShiftDecimalPoint (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowAcknowledgeButton (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowAlarmsFromDate (RT Advanced)
Descripción
Establece que solo se muestren los eventos de aviso que estén guardados en esa variable.

VB Scripting
Sintaxis
Object.ShowAlarmsFromDate[=HmiObjectHandle]
Object
● AlarmView
HmiObjectHandle
Opcional. Valor o constante que establece que solo se muestren los eventos de aviso que
estén guardados en esa variable.
Consulte también
ShowAlarmsToAcknowledge (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowBadTagState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el objeto se mostrará atenuado cuando el QualityCode o el estado de la variable no
sea bueno.
Sintaxis
Object.ShowBadTagState[=BOOLEAN]
Object
● Bar
● CheckBox
● IOField
● OptionGroup

VB Scripting
● WindowSlider *
BOOLEAN
Opcional.
TRUE si con un QualityCode o un estado de variable malo, el objeto se muestra atenuado o
se utilizan los ajustes correspondientes al color de cuadrícula.
ShowBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el valor de proceso visualizado se muestra adicionalmente con una barra rellena.
Sintaxis
Object.ShowBar[=BOOLEAN]
Object
● Slider
BOOLEAN
Opcional. TRUE si el valor de proceso debe mostrarse adicionalmente con una barra rellena.
Consulte también
ShowCaption (RT Professional)
Descripción
Define si se muestra la barra de título.
Acceso en runtime:
Sintaxis
Object.ShowCaption[=BOOLEAN]

VB Scripting
Object
● ScreenWindow
● Switch
BOOLEAN
Opcional. TRUE si se muestra la barra de título.
ShowColumnHeaders (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowControls (RT Professional)
Descripción
Determina que se muestre una barra de herramientas.
Acceso en runtime:
Sintaxis
Object.ShowControls[=BOOLEAN]
Object
● MediaPlayer
● SmartClientView
BOOLEAN
Opcional.
TRUE si se muestra una barra de herramientas.
FALS E si no se muestra una barra de herramientas.

VB Scripting
ShowDate (RT Advanced)
Descripción
ShowDecimalPoint (RT Professional)
Descripción
Determina si la escala con números decimales (punto decimal y un decimal) se rotula con
números enteros.
Sintaxis
Object.ShowDecimalPoint[=BOOLEAN]
Object
● Gauge
BOOLEAN
Opcional. TRUE si la escala con números decimales (punto decimal y un decimal) se rotula.
Consulte también
Gauge (Página 324)
ShowDropDownButton (RT Professional)
Descripción
Define si se mostrará un botón para la lista de selección.
Sintaxis
Object.ShowDropDownButton[=BOOLEAN]
Object
● SymbolicIOField

VB Scripting
BOOLEAN
Opcional.
TRUE si se muestra un botón para la lista de selección.
FALSE si no se muestra ningún botón para la lista de selección.
Consulte también
ShowDropDownList (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowFeatureBackward (RT Professional)
Descripción
Define que se muestre el botón "Atrás" en runtime.
Sintaxis
Object.ShowFeatureBackward[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra el botón "Atrás".
FALSE si no se muestra ningún botón "Atrás".
Consulte también

VB Scripting
ShowFeatureForward (RT Professional)
Descripción
Define que se muestre el botón "Adelante" en runtime.
Sintaxis
Object.ShowFeatureForward[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra el botón "Adelante".
FALSE si no se muestra ningún botón "Adelante".
Consulte también
ShowFeatureFullScreen (RT Professional)
Descripción
Define que el Media Player pueda cambiarse al modo de pantalla completa.
Sintaxis
Object.ShowFeatureFullScreen[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra el botón "Pantalla completa" en la barra de herramientas del Media Player.

VB Scripting
FALSE si no se muestra el botón "Pantalla completa" en la barra de herramientas del Media

Player.
Consulte también
ShowFeatureFullVolume (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowFeaturePause (RT Professional)
Descripción
Determina que se muestre el botón "Pausa" en runtime.
Sintaxis
Object.ShowFeaturePause[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra el botón "Pausa" en runtime.
FALSE si no se muestra el botón "Pausa" en runtime.
Consulte también
ShowFeaturePlay (RT Professional)
Descripción
Determina que se muestre el botón "Reproducción" en runtime.

VB Scripting
Sintaxis
Object.ShowFeaturePlay[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra el botón "Reproducción" en runtime.
FALSE si no se muestra el botón "Reproducción" en runtime.
Consulte también
ShowFeatureStop (RT Professional)
Descripción
Determina que se muestre el botón "Parada" en runtime.
Sintaxis
Object.ShowFeatureStop[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra el botón "Parada" en runtime.
FALSE si no se muestra el botón "Parada" en runtime.
Consulte también

VB Scripting
ShowFillLevel (RT Professional)
Descripción
Define si se rellenará el objeto indicado.
Sintaxis
Object.ShowFillLevel[=BOOLEAN]
Object
● Button
● CheckBox
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton*
● TextField
● WindowsSlider*
BOOLEAN
Opcional. TRUE si el objeto indicado se rellena.
ShowFocusRectangle (RT Professional)
Descripción
Determina si el botón tendrá un borde de selección en runtime cuando se active.
Sintaxis
Object.ShowFocusRectangle[=BOOLEAN]

VB Scripting
Object
● Clock
BOOLEAN
Opcional. TRUE si en runtime el botón recibe un borde de selección cuando se activa.
Consulte también
Clock (Página 290)
ShowHelpButton (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowHorizontalGridlines (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowInnerDial (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowLargeTicksOnly (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si han de representarse solo las marcas grandes de la escala.
Sintaxis
Object.ShowLargeTicksOnly[=BOOLEAN]
Object
● Bar

VB Scripting
BOOLEAN
Opcional. TRUE si se representan solo las marcas grandes de la escala.
Consulte también
Bar (Página 261)
ShowLeadingZeros (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowLimitLines (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowLimitRanges (RT Professional)
Descripción
ShowLimitMarkers (RT Professional)
Descripción
Determina si los valores límite se mostrarán como valores de escala.
Acceso en runtime:
Sintaxis
Object.ShowLimitMarkers[=BOOLEAN]
Object
● Bar

VB Scripting

● Slider
BOOLEAN
Opcional. TRUE si los valores límite se muestran como valor de escala.
ShowLoopInAlarmButton (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowMilliseconds (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowNavigationButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowPathInformation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowPeakValuePointer (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si para el objeto indicado se utiliza una aguja de máximo/mínimo.
La aguja de máximo/mínimo indica en runtime la desviación de agua máxima mientras está
cargado el sinóptico del proceso. Si se recarga el sinóptico del proceso se resetea la aguja
de máximo/mínimo.

VB Scripting
Sintaxis
Object.ShowPeakValuePointer[=BOOLEAN]
Object
● Gauge
BOOLEAN
Opcional. TRUE si se utiliza la aguja de máximo/mínimo.
Consulte también
Gauge (Página 324)
ShowPendingAlarms (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowPosition (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el valor de la posición actual del regulador debe mostrarse adicionalmente en
formato numérico. En este caso, el valor se visualizará debajo del regulador.
Sintaxis
Object.ShowPosition[=BOOLEAN]
Object
● Slider
BOOLEAN
Opcional. TRUE si el valor debe mostrarse adicionalmente en formato numérico.
Consulte también

VB Scripting
ShowProcessValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowReadButton (RT Advanced)
Descripción
ShowRuler (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se muestra una escala graduada (línea auxiliar) para la rotulación de eje del
objeto.
Sintaxis
Object.ShowRuler[=BOOLEAN]
Object
● TrendView
BOOLEAN
Opcional. TRUE si se muestra la escala graduada.
ShowRulerInAxis (RT Professional)
Descripción
Define si la regla se mostrará también en el eje de tiempos.
Sintaxis
Object.ShowRulerInAxis[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si las reglas se muestran también en los ejes de tiempo.
FALSE si las reglas no se muestran en los ejes de tiempo.
Consulte también
ShowScale (RT Professional)
Descripción
Determina si los valores se mostrarán adicionalmente en una escala.
Acceso en runtime:
Sintaxis
Object.ShowScale[=BOOLEAN]
Object
● Bar
● Slider
BOOLEAN
Opcional. TRUE si los valores se muestran adicionalmente en una escala.

VB Scripting
ShowScrollBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowScrollbars (RT Professional)
Descripción
Define si se muestran las barras de desplazamiento.
Sintaxis
Object.ShowScrollbars[=BOOLEAN]
Object
● ScreenWindow
BOOLEAN
Opcional. TRUE si se muestran las barras de desplazamiento.
ShowSignForPositiveLabel (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowSortButton (RT Professional)
Descripción
Define si se mostrará la tecla de clasificación en la barra de desplazamiento. Mediante la tecla
de clasificación podrá clasificar mediante un clic del ratón la columna seleccionada en la
secuencia de clasificación configurada. Si en la tabla no hay ninguna barra de desplazamiento,
no se mostrará la tecla de clasificación.

VB Scripting
Sintaxis
Object.ShowSortButton[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza la tecla de clasificación. Puede clasificar la columna seleccionada.
Consulte también
ShowSortIcon (RT Professional)
Descripción
Define si se mostrará el símbolo de clasificación.
Sintaxis
Object.ShowSortIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.

VB Scripting
TRUE si se visualiza el símbolo de clasificación.

FALSE si no se visualiza el símbolo de clasificación.
Consulte también
ShowSortIndex (RT Professional)
Descripción
Determina si se mostrará un índice de clasificación.
Sintaxis
Object.ShowSortIndex[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza un índice de clasificación.
FALSE si no se visualiza un índice de clasificación.
Consulte también

VB Scripting
ShowSplittedView (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowStatisticRuler (RT Professional)
Descripción
Determina si se muestran las líneas que definen el área de estadísticas.
Sintaxis
Object.ShowStatisticRuler[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran las líneas del área de estadísticas.
FALSE si no se muestran las líneas del área de estadísticas.
Consulte también
ShowStatusBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se muestra la barra de estado.
Acceso en runtime:
Sintaxis
Object.ShowStatusBar[=BOOLEAN]

VB Scripting
Object
● HTMLBrowser
● MediaPlayer
BOOLEAN
Opcional. TRUE si se muestra la barra de estado.
ShowTableGridlines (RT Advanced)
Descripción
Define si en la tabla se mostrarán líneas de cuadrícula.
Acceso en runtime:
Sintaxis
Object.ShowTableGridlines[=BOOLEAN]
Object
● StatusForce
● TrendView
● UserView
BOOLEAN
TRUE si se muestran líneas de retícula en la tabla.
ShowThumb (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse el deslizador del objeto "Slider".
Acceso en runtime:
● RT Advanced: lectura y escritura

VB Scripting
Sintaxis
Object.ShowThumb[=BOOLEAN]
Object
● Slider
BOOLEAN
Opcional. TRUE si debe mostrarse el deslizador.
Consulte también
ShowTickLabels (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse la rotulación en la escala.
Acceso en runtime:
● RT Profession al: Lectura
Sintaxis
Object.ShowTickLabels[=BOOLEAN]
Object
● Slider
● Bar
BOOLEAN
Opcional. TRUE si se visualiza la rotulación.
Observaciones
El incremento de los valores de medida se determina automáticamente en función del rango
de medición indicado y del tamaño del objeto.

VB Scripting
ShowTicks (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si deben mostrarse las marcas en la escala.
Sintaxis
Object.ShowTicks[=BOOLEAN]
Object
● Clock
● Slider*
* RT Professional: Solo acceso de lectura
BOOLEAN
Opcional. TRUE si se muestran las marcas.
Consulte también
Clock (Página 290)
ShowTime (RT Advanced)
Descripción
ShowTimeAxis (RT Advanced)
Descripción
ShowTimeAxisLabeling (RT Advanced)
Descripción

VB Scripting
ShowTitle (RT Professional)
Descripción
Define el estilo del marco de la ventana y el título de la ventana para el objeto.
Sintaxis
Object.ShowTitle[=WindowHeaderStyle]
Object
● AlarmControl
WindowHeaderStyle
Opcional. Valor o constante que determina el estilo del marco de la ventana del objeto.
Valor Explicación
0 No se visualizan ni marcos de ventana ni títulos.
1 Se visualiza un marco de ventana estrecho con título.
2 Se visualiza un marco de ventana estándar con título.
Consulte también
ShowToolBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ShowToolbarBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ShowTracker (RT Professional)
Descripción
Determina que se muestre la barra de tiempo.
Sintaxis
Object.ShowTracker[=BOOLEAN]
Object
● MediaPlayer
BOOLEAN
Opcional.
TRUE si se muestra la barra de tiempo.
FALSE si no se muestra la barra de tiempo.
Consulte también
ShowTrendIcon (RT Professional)
Descripción
Determina si debajo de los ejes de valores se mostrará un símbolo. El símbolo muestra qué
curva se mostrará en primer plano.
Sintaxis
Object.ShowTrendIcon[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si se visualiza el símbolo.
FALSE si no se visualiza el símbolo.
Consulte también
ShowTrendIndicator (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si la tendencia (ascendente o descendente) del valor medido que debe
supervisarse se muestra con una pequeña flecha.
Sintaxis
Object.ShowTrendIndicator[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si la tendencia (ascendente o descendente) del valor medido que debe
supervisarse se muestra con una pequeña flecha.
Consulte también
Bar (Página 261)

VB Scripting
ShowValueAxis1 (RT Advanced)
Descripción
ShowValueAxis1Label (RT Advanced)
Descripción
ShowValueAxis2 (RT Advanced)
Descripción
ShowValueAxis2Label (RT Advanced)
Descripción
ShowValueTable (RT Advanced)
Descripción
ShowWriteButton (RT Advanced)
Descripción
ShowY1HlpLine (RT Advanced)
Descripción

VB Scripting
ShowY2HlpLine (RT Advanced)
Descripción
SimpleView (RT Advanced)
Descripción
SimpleViewToolbar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Size (RT Professional)
Descripción
Sizeable (RT Professional)
Descripción
Determina si puede modificarse el tamaño del objeto en runtime.
Sintaxis
Object.Sizeable[=BOOLEAN]
Object
● AlarmControl

VB Scripting
Sizable
Opcional. Valor o constante que determina si puede modificarse el tamaño del objeto.
Consulte también
SmartTags (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la lista de SmartTags.
Sintaxis
Object.SmartTags
Object
Consulte también
SortByTimeDirection (RT Advanced)
Descripción
Define si el último aviso entrante se muestra arriba (orden de clasificación ascendente).
Sintaxis
Object.SortByTimeDirection[=SortByTimeDirection]

VB Scripting
Object
Necesario. Objeto del tipo "ScreenItems" con las características siguientes:
● AlarmView
SortByTimeDirection
Opcional. Valor o constante que determina la secuencia de clasificación en el objeto.

0 Descendente El último aviso aparecido se muestra arriba.
1 Ascendente El último aviso aparecido se muestra abajo.
Consulte también
SortByTimeEnabled (RT Advanced)
Descripción
Define si puede modificarse la clasificación de los avisos según la hora.
Sintaxis
Object.SortByTimeEnabled[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItems" con las características siguientes:
● AlarmView
BOOLEAN
Opcional. TRUE si el operador puede modificar la clasificación en el dispositivo.
Consulte también
SortSequence (RT Professional)
Descripción
Define cómo se modificará el orden de clasificación cuando el operador haga clic en el título
de la columna en runtime.

VB Scripting
Sintaxis
Object.SortSequence[=GridSortSequence]
Object
● AlarmControl
GridSortSequence
Opcional. Valor o constante que determina cómo cambiará el orden de clasificación al hacer
clic con el ratón.

0 arriba/abajo/nin‐ Haciendo clic con el ratón se podrá cambiar entre clasificación ascenden‐
guno te, descendente y ninguna clasificación.
1 arriba/abajo Haciendo clic con el ratón se podrá cambiar entre clasificación ascenden‐
te, descendente.
SourceControl (RT Professional)
Descripción
Determina el visor de curvas o de tablas con el que está conectada la tabla de valores.
Sintaxis
Object.SourceControl[=HmiObjectHandle]
Object
HmiObjectHandle
Opcional. Valor o constante que determina el visor de curvas o de tablas que está conectado
con la tabla de valores.
Consulte también

VB Scripting
SourceControlType (RT Professional)
Descripción
Determina el tipo del origen de los datos.
Sintaxis
Object.SourceControlType[=TrendRulerControlSourceControlType]
Object
TrendRulerControlSourceControlType
Opcional. Valor o constante que determina el tipo del origen de los datos de la tabla de valores.

0 Ninguno No define ningún tipo para el origen de los datos de la tabla
de valores.
1 Visor de curvas f(t) Establece un visor de curvas f(t) como el origen de los datos
2 Visor de tablas Establece un visor de tablas como el origen de los datos
3 Visor de curvas f(x) Establece un visor de curvas f(x) como el origen de los datos
Consulte también
SplittedViewRatio (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
StartAngle (RT Professional)
Descripción
Define el ángulo en el que se desvía del origen (0°) el punto inicial.

VB Scripting
Sintaxis
Object.StartAngle[=Int32]
Object
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Opcional. Valor o constante que determina el ángulo en el que el punto inicial se desvía de la
posición cero (0°).
Consulte también
StartLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
StartStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define cómo se debe representar el comienzo de línea.
Sintaxis
Object.StartStyle[=LineEndStyle]

VB Scripting
Object
● Connector
● Line
● Polyline
LineEndStyle
Opcional. Valor o constante que determina el comienzo de línea. Rango de valores de 0 a 6.

0 hmiLineEndStyleNone La línea no posee ningún símbolo inicial.
1 hmiLineEndStyleArrow La línea comienza con una punta de flecha.
2 hmiLineEndStyleFilledArrow La línea comienza con una punta de flecha rellena.
3 hmiLineEndStyleFilledArrowReversed La línea comienza con una punta de flecha invertida.
4 hmiLineEndStyleLine La línea comienza con una línea vertical.
5 hmiLineEndStyleCircle La línea comienza con un círculo.
6 hmiLineEndStyleFilledCircle La línea comienza con un círculo relleno.
StartTop (RT Professional)
Descripción
StartValue (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el valor absoluto del punto cero de la visualización de la escala.
Sintaxis
Object.StartValue[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que define el valor absoluto del punto cero de la visualización de
la escala.

VB Scripting
Consulte también
Bar (Página 261)
State (RT Professional)
Descripción
Devuelve el estado de un aviso.
La siguiente tabla muestra los estados posibles de un aviso:
Estado Estado del aviso

1 Aparecido
2 Desaparecido
5 Aparecido y comentario
6 Desaparecido y comentario
StatisticAreaColumns (RT Professional)
Descripción
StatisticResultColumns (RT Professional)
Descripción
StatusbarBackColor (RT Professional)
Descripción
Define el color de fondo de la barra de estado.
Ajuste además "StatusbarUseBackColor" a "TRUE".
Sintaxis
Object.StatusbarBackColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de fondo de la barra de estado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
StatusbarElementAdd (RT Professional)
Descripción
Crea un nuevo elemento de la barra de estado definido por el usuario. El elemento recién
creado se referencia automáticamente mediante "StatusbarElementIndex".
Sintaxis
Object.StatusbarElementAdd[=STRING]

VB Scripting
Object
● AlarmControl
STRING
Necesario. Valor o constante que determina el nombre del nuevo elemento de usuario de la
barra de estado mediante "StatusbarElementName".
Consulte también
StatusbarElementIndex (Página 979)
StatusbarElementAutoSize (RT Professional)
Descripción
Define si el ancho de un elemento de la barra de estado referenciado mediante
"StatusbarElementIndex" se ajustará automáticamente.
Sintaxis
Object.StatusbarElementAutoSize[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si el ancho del elemento seleccionado se ajusta automáticamente.
FALSE si el ancho del elemento seleccionado no se ajusta automáticamente.
Consulte también
StatusbarElementCount (RT Professional)
Descripción
Define el número de elementos configurados de la barra de estado.
Sintaxis
Object.StatusbarElementCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina el número de elementos configurados de la barra
de estado.

VB Scripting
Consulte también
StatusbarElementIconId (RT Professional)
Descripción
Hace referencia a un elemento de la barra de estado mediante su ID de icono.
El referenciado de un elemento mediante su ID de icono no depende del orden real de los
elementos.
Sintaxis
Object.StatusbarElementIconId[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina mediante la ID de símbolo el elemento de la barra
de estado que va a editarse.
Consulte también

VB Scripting

StatusbarElementID (RT Professional)
Descripción
Hace referencia a un elemento de la barra de estado mediante su ID de elemento. Para
acceder a las propiedades de un elemento de la barra de estado, se debe activar
"StatusbarElementID".
El referenciado de un elemento mediante su ID de elemento no depende del orden real de los
elementos. Las ID de elemento aparecen listadas en la ventana de inspección del objeto
correspondiente en "Propiedades > Propiedades > Barra de estado > Barra de estado -
Elementos".
Sintaxis
Object.StatusbarElementID[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina mediante la ID de elemento el elemento de la barra
de estado que va a editarse.
Consulte también

VB Scripting
StatusbarElementIndex (RT Professional)
Descripción
Hace referencia a un elemento de la barra de estado. Para acceder a las propiedades de un
elemento de la barra de estado, se debe activar "StatusbarElementIndex".
Los valores válidos para "StatusbarElementIndex" se encuentran entre 0 y
"StatusbarElementCount" menos 1. La propiedad "StatusbarElementCount" indica el número
de elementos configurados de la barra de estado.
Sintaxis
Object.StatusbarElementIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina a través del índice el elemento de la barra de
estado que va a editarse.
Consulte también
StatusbarElementCount (Página 974)

VB Scripting
StatusbarElementName (RT Professional)
Descripción
Define el nombre de un elemento de la barra de estado referenciado mediante
"StatusbarElementIndex".
Sintaxis
Object.StatusbarElementName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el nombre del elemento referenciado de la barra
de estado.
Consulte también
StatusbarElementRemove (RT Professional)
Descripción
Elimina el elemento de la barra de estado definido por el usuario y referenciado mediante su
nombre.

VB Scripting
Sintaxis
Object.StatusbarElementRemove[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el nombre del elemento de usuario referenciado
de la barra de estado que se borrará.
Consulte también
StatusbarElementRename (RT Professional)
Descripción
Define el nuevo nombre de un elemento de la barra de estado definido por el usuario y
referenciado mediante "StatusbarElementIndex".
Sintaxis
Object.StatusbarElementRename[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Opcional. Valor o constante que define el nuevo nombre del elemento de usuario seleccionado
de la barra de estado.
Consulte también
StatusbarElementRepos (RT Professional)
Descripción
Define la posición de un elemento referenciado mediante "StatusbarElementIndex" en la barra
de estado del objeto.
Si ha modificado la posición del elemento con "StatusbarElementRepos", a
"StatusbarElementIndex" se le asignará el valor de "StatusbarElementRepos".
Sintaxis
Object.StatusbarElementRepos[=Int32]
Object
● AlarmControl

VB Scripting
Int32
Opcional. Valor o constante que determina la posición del elemento referenciado en la barra
de estado. Rango de valores de 0 a "StatusbarElementCount" menos 1. Los valores fuera de
este rango de valores no tienen ningún efecto.
0: El elemento referenciado se posiciona a la izquierda.
Consulte también
StatusbarElementCount (Página 974)
StatusbarElements (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
StatusbarElementText (RT Professional)
Descripción
Define el texto de un elemento de la barra de estado definido por el usuario y referenciado
mediante "StatusbarElementIndex".
Sintaxis
Object.StatusbarElementText[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Opcional. Valor o constante que determina el texto del elemento seleccionado de la barra de
estado.
Consulte también
StatusbarElementTooltipText (RT Professional)
Descripción
Define el texto del tooltip de un elemento de la barra de estado definido por el usuario y
referenciado mediante "StatusbarElementIndex".
Sintaxis
Object.StatusbarElementTooltipText[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el texto para el tooltip del elemento definido por el
usuario seleccionado en la barra de estado.

VB Scripting
Consulte también
StatusbarElementUserDefined (RT Professional)
Descripción
Define si un elemento de la barra de estado referenciado mediante "StatusbarElementIndex"
ha sido agregado por el ingeniero como nuevo elemento definido por el usuario.
Sintaxis
Object.StatusbarElementUserDefined[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si el elemento de la barra de estado ha sido definido por el usuario.
FALSE si el elemento de la barra de estado está predefinido por el sistema.
Consulte también

VB Scripting

StatusbarElementVisible (RT Professional)
Descripción
Define si el elemento de la barra de estado referenciado mediante "StatusbarElementIndex"
se mostrará en el objeto.
Sintaxis
Object.StatusbarElementVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si se muestra el elemento referenciado de la barra de estado.
Consulte también

VB Scripting
StatusbarElementWidth (RT Professional)
Descripción
Define el ancho de un elemento de la barra de estado referenciado mediante
"StatusbarElementIndex" en píxeles.
Ajuste además "StatusbarElementAutoSize (Página 973)" a "FALSE".
Sintaxis
Object.StatusbarElementWidth[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina el ancho en píxeles del elemento referenciado de
la barra de estado.
Consulte también
StatusbarFont (RT Professional)
Descripción
Define la fuente de los textos de la barra de estado.

VB Scripting
Sintaxis
Object.StatusbarFont[=Font]
Object
● AlarmControl
Font
Opcional. Valor o constante que define la fuente de los textos de la barra de estado.
Consulte también
StatusbarFontColor (RT Professional)
Descripción
Define el color de fuente de los textos de la barra de estado.
Sintaxis
Object.StatusbarFontColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que define el color de los textos de la barra de estado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
StatusbarShowTooltips (RT Professional)
Descripción
Define si en runtime se mostrarán los tooltips de los elementos de la barra de estado.
Sintaxis
Object.StatusbarShowTooltips[=BOOLEAN]

VB Scripting
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si deben mostrarse los tooltips.
FALSE si no deben mostrarse los tooltips.
Consulte también
StatusbarText (RT Professional)
Descripción
Define el texto estándar de la barra de estado.
Sintaxis
Object.StatusbarText[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Opcional. Valor o constante que define el texto estándar de la barra de estado.
Consulte también
StatusbarUseBackColor (RT Professional)
Descripción
Define si se debe visualizar el color de fondo de la barra de estado.
Sintaxis
Object.StatusbarUseBackColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza el color de fondo de la barra de estado.
FALSE si no se visualiza el color de fondo de la barra de estado.

VB Scripting
Consulte también
StatusbarVisible (RT Professional)
Descripción
Define si se debe visualizar la barra de estado del control.
Sintaxis
Object.StatusbarVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza la barra de estado.
FALSE si no se visualiza la barra de estado.
Consulte también

VB Scripting

StatuslineFont (RT Advanced)
Descripción
StepBackColor (RT Professional)
Descripción
Determina el color de fondo de la etapa.
Sintaxis
Object.StepBackColor[=Color]
Object
● S7GraphOverview
Color
Opcional. Valor o constante que define el color de fondo de la etapa.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
StepFont (RT Professional)
Descripción
Define la fuente de la etapa.
Sintaxis
Object.StepFont[=Font]
Object
● S7GraphOverview
Font
Opcional. Valor o constante que define la fuente.
Consulte también
StepSeconds (RT Professional)
Descripción
Establece el intervalo de salto en segundos después de pulsar el botón "Adelante" o "Atrás".
Sintaxis
Object.StepSeconds[=Int32]
Object
● MediaPlayer
Int32
Opcional. Valor o constante que determina el intervalo de salto en segundos después de pulsar
el botón "Adelante" o "Atrás".
Consulte también

VB Scripting
StepTextColor (RT Professional)
Descripción
Define el color de texto de la etapa.
Sintaxis
Object.StepTextColor[=Color]
Object
● S7GraphOverview
Color
Opcional. Valor o constante que define el color de fondo de la etapa.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Style (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el estilo de línea.
Sintaxis
Object.Style[=LineStyle]

VB Scripting
Object
● CircularArc
● Connector
● EllipticalArc
● Line
● Polyline
LineStyle
Opcional. Un valor o una constante que determina el estilo de línea. Rango de valores de 0
a 4.

1 hmiLineStyleDash Línea discontinua
2 hmiLineStyleDot Línea punteada
3 hmiLineStyleDashDot Línea de rayas y puntos
4 hmiLineStyleDashDotDot Línea punto punto raya
StyleItem (RT Professional)
Descripción
StyleSettings (RT Professional)
Descripción
Define el estilo en el que se mostrará el objeto.
Sintaxis
Object.StyleSettings[=WinCCStyle]
Object
● Button
● RoundButton*
● Window Slider*

VB Scripting
WinCCStyle
Opcional. Valor o constante que determina el estilo con el que se representa el objeto.

0 Personalizado Determina que el objeto se visualice de acuerdo con los ajustes
propios.
1 Global Determina que el objeto se visualice en el diseño ajustado global‐
mente.
2 Estilo Windows Determina que el objeto se visualice en el estilo de Windows.
SupportsInplaceEdit (RT Professional)
Descripción
SupportsS7DiagnosticsInSimpleView (RT Advanced)
Descripción
SupportsUserDefinedToolbarButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
SwapFirstWithLastConnection (RT Professional)
Descripción
Define que la primera conexión y la última se intercambien.
Sintaxis
Object.SwapFirstWithLastConnection[=Boolean]
Object
● Connector

VB Scripting
Boolean
Opcional. Valor o constante que define que la primera conexión y la última se intercambien.
Consulte también
SwitchOrientation (RT Advanced)
Descripción
SymbolTableFont (RT Professional)
Descripción
Determina la fuente de la tabla de símbolos en el visor de código PLC.
Sintaxis
Object.SymbolTableFont[=Font]
Object
● PLCCodeViewer
Font
Opcional. Valor o constante que determina la fuente de la tabla de símbolos en el visor de
código PLC.
Consulte también
SysDiagBuffButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
1.5.5.13 Propiedades T (Panels, Comfort Panels, RT Advanced, RT Professional)
TabIndex (RT Professional)
Descripción
Determina el lugar que ocupará el objeto en la secuencia cuando se pase de objeto en objeto
con la tecla del tabulador.
Acceso en runtime:
Sintaxis
Object.TabIndex[=Int32]
Object
● DiscSpaceView
●
Int32
Opcional. Valor o constante que define el lugar en la secuencia de tabulador.
TabIndexAlpha (RT Professional)
Descripción
Define el lugar que ocupará el objeto en la secuencia cuando se pase de objeto en objeto con
la tecla del tabulador en el modo de cursor alfa.
Acceso en runtime:
Sintaxis
Object.TabIndexAlpha[=Int32]
Object
● DiscSpaceView

VB Scripting

● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline

VB Scripting
● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● ScreenWindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Int32
Opcional. Valor o constante que define el lugar en la secuencia de tabulador.
TableBackColor (RT Advanced)
Descripción
Define el color de fondo de las celdas de tabla.

VB Scripting
Sintaxis
Object.TableBackColor[=Color]
Object
● AlarmView
● RecipeView*
● StatusForce
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de fondo de las celdas de la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TableColor (RT Professional)
Descripción
Define el color de fondo de las filas de la tabla del objeto.
Sintaxis
Object.TableColor[=Color]
Object
● AlarmControl

VB Scripting
Color
Opcional. Valor o constante que determina el color de fondo de las filas de la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TableColor2 (RT Professional)
Descripción
Define el segundo color de fondo de las filas de la tabla del objeto.
Ajuste además "UseTableColor2 (Página 1174)" a "TRUE".
Sintaxis
Object.TableColor2[=Color]
Object
● AlarmControl

VB Scripting
Color
Opcional. Valor o constante que determina el segundo color de fondo de las filas de la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TableColumnsWidthAndOrder (RT Advanced)
Descripción
TableEvenRowBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
TableForeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fuente de las celdas de tabla del objeto.
Sintaxis
Object.TableForeColor[=Color]
Object
● AlarmControl
● AlarmView
● RecipeView*
● StatusForce
● UserView
Color
Opcional. Un valor o una constante que determina el color del texto en las celdas de tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TableForeColor2 (RT Professional)
Descripción
Define el segundo color de fuente de las celdas de tabla del objeto.
Ajuste además "UseTableColor2 (Página 1174)" a "TRUE".

VB Scripting
Sintaxis
Object.TableForeColor2[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el segundo color de fuente en las celdas de la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TableGridLineColor (RT Advanced)
Descripción
Define el color de las líneas de la cuadrícula en la tabla.
Acceso en runtime:

VB Scripting
Sintaxis
Object.TableGridLineColor[=Color]
Object
● RecipeView*
● TrendView*
● UserView

● StatusForce
● SysDiagControl
Color
Opcional. Valor o constante que determina el color de las líneas de retícula en la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TableHeaderBackColor (RT Advanced)
Descripción
Define el color de fondo del encabezado de la tabla.
Sintaxis
Object.TableHeaderBackColor[=Color]
Object
● AlarmView
● RecipeView*

VB Scripting
● StatusForce
● TrendView*
● UserView
Color
Opcional. Valor o constante que determina el color de fondo del encabezado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TableHeaderBackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderBorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderBorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
TableHeaderCornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderFirstGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderFirstGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderForeColor (RT Advanced)
Descripción
Define el color de texto del encabezado de la tabla.
Sintaxis
Object.TableHeaderForeColor[=Color]

VB Scripting
Object
● AlarmView
● RecipeView*
● StatusForce*
● TrendView*
● UserView
Color
Opcional. Valor o constante que determina el color de texto del encabezado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TableHeaderMiddleGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderPaddingBottom (RT Advanced)
Descripción
TableHeaderPaddingLeft (RT Advanced)
Descripción

VB Scripting
TableHeaderPaddingRight (RT Advanced)
Descripción
TableHeaderPaddingTop (RT Advanced)
Descripción
TableHeaderSecondGradientColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TableHeaderSecondGradientOffset (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Tag4DataRecord (RT Advanced)
Descripción
Tag4RecipeNumber (RT Advanced)
Descripción
TagForExternalTime (RT Advanced)
Descripción

VB Scripting
TagPrefix (RT Professional)
Descripción
Define el prefijo de variable que precederá a todas las variables contenidas en la ventana de
imagen. De esta forma la imagen mantiene una imagen, que está conectada a una ventana
de imagen, el acceso a sus propias variables, mientras que otra accede a otras variables.
La modificación del prefijo de variable no tendrá efecto hasta la próxima vez que se cargue
la imagen. En caso de cambio de imagen, la modificación se hará efectiva de manera
automática. Sin cambio de imagen, la modificación se hará efectiva solo cuando se vuelva a
asignar el nombre de la imagen.
El prefijo se puede definir libremente, pero debe coincidir con el nombre de las variables de
estructura.
Nota
Asignación de un tipo de datos de usuario
También se puede definir un tipo de datos de usuario para una imagen integrada en una
ventana de imagen. En tal caso, los elementos de tipo de datos se asignan directamente del
tipo de datos de usuario elegido.
Nota
Prefijo de variable frente a variables direccionadas indirectamente
Evite utilizar al mismo tiempo prefijos de variable y variables direccionadas indirectamente.
Sintaxis
Object.TagPrefix[= STRING]
Object
● ScreenWindow
STRING
Opcional. Valor o constante que determina el prefijo de variable.
Ejemplo
En la ventana de imagen ha de aparecer la imagen "EntradaSalida". La imagen
"EntradaSalida" contiene tres campos E/S vinculados a una variable de estructura. La variable
de estructura se compone de los elementos .EA1, .EA2, .EA3; un elemento para cada campo
E/S. Los nombres de los elementos van precedidos de un punto. Para acceder a los elementos
de la variable de estructura de manera sintácticamente correcta como elementos
estructurales, debe usarse obligatoriamente el punto.

VB Scripting
En el proyecto se han definido, p. ej., tres variables de estructura con los nombres de estructura
Struct1, Struct2 y Struct3.
En este caso, el prefijo de variable es el nombre de la estructura. Indique como prefijo de
variable "Struct2.", p. ej. De este modo, los campos E/S de la imagen "EntradaSalida" se
conectarán con los elementos de la variable estructural "Struct2".
Prefijo de variable: "Struct2":
● Valor de salida (primer campo E/S): .EA1:
● Valor de salida (segundo campo E/S): .EA2
● Valor de salida (tercer campo E/S): .EA3
Conexión de variables actual en la ventana de imagen:
● Valor de salida (primer campo E/S): Struct2.EA1
● Valor de salida (segundo campo E/S): Struct2.EA2
● Valor de salida (tercer campo E/S): Struct2.EA3
Consulte también
Tags (RT Professional)
Descripción
Devuelve el objeto del tipo "Tags".
Sintaxis
Object.Tags
Object
Ejemplo
El siguiente ejemplo accede a la variable "Tag1":
'VBS86
Dim objTag

VB Scripting
Consulte también
TcpPortNr (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Template (RT Professional)
Descripción
Define la plantilla para la visualización del contenido de la ventana del objeto "Trabajo de
impresión/diagnóstico de script".
Sintaxis
Object.Template[=TemplateType]
Object
TemplateType
Opcional. Valor o constante que define la plantilla.
Dependiendo del valor que tenga la propiedad "WindowsContents (Página 1240)", se podrán
usar los siguientes modelos:
Contenido de ventana = Global Script

● "Diagnóstico de GSC"
El objeto "Diagnóstico de script" recibe valores de las aplicaciones del Global Script. Se
representan los resultados del sistema de diagnóstico.
● "Runtime de GSC"
El objeto "Diagnóstico de script" recibe valores de las aplicaciones del Global Script. Se
representan los resultados de análisis del comportamiento en Runtime.

VB Scripting
Contenido de ventana = Print Jobs

● "All Jobs":
El objeto "Trabajo de impresión" recibe valores del sistema de documentación. Los
informes disponibles se representan como lista.
● "All Jobs - Context Menu":
informes disponibles se representan como lista. Un menú emergente permite la selección
de las opciones de impresión, la representación de una vista preliminar así como la
impresión de un informe.
● "Job Detail View":
informes disponibles se representan en un menú de selección. Para el informe
seleccionado se visualizan informaciones más detalladas.
● "Selected Jobs - Context Menu":
informes disponibles se representan como lista. La lista contiene únicamente los informes
para los que usted ha activado la opción "Marcar para lista de trabajos de impresión" en
el cuadro de diálogo "Propiedades de los trabajos de impresión". Un menú emergente
permite la selección de las opciones de impresión, la representación de una vista preliminar
así como la impresión de un informe.
Consulte también
Text (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el título del campo de texto.
Sintaxis
Object.Text[=STRING]
Object
● CheckBox
● ComboBox
● ListBox
● MultiLineEdit
● OptionGroup

VB Scripting
● RoundButton
● TextField
STRING
Opcional. Un valor o una constante que determina la rotulación.
TextAreaBottomMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TextAreaLeftMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TextAreaRightMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TextAreaTopMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TextHandles (RT Professional)
Descripción
TextList (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la lista de textos que proporciona valores al objeto.

VB Scripting
Acceso en runtime:
Sintaxis
Object.TextList[=HmiObjectHandle]
Object
● SymbolicIOField
● Button
HmiObjectHandle
Opcional. Valor o constante que devuelve la lista de textos que proporciona valores al objeto.
Consulte también
TextOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el texto que se mostrará con el estado "Off".
Sintaxis
Obje ct.TextOff[=STRING]
Object
● Button
● Switch*
* RT Advanced: Solo acceso de lectura; RT Professional: Ningún acceso

● SymbolicIOField

VB Scripting
STRING
Opcional. Un valor o una constante que determina la rotulación del estado "Off".
Observaciones
La propiedad solo está disponible si el objeto referenciado es del tipo "Text".
TextOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el texto que se mostrará con el estado "On".
Sintaxis
Object.TextOn[=STRING]
Object
● Button
● Switch*
* RT Advanced: Solo acceso de lectura; RT Professional: Ningún acceso

● SymbolicIOField
STRING
Opcional. Un valor o una constante que determina la rotulación para el estado "On".
Observaciones
La propiedad solo está disponible si el objeto referenciado es del tipo "Text".
TextOrientation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la dirección del texto.
Acceso en runtime:

VB Scripting
Sintaxis
Object.TextOrientation[=TextOrientation]
Object
● Button
● CheckBox
● IOField
● OptionGroup
● RoundButton*
● TextField
● WindowSlider*
● DateTimeField
● Switch
TextOrientation
Opcional. Valor o constante que determina la dirección del texto.

0 hmiTextHorizontal El texto se muestra horizontalmente.
-1 hmiTextRotated90Degree El texto se muestra verticalmente y alineado a la izquierda.
1 hmiTextRotated270Degree El texto se muestra verticalmente y alineado a la derecha.
Texts (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TextualObjectPositions (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
TextualObjectsAutoSize (RT Advanced)
Descripción
TextualObjectsBorderBackColor (RT Advanced)
Descripción
TextualObjectsBorderColor (RT Advanced)
Descripción
TextualObjectsBorderWidth (RT Advanced)
Descripción
TextualObjectsCornerRadius (RT Advanced)
Descripción
TextualObjectsEdgeStyle (RT Advanced)
Descripción
TextualObjectsPaddingBottom (RT Advanced)
Descripción

VB Scripting
TextualObjectsPaddingLeft (RT Advanced)
Descripción
TextualObjectsPaddingRight (RT Advanced)
Descripción
TextualObjectsPaddingTop (RT Advanced)
Descripción
ThumbBackColor (RT Professional)
Descripción
Define el color de fondo del deslizador.
Sintaxis
Object.ThumbBackColor[=Color]
Object
● Slider
● WindowSlider
Color
Opcional. Un valor o una constante que determina el color de fondo del regulador.
Observaciones
siguiente:
RGB (255, 0, 0)

VB Scripting
vbGreen.
Consulte también
ThumbPicture (RT Professional)
Descripción
Define un gráfico para el deslizador del control deslizante.
Sintaxis
Object.ThumbPicture[=HmiObjectHandle]
Object
● Slider
HmiObjectHandle
Opcional. Valor o constante que determina el gráfico para el deslizador del control deslizante.
Consulte también
TickDistance (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TicksColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de las marcas horarias en la esfera del objeto "Clock".

VB Scripting
Sintaxis
Object.TicksColor[=Color]
Object
● Clock
Color
Opcional. Valor o constante que determina el color de las marcas horarias.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Clock (Página 290)
TickStyle (RT Professional)
Descripción
Define la representación de las marcas de la escala.
Ajuste además "ShowTicks" a "TRUE".
Acceso en runtime:
Sintaxis
Object.TickStyle[=SliderTickStyle]
Object
● Slider
● Clock

VB Scripting
SliderTickStyle
Opcional. Valor o constante que determina la representación de las marcas de la escala.

0 hmiSliderTickStyleNone La escala no posee marcas.
1 hmiSliderTickStyleEffect1 Las marcas grandes de la escala se muestran en
blanco con raya de sombra negra. Las marcas pe‐
queñas de la escala se muestran en negro.
2 hmiSliderTickStyleEffect2 Las marcas grandes de la escala se muestran en
negro con raya de sombra blanca. Las marcas pe‐
queñas de la escala se muestran en negro.
3 hmiSliderTickStyleNormal Todas las marcas de la escala se muestran en negro.
Observaciones
Debido al escalado automático puede haber dos marcas de la escala muy juntas y parecer
una marca ancha. Para corregir este efecto, alargue o acorte el deslizador.
TimeAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TimeAxisAdd (RT Professional)
Descripción
Crea un nuevo eje de tiempo. El eje de tiempo recién creado se referencia automáticamente
mediante "TimeAxisIndex".
Sintaxis
Object.TimeAxisAdd[=STRING]
Object
STRING
Necesario. Valor o constante que determina el nombre del nuevo eje de tiempo mediante
"TimeAxisName".

VB Scripting
TimeAxisAlignment (RT Professional)
Descripción
Determina la alineación del eje de tiempo.
Sintaxis
Object.TimeAxisAlignment[=AxisAlignment]
Object
AxisAlignment
Opcional. Valor o constante que determina la alineación.

0 Abajo El eje de tiempo seleccionado se mostrará debajo de la curva.
1 Arriba El eje de tiempo seleccionado se mostrará encima de la cur‐
va.
Consulte también
TimeAxisBegin (RT Advanced)
Descripción
TimeAxisBeginTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el punto de inicio de la representación del eje de tiempo referenciado mediante
"TimeAxisIndex".
Acceso en runtime:

VB Scripting
Sintaxis
Object.TimeAxisBeginTime[=DateTime]
Object
● TrendView
DateTime
Opcional. Valor o constante que determina el punto de inicio de la representación de la curva
indicada
TimeAxisColor (RT Professional)
Descripción
Determina el color del eje de tiempo referenciado mediante "TimeAxisIndex".
Sintaxis
Object.TimeAxisColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color del eje de tiempo.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
TimeAxisCount (RT Professional)
Descripción
Define el número de ejes de tiempo configurados.
Sintaxis
Object.TimeAxisCount[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de ejes de tiempo configurados.
Consulte también
TimeAxisCountPoints (RT Advanced)
Descripción
TimeAxisDateFormat (RT Professional)
Descripción
Define qué formato de fecha se utilizará para visualizar el eje de tiempo referenciado mediante
"TimeAxisIndex".
Sintaxis
Object.TimeAxisDateFormat[=STRING]
Object

VB Scripting
STRING
Opcional. Valor o constante que determina el formato de fecha.
Consulte también
TimeAxisEnd (RT Advanced)
Descripción
TimeAxisEndTime (RT Professional)
Descripción
Define el instante final de la representación de la curva indicada. La indicación se evaluará o
no en función de las propiedades "Autorange", "UseTimeRange(i)" y "ShareTimeAxis".
Sintaxis
Object.TimeAxisEndTime[=DateTime]
Object
DateTime
Opcional. Valor o constante que determina el instante final de la representación de la curva
indicada.
Consulte también
TimeAxisIndex (RT Professional)
Descripción
Hace referencia a un eje de tiempo. Para acceder a las propiedades de un eje de tiempo, se
debe activar "TimeAxisIndex".

VB Scripting
Los valores válidos para "TimeAxisIndex" se encuentran entre 0 y "TimeAxisCount" menos 1.

La propiedad "TimeAxisCount" indica el número de ejes de tiempo configurados.
Sintaxis
Object.TimeAxisIndex[=Int32]
Object
Int32
Opcional. Valor o constante que determina a través del índice el eje de tiempo que va a
editarse.
Consulte también
TimeAxisCount (Página 1025)
TimeAxisInTrendColor (RT Professional)
Descripción
Determina si el color del eje de tiempo referenciado mediante "TimeAxisIndex" se corresponde
con el color de la curva.
Sintaxis
Object.TimeAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se debe mostrar el eje referenciado con el color de la curva. El valor de
"TimeAxisColor" no es efectivo.
FALSE si debe mostrarse el eje referenciado con el color determinado en "TimeAxisColor".

VB Scripting
Consulte también
TimeAxisIndex (Página 1026)
TimeAxisLabel (RT Professional)
Descripción
Define el texto con el que se rotulará un eje de tiempo referenciado mediante "TimeAxisIndex".
Sintaxis
Object.TimeAxisLabel[=STRING]
Object
STRING
Opcional. Valor o constante que determina el texto de rotulación del eje de tiempo
referenciado.
Consulte también
TimeAxisMeasurePoints (RT Professional)
Descripción
Determina el número de puntos de medida que se muestran para el eje de tiempo referenciado
mediante "TimeAxisIndex".
Sintaxis
Object.TimeAxisMeasurePoints[=Int32]
Object

VB Scripting
Int32
Opcional. Valor o constante que determina el número de puntos de medición.
Consulte también
TimeAxisMode (RT Advanced)
Descripción
TimeAxisName (RT Professional)
Descripción
Define el nombre de un eje de tiempo referenciado mediante "TimeAxisIndex".
Sintaxis
Object.TimeAxisName[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre del eje de tiempo referenciado.
Consulte también
TimeAxisOnline (RT Professional)
Descripción
Determina que el eje de tiempo se actualice continuamente.

VB Scripting
Sintaxis
Object.TimeAxisOnline[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el eje de tiempo se actualiza continuamente.
FALSE si el eje de tiempo no se actualiza continuamente.
Consulte también
TimeAxisRange (RT Advanced)
Descripción
TimeAxisRangeType (RT Professional)
Descripción
Determina el ajuste del intervalo de tiempo para el eje de tiempo referenciado mediante
"TimeAxisIndex".
Sintaxis
Object.TimeAxisRangeType[=TimeRangeMode]
Object
TimeRangeMode
Opcional. Valor o constante que determina los ajustes del rango de tiempo.

VB Scripting

0 Intervalo de tiempo Para la columna de tiempo se establecerá el punto de inicio
y el intervalo de tiempo.
1 Tiempo de fin Para la columna de tiempo se establecerá el momento de
inicio y finalización.
2 Puntos de medición Para la columna de tiempo se definirá el número de puntos
de medida.
Consulte también
TimeAxisRemove (RT Professional)
Descripción
Elimina un eje de tiempo referenciado mediante su nombre.
Sintaxis
Object.TimeAxisRemove[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre del eje de tiempo referenciado que se
borrará.
Consulte también
TimeAxisRename (RT Professional)
Descripción
Define el nombre nuevo de un eje de tiempo referenciado mediante "TimeAxisIndex".

VB Scripting
Sintaxis
Object.TimeAxisRename[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nuevo nombre del eje de tiempo seleccionado.
Consulte también
TimeAxisRepos (RT Professional)
Descripción
Define la posición de un eje de tiempo referenciado mediante "TimeAxisIndex" en el diagrama
de curvas del objeto.
Si ha modificado la posición del eje de tiempo con "TimeAxisRepos", a "TimeAxisIndex" se le
asignará el valor de "TimeAxisRepos".
Sintaxis
Object.TimeAxisRepos[=Int32]
Object
Int32
Opcional. Valor o constante que determina la posición del eje de tiempo referenciado. Rango
de valores de 0 a "TimeAxisCount" menos 1. Los valores fuera de este rango de valores no
tienen ningún efecto.
0: El eje de tiempo referenciado se posiciona fuera.

VB Scripting
Consulte también
TimeAxisShowDate (RT Professional)
Descripción
Define si se muestra el eje de tiempo referenciado mediante "TimeAxisIndex" con fecha y
hora.
Sintaxis
Object.TimeAxisShowDate[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran la fecha y la hora. El formato de la fecha se define mediante la propiedad
"TimeAxisDateFormat".
FALSE si no se muestra la fecha. Solamente se visualiza la hora.
Consulte también
TimeAxisSide (RT Advanced)
Descripción
TimeAxisTimeFormat (RT Professional)
Descripción
Define el formato de las indicaciones a lo largo del eje de tiempo de la curva especificada.

VB Scripting
Sintaxis
Object.TimeAxisTimeFormat[=STRING]
Object
STRING
Opcional. Valor o constante que establece el formato del eje de tiempo.
Consulte también
TimeAxisTimeRange (RT Advanced)
Descripción
TimeAxisTimeRangeBase (RT Professional)
Descripción
Define la unidad de tiempo que determina el rango de tiempo con el factor de tiempo
"TimeAxisTimeRangeFactor".
Sintaxis
Object.TimeAxisTimeRangeBase[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
Opcional. Valor o constante que determina la unidad de tiempo.

VB Scripting
Valor Nombre
500 500 ms
1000 1 segundo
60000 1 minuto
3600000 1 hora
86400000 1 día
Consulte también
TimeAxisTimeRangeFactor (RT Professional)
Descripción
Define el factor de tiempo que, con la unidad de tiempo "TimeAxisTimeRangeBase", determina
el período.
Sintaxis
Object.TimeAxisTimeRangeFactor[=Int16]
Object
Int16
Opcional. Valor o constante que establece el factor de tiempo.
Consulte también
TimeAxisTrendWindow (RT Professional)
Descripción
Define el diagrama de curvas en el que se mostrará el eje referenciado mediante
"TimeAxisIndex".

VB Scripting
Sintaxis
Object.TimeAxisTrendWindow[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del diagrama de curvas.
Consulte también
TrendWindowCount (Página 1143)
TimeAxisVisible (RT Professional)
Descripción
Define si se mostrará el eje de tiempo referenciado mediante "TimeAxisIndex" en el objeto.
Sintaxis
Object.TimeAxisVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se visualiza el eje de tiempo referenciado.
FALSE si se oculta el eje de tiempo referenciado.
Consulte también

VB Scripting
TimeBase (RT Professional)
Descripción
Define la zona horaria que sirve de base para mostrar los valores de tiempo.
Sintaxis
Object.TimeBase[=TimeBase]
Object
● AlarmControl
TimeBase
Opcional. Valor o constante que determina la zona horaria.

0 hmiTimeBaseLocalTime‐ Hora local
zone
1 hmiTimeBaseServerTi‐ Zona horaria del servidor
mezone
2 hmiTimeBaseUTC UTC (Universal Time Coordinated)
3 hmiTimeBaseProjectSet‐ Configuración del proyecto
ting
Observaciones
En el árbol del proyecto puede determinar el modo horario en función del panel de operador
en las propiedades de objeto del panel.
Consulte también

VB Scripting
TimeColumnActualize (RT Professional)
Descripción
Define si se actualizarán los valores de la columna de tiempos referenciada mediante
"TimeColumnIndex".
Sintaxis
Object.TimeColumnActualize[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se actualiza la columna de tiempo.
FALSE si no se actualiza la columna de tiempo. Este ajuste es útil para comparar una tabla
con otra.
Consulte también
TimeColumnAdd (RT Professional)
Descripción
Crea una nueva columna de tiempo. La columna de tiempo recién creada se referencia
automáticamente mediante "TimeColumnIndex".
Sintaxis
Object.TimeColumnAdd[=STRING]
Object

VB Scripting
STRING
Necesario. Valor o constante que define el nombre de la nueva columna de tiempo mediante
"TimeColumnName".
Consulte también
TimeColumnIndex (Página 1047)
TimeColumnAlignment (RT Professional)
Descripción
Define cómo se alineará el texto dentro la columna de tiempos referenciada mediante
"TimeColumnIndex".
Sintaxis
Object.TimeColumnAlignment [=HorizontalAlignment]
Object
HorizontalAlignment
Opcional. Valor o constante que define cómo se alineará el texto dentro de la columna de
tiempo referenciada.

0 hmiAlignmentLeft El texto se alinea a la izquierda.
1 hmiAlignmentCentered El texto se centra.
2 hmiAlignmentRight El texto se alinea a la derecha.
Consulte también
TimeColumnBackColor (RT Professional)
Descripción
Define el color de fondo de la columna de tiempos referenciada mediante "TimeColumnIndex".

VB Scripting
Ajuste además "UseColumnBackColor (Página 1163)" a "TRUE" y

"TimeColumnUseValueColumnColors (Página 1056)" a "FALSE".
Sintaxis
Object.TimeColumnBackColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de fondo de la columna de tiempo
seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TimeColumnBeginTime (RT Professional)
Descripción
Define el tiempo de inicio del rango de tiempo para la columna de tiempos referenciada
mediante "TimeColumnIndex".
Sintaxis
Object.TimeColumnBeginTime[=DateTime]
Object

VB Scripting
DateTime
Opcional. Valor o constante que establece el punto de inicio para la columna de tiempo
seleccionada.
Consulte también
TimeColumnCaption (RT Professional)
Descripción
Define el nombre de la columna de tiempos referenciada mediante "TimeColumnIndex".
Sintaxis
Object.TimeColumnCaption[=STRING]
Object
STRING
Opcional. Valor o constante que determina la denominación de la columna de tiempo.
Consulte también
TimeColumnCount (RT Professional)
Descripción
Determina el número de columnas de tiempo configuradas.
Sintaxis
Object.TimeColumnCount[=Int32]
Object

VB Scripting
Int32
Opcional. Valor o constante que determina el número de columnas de tiempo configuradas.
Consulte también
TimeColumnDateFormat (RT Professional)
Descripción
Define qué formato de fecha se utilizará para visualizar la columna de tiempos referenciada
Sintaxis
Object.TimeColumnDateFormat[=STRING]
Object
STRING
Opcional. Valor o constante que determina qué formato de fecha se utilizará para visualizar
la columna de tiempo seleccionada.
Pueden utilizarse los siguientes formatos de fecha:
Valor Explicación
dd.MM.yy día.mes.año, p. ej. 24.12.13.
dd.yyyyd.MM día.mes.año, p. ej. 24.12.2013.
dd/MM/yy día/mes/año, p. ej. 24/12/13
dd/MM/yyyy día/mes/año, p. ej. 24/12/2013.
TimeColumnEndTime (RT Professional)
Descripción
Define el tiempo de fin del rango de tiempo para una columna de tiempos referenciada

VB Scripting
Sintaxis
Object.TimeColumnBeginTime[=DateTime]
Object
DateTime
Opcional. Valor o constante que determina el instante final.
Consulte también
TimeColumnForeColor (RT Professional)
Descripción
Define el color de fuente de la columna de tiempos referenciada mediante "TimeColumnIndex".
Ajuste además "UseColumnForeColor (Página 1163)" a "TRUE" y
"TimeColumnUseValueColumnColors (Página 1056)" a "FALSE".
Sintaxis
Object.TimeColumnForeColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de fuente de la columna de tiempo
seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
TimeColumnHideText (RT Professional)
Descripción
Define si el contenido de la columna de tiempos referenciada mediante "TimeColumnIndex"
se mostrará en forma de texto.
Sintaxis
Object.TimeColumnHideText[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el contenido no se muestra en forma de texto.
FALSE si el contenido se muestra en forma de texto.
Consulte también
TimeColumnHideTitleText (RT Professional)
Descripción
Define si el título de la columna de tiempos referenciada mediante "TimeColumnIndex" se
Sintaxis
Object.TimeColumnHideTitleText[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si el título no se mostrará en forma de texto.
FALSE si el título se mostrará en forma de texto.
Consulte también
TimeColumnIndex (RT Professional)
Descripción
Hace referencia a una columna de tiempo configurada. Para acceder a las propiedades de
una columna de tiempo, es necesario activar "TimeColumnIndex".
Los valores válidos para "TimeColumnIndex" se encuentran entre 0 y "TimeColumnCount"
menos 1. La propiedad "TimeColumnCount" indica el número de columnas de tiempo
configuradas.
Sintaxis
Object.TimeColumnIndex[=Int32]
Object
Int32
Opcional. Valor o constante que determina a través del índice la columna de tiempo que va
a editarse.
TimeColumnLength (RT Professional)
Descripción
Define el ancho de la columna de tiempos referenciada mediante "TimeColumnIndex".
Sintaxis
Object.TimeColumnLength[=Int32]

VB Scripting
Object
Int32
Opcional. Valor o constante que define el ancho para la columna de tiempo seleccionada.
Consulte también
TimeColumnMeasurePoints (RT Professional)
Descripción
Define el número de puntos de medida que se mostrarán en la columna de tiempos
referenciada mediante "TimeColumnIndex".
Sintaxis
Object.TimeColumnMeasurePoints[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de puntos de medida.
Consulte también
TimeColumnName (RT Professional)
Descripción
Define el nombre de una columna de tiempos referenciada mediante "TimeColumnIndex".
Sintaxis
Object.TimeColumnName[=STRING]

VB Scripting
Object
STRING
Opcional. Valor o constante que define el nombre de la columna de tiempo referenciada.
Consulte también
TimeColumnRangeType (RT Professional)
Descripción
Define el rango de tiempo que se empleará para una columna de tiempos referenciada
Sintaxis
Object.TimeColumnRangeType[=TimeRangeMode]
Object
TimeRangeMode
Opcional. Valor o constante que define el intervalo de tiempo que se utiliza para la columna
de tiempo seleccionada.

0 Intervalo de tiempo Para la columna de tiempo se establecerá el punto de inicio y
el intervalo de tiempo.
1 Instante inicial a final Para la columna de tiempo se establecerá el momento de inicio
y finalización.
2 Número de puntos de medi‐ Para la columna de tiempo se definirá el número de puntos de
da medida.
Consulte también

VB Scripting
TimeColumnRemove (RT Professional)
Descripción
Elimina una columna de tiempos referenciada mediante su nombre.
Sintaxis
Object.TimeColumnRemove[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre de la columna de tiempo referenciada
que se borrará.
Consulte también
TimeColumnRename (RT Professional)
Descripción
Define el nombre nuevo de una columna de tiempos referenciada mediante
"TimeColumnIndex".
Sintaxis
Object.TimeColumnRename[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre nuevo de la columna de tiempo
seleccionada.

VB Scripting
Consulte también
TimeColumnRepos (RT Professional)
Descripción
En el caso de varias columnas de tiempos con las correspondientes columnas de valores,
define la posición de una columna de tiempos referenciada mediante "TimeColumnIndex".
Si ha modificado la posición de la columna de tiempo con "TimeColumnRepos", a
"TimeColumnIndex" se le asignará el valor de "TimeColumnRepos".
Sintaxis
Object.TimeColumnRepos[=Int32]
Object
Int32
Opcional. Valor o constante que define la posición de la columna de tiempo referenciada con
sus respectivas columnas de valores. Rango de valores de 0 a "TimeColumnCount" menos
1. Los valores fuera de este rango de valores no tienen ningún efecto.
0: La columna de tiempo referenciada se posiciona a la izquierda.
Consulte también
TimeColumnCount (Página 1041)
TimeColumns (RT Professional)
Descripción

VB Scripting
TimeColumnShowDate (RT Professional)
Descripción
Define si se mostrará la columna de tiempos referenciada mediante "TimeColumnIndex" con
fecha y hora.
Ajuste además el formato de fecha mediante "TimeColumnDateFormat (Página 1042)".
Sintaxis
Object.TimeColumnShowDate[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran la fecha y la hora.
FALSE si solo se visualiza la hora.
Consulte también
TimeColumnShowIcon (RT Professional)
Descripción
Define si el contenido de la columna de tiempos referenciada mediante "TimeColumnIndex"
se mostrará en forma de símbolo.
Sintaxis
Object. [=BOOLEAN]
Object
BOOLEAN
Opcional.

VB Scripting
TRUE si el contenido se mostrará en forma de símbolo.

FALSE si el contenido no se mostrará en forma de símbolo.
TimeColumnShowTitleIcon (RT Professional)
Descripción
Define si el título de la columna de tiempos referenciada mediante "TimeColumnIndex" se
mostrará en forma de símbolo.
Sintaxis
Object.TimeColumnShowTitleIcon[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el título se mostrará en forma de símbolo.
FALSE si el título no se mostrará en forma de símbolo.
Consulte también
TimeColumnSort (RT Professional)
Descripción
Define cómo se clasificará una columna de tiempos referenciada mediante
"TimeColumnIndex".
Sintaxis
Object.TimeColumnSort[=SortMode]
Object

VB Scripting
SortMode
Opcional. Valor o constante que determina cómo se clasificará la columna de tiempo
referenciada en "TimeColumnIndex".

0 No Sin clasificación
1 ascendente Clasificación ascendente desde el valor más pequeño hasta el mayor.
2 descendente Clasificación descendente desde el valor mayor hasta el menor.
Consulte también
TimeColumnSortIndex (RT Professional)
Descripción
Define el orden de clasificación de la columna de tiempo referenciada mediante
"TimeColumnIndex". Si ajusta el valor a "0", el orden de clasificación se eliminará de
"TimeColumnSort".
Sintaxis
Object.TimeColumnSortIndex[=Int32]
Object
Int32
Opcional. Valor o constante que indica el orden de clasificación de la columna de tiempo
referenciada mediante "TimeColumnIndex". Si ajusta el valor a "0", el orden de clasificación
se eliminará de "TimeColumnSort".
TimeColumnTimeFormat (RT Professional)
Descripción
Define qué formato de tiempo se utilizará para visualizar la columna de tiempos referenciada

VB Scripting
Sintaxis
Object.TimeColumnTimeFormat[=STRING]
Object
STRING
Opcional. Valor o constante que define qué formato de tiempo se utilizará para mostrar la
columna de tiempo seleccionada.
Valor Explicación
HH:mm:ss.ms Horas:Minutos:Segundos, por ejemplo 15:35:44.240.
hh:mm:ss tt Horas:Minutos:Segundos, AM/PM, por ejemplo 03:35:44 PM.
hh:mm:ss.ms tt Horas:Minutos:Segundos.milisegundos, AM/PM, por ejemplo 03:35:44.240
PM.
Consulte también
TimeColumnTimeRangeBase (RT Professional)
Descripción
Define la unidad de tiempo para determinar el rango de tiempo que se mostrará en la columna
de tiempos referenciada mediante "TimeColumnIndex".
El rango de tiempo se calcula a partir de una unidad de tiempo y un factor de tiempo. El factor
de tiempo se define en "TimeColumnTimeRangeFactor (Página 1056)".
Sintaxis
Object.TimeColumnTimeRangeBase[=TagLoggingTimeUnit]
Object

VB Scripting
TagLoggingTimeUnit
Opcional. Valor o constante que define la unidad de tiempo para determinar el rango de tiempo.
Valor Descripción
500 500 ms
1000 1 segundo
60000 1 minuto
3600000 1 hora
86400000 1 día
Consulte también
TimeColumnTimeRangeFactor (RT Professional)
Descripción
Define el factor para la determinación del intervalo de tiempo. Solamente se aceptan factores
que sean números enteros.
Sintaxis
Object.TimeColumnTimeRangeFactor[=Int16]
Object
Int16
Opcional. Valor o constante que establece el factor para determinar el rango de tiempo.
Consulte también
TimeColumnUseValueColumnColors (RT Professional)
Descripción
Define si se mostrará la columna de tiempos referenciada mediante "TimeColumnIndex" en
los colores de la columna de valores.

VB Scripting
Sintaxis
Object.TimeColumnUseValueColumnColors[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la columna de tiempo seleccionada se muestra en los colores de la columna de
valores. Los ajustes en "TimeColumnBackColor (Página 1039)" y "TimeColumnForeColor
(Página 1043)" no son efectivos.
FALSE si la columna de tiempo seleccionada se muestra en los colores que se han
determinado en "TimeColumnBackColor (Página 1039)" y "TimeColumnForeColor
(Página 1043)".
Consulte también
TimeColumnVisible (RT Professional)
Descripción
Define si la columna de tiempos referenciada mediante "TimeColumnIndex" se mostrará en
el visor de tablas.
Sintaxis
Object.TimeColumnVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra la columna de tiempo referenciada en la tabla.
FALSE si no se muestra la columna de tiempo referenciada en la tabla.

VB Scripting
Consulte también
TimeDisplayMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TimeStamp (RT Professional)
Descripción
Devuelve como DATE el sello de tiempo del último acceso de lectura de una variable en tiempo
local.
Sintaxis
Object.TimeStamp
Object
Observaciones
Para emitir la propiedad TimeStamp como texto claro, utilice la función VBS
"FormatDateTime(Date[, NamedFormat])". La salida depende del ajuste del ajuste de idioma.
Para ajustar el idioma, utilice la función VBS "SetLocale()".
Si desea devolver el sello de tiempo, por ejemplo, separado por fecha, día y hora, utilice el
parámetro NamedFormat o funciones VBS como Year, WeekDay, Day, Hour, Minute, Second.
El nombre de un día de la semana se obtiene con la función VBS WeekdayName.

VB Scripting
Ejemplos
El siguiente ejemplo muestra el sello de tiempo de la variable "Tag11" por medio de la función
"FormatDateTime":
'VBS87
Dim objTag
Dim lngCount
lngCount = 0
objTag.Read
SetLocale("en-gb")
MsgBox FormatDateTime(objTag.TimeStamp) 'Output: e.g. 06/08/2002 9:07:50
MsgBox Year(objTag.TimeStamp) 'Output: e.g. 2002
MsgBox Month(objTag.TimeStamp) 'Output: e.g. 8
MsgBox Weekday(objTag.TimeStamp) 'Output: e.g. 3
MsgBox WeekdayName(Weekday(objTag.TimeStamp)) 'Output: e.g. Tuesday
MsgBox Day(objTag.TimeStamp) 'Output: e.g. 6
MsgBox Hour(objTag.TimeStamp) 'Output: e.g. 9
MsgBox Minute(objTag.TimeStamp) 'Output: e.g. 7
MsgBox Second(objTag.TimeStamp) 'Output: e.g. 50
For lngCount = 0 To 4
MsgBox FormatDateTime(objTag.TimeStamp, lngCount)
Next
'lngCount = 0: Output: e.g. 06/08/2002 9:07:50
'lngCount = 1: Output: e.g. 06 August 2002
'lngCount = 2: Output: e.g. 06/08/2002
'lngCount = 3: Output: e.g. 9:07:50
'lngCount = 4: Output: e.g. 9:07
El siguiente ejemplo muestra el sello de tiempo de las variables "Tag1":
'VBS88
Dim objTag
objTag.Read
MsgBox objTag.TimeStamp
Consulte también
Tag (Página 230)
TimeStepBase (RT Professional)
Descripción
Define la unidad de tiempo para la precisión del sello de tiempo que se representa en la tabla.
La precisión se determina multiplicando el factor por la unidad de tiempo.

VB Scripting
Sintaxis
Object.TimeStepBase[=TimeStepBase]
Object
TimeStepBase
Opcional. Valor o constante que determina la unidad de tiempo para la precisión del sello de
tiempo.

0 Exact Establece que en la tabla solo se representen valores que tengan exac‐
tamente el mismo sello de tiempo en una fila.
1000 Base1s Establece como rango de tiempo el factor con base de 1 ms.
100 Base100ms Establece como rango de tiempo el factor con base de 100 ms.
Consulte también
TimeStepFactor (RT Professional)
Descripción
Determina la precisión del sello de tiempo, que se forma con la unidad de tiempo
"TimeStepBase".
La precisión se determina multiplicando el factor por la unidad de tiempo. Para representar,
p. ej., todos los valores aparecidos en un intervalo de 3 segundos en la misma fila, introduzca
"3" como factor y "Base1s" como unidad de tiempo.
El factor introducido no tiene efecto si se ha seleccionado "Exact" como unidad de tiempo.
Sintaxis
Object.TimeStepFactor[=Int32]
Object

VB Scripting
Int32
Opcional. Valor o constante que determina el factor de tiempo para la precisión del sello de
tiempo.
Consulte también
TitleColor (RT Professional)
Descripción
Define el color de fondo del título de la tabla.
Sintaxis
Object.TitleColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que define el color de fondo del título de tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting

TitleCut (RT Professional)
Descripción
Determina si los contenidos de los campos de una barra de título se acortan cuando el ancho
de columna es demasiado pequeño.
Sintaxis
Object.TitleCut[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si los títulos de las columnas de la barra de título se acortan cuando el ancho
de columna es demasiado pequeño.
Consulte también
TitleDarkShadowColor (RT Professional)
Descripción
Define el color de la parte oscura del sombreado 3D para los encabezados de columna y fila
de la tabla del objeto.
Ajuste además "TitleStyle (Página 1067)" a "1".

VB Scripting
Sintaxis
Object.TitleDarkShadowColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que define el color para la parte oscura del sombreado 3D.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TitleForeColor (RT Professional)
Descripción
Define el color de fuente en los encabezados de columna y fila de la tabla del objeto.
Sintaxis
Object.TitleForeColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que define el color de fuente de los encabezados de columna y
fila de la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TitleGridLineColor (RT Professional)
Descripción
Define el color de las líneas de separación en la barra de título de la tabla.
Sintaxis
Object.TitleGridLineColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de las líneas de separación en la barra de
título de la tabla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TitleLightShadowColor (RT Professional)
Descripción
Define el color de la parte clara del sombreado 3D para los encabezados de columna y fila
de la tabla del objeto.
Ajuste además "TitleStyle (Página 1067)" a "1".
Sintaxis
Object.TitleLightShadowColor[=Color]

VB Scripting
Object
● AlarmControl
Color
Opcional. Valor o constante que define el color del lado claro del sombreado 3D.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TitleSort (RT Professional)
Descripción
Define cómo se iniciará la clasificación por título de columna.
Sintaxis
Object.TitleSort[=GridSortTrigger]
Object
● AlarmControl

VB Scripting
GridSortTrigger
Opcional. Valor o constante que define cómo se iniciará la clasificación por título de columna.
Valor Explicación
0 No es posible clasificar por título de columna.
1 La clasificación se activará haciendo clic sobre el título de la columna.
2 La clasificación se activará haciendo un doble clic sobre el título de columna.
Consulte también
TitleStyle (RT Professional)
Descripción
Define si se empleará un color de sombreado para el texto de los encabezados de columna.
Sintaxis
Object.TitleStyle[=GridHeaderStyle]
Object
● AlarmControl
GridHeaderStyle
Opcional. Valor o constante que define si el texto se representará con sombras en los
encabezados de columna
Valor Explicación
0 No se utiliza ningún color de sombreado. Representación de aspecto plano del título.
1 Se utilizará un color de sombreado. Representación de aspecto tridimensional del título.

VB Scripting
Consulte también
Toggle (RT Professional)
Descripción
Determina si el objeto indicado encaja en runtime tras la activación.
Sintaxis
Object.Toggle[=BOOLEAN]
Object
● Button
● RoundButton*
BOOLEAN
Opcional. TRUE si el objeto indicado encaja en runtime tras la activación.
Tolerance (RT Professional)
Descripción
Establece el límite para el visor de memoria a partir del cual se notificará una desviación.
Sintaxis
Object.Tolerance[=Int32]
Object
● DiscSpaceView

VB Scripting
Int32
Opcional. Valor o constante que determina el valor límite para el visor de memoria a partir del
cual se notificará una desviación.
Consulte también
ToleranceColor (RT Professional)
Descripción
Define los colores en los que se representará la barra del visor de memoria en cuanto se
rebase por exceso el rango de tolerancia.
Sintaxis
Object.ToleranceColor[=Color]
Object
● DiscSpaceView
Color
Opcional. Valor o constante que determina los colores en los que se representa la barra del
visor de memoria en cuanto se rebasa por exceso el rango de tolerancia.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
ToleranceLowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el límite inferior para la tolerancia 1.
Sintaxis
Object.ToleranceLowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que establece el límite inferior para la tolerancia 1.
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceLowerLimit",
"ToleranceLowerLimitColor" y "ToleranceLowerLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)
ToleranceLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color para el valor límite inferior "ToleranceLowerLimit".
La propiedad "ToleranceLowerLimitEnabled" debe tener el valor TRUE si el color de la barra
debe cambiar al alcanzarse el valor límite.
Sintaxis
Object.ToleranceLowerLimitColor[=Color]

VB Scripting
Object
● Bar
Color
"ToleranceLowerLimit" .
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
ToleranceLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite "ToleranceLowerLimit". El valor límite, la representación
al alcanzar el valor límite y el tipo de evaluación se determinan por medio de las propiedades
"ToleranceLowerLimit", "ToleranceLowerLimitColor" y "ToleranceLowerLimitRelative".
Sintaxis
Object.ToleranceLowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "ToleranceLowerLimit".
Consulte también
Bar (Página 261)

VB Scripting
ToleranceLowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el valor límite inferior "ToleranceLowerLimit" se evaluará en porcentaje o de forma
absoluta.
Sintaxis
Object.ToleranceLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE si se evalúa el valor límite inferior "ToleranceLowerLimit" en porcentaje.
FALSE si se evalúa el valor límite inferior "ToleranceLowerLimit" de forma absoluta.
Consulte también
Bar (Página 261)
ToleranceUpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el límite superior para la tolerancia 1.
Sintaxis
Object.ToleranceUpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que establece el límite superior para la tolerancia 1.

VB Scripting
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceUpperLimit",
"ToleranceUpperLimitColor" y "ToleranceUpperLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)
ToleranceUpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color para el valor límite superior "ToleranceUpperLimit".
Sintaxis
Object.ToleranceUpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Un valor o una constante que define el color del valor límite superior
"ToleranceUpperLimit".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)

VB Scripting
ToleranceUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite "ToleranceUpperLimit".
Sintaxis
Object.ToleranceUpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "ToleranceUpperLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceUpperLimit",
"ToleranceUpperLimitColor" y "ToleranceUpperLimitRelative":
● Valor límite
● Representación al alcanzar el valor límite
Consulte también
Bar (Página 261)
ToleranceUpperLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el valor límite superior "ToleranceUpperLimit" se evalúa en porcentaje o de forma
absoluta.
Sintaxis
Object.ToleranceUpperLimitRelative[=BOOLEAN]

VB Scripting
Object
● Bar
BOOLEAN
Opcional.
TRUE si se evalúa el valor límite superior "ToleranceUpperLimit" en porcentaje.
FALSE si se evalúa el valor límite superior "ToleranceUpperLimit" de forma absoluta.
Consulte también
Bar (Página 261)
ToolBar_ButtonsHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolBar_ButtonsWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolbarAlignment (RT Professional)
Descripción
Define la posición de la barra de herramientas.
Acceso en runtime:
Sintaxis
Object.ToolbarAlignment[=ToolbarPosition]
Object
● AlarmControl

VB Scripting
● SysDiagControl
ToolbarPosition
Opcional. Valor o constante que define la posición de la barra de herramientas dentro del
objeto.
Valor Nombre
0 Arriba
1 Abajo
2 Izquierda
3 Derecha
ToolbarBackColor (RT Professional)
Descripción
Define el color de fondo de la barra de herramientas.
Ajuste además "ToolbarUseBackColor (Página 1095)" a "TRUE".
Sintaxis
Object.ToolbarBackColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de fondo de la barra de herramientas.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
ToolbarBackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolbarButtonActive (RT Professional)
Descripción
Define si la función enlazada con la tecla está activada en runtime. Haga clic en la tecla en
runtime para activar la función correspondiente.
Sintaxis
Object.ToolbarButtonActive[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si la función enlazada con la tecla está activa.
FALSE si la función enlazada con la tecla no está activa. Mediante scripts locales pueden
enlazarse funciones propias con la tecla.
Consulte también
ToolbarButtonAdd (RT Professional)
Descripción
Crea un nuevo botón definido por el usuario en la barra de herramientas del objeto. El botón
recién creado se referencia automáticamente mediante "ToolbarButtonIndex".
Sintaxis
Object.ToolbarButtonAdd[=STRING]
Object
● AlarmControl

VB Scripting
STRING
Necesario. Valor o constante que define el nombre del nuevo botón mediante
"ToolbarButtonName".
Consulte también
ToolbarButtonIndex (Página 1085)
ToolbarButtonAuthorization (RT Professional)
Descripción
Define el permiso para la función de tecla seleccionada. Los permisos se configuran en la
administración de usuarios.
Sintaxis
Object.ToolbarButtonAuthorization[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el permiso para la función de tecla seleccionada.

VB Scripting
Consulte también
ToolbarButtonBeginGroup (RT Professional)
Descripción
Define si se añadirá un separador antes de la función de teclas seleccionada. Con el separador
puede agrupar los botones de las funciones de teclas.
Sintaxis
Object.ToolbarButtonBeginGroup[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si antes de la función de tecla seleccionada se ha añadido el separador.
FALSE si antes de la función de tecla seleccionada no se ha añadido ningún separador.
Consulte también

VB Scripting

ToolbarButtonClick (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Hace clic en un botón de la barra de herramientas. Llama la función del botón correspondiente
mediante la ID del botón.
Acceso en runtime:
Sintaxis
Object.ToolbarButtonClick[=Int32]
Object
● AlarmControl
● SysDiagControl*
Int32
Opcional. Valor o constante que determina la ID del botón en el que se hace clic.
ToolbarButtonCount (RT Professional)
Descripción
Define el número de botones configurados que contiene la barra de herramientas.
Sintaxis
Object.ToolbarButtonCount[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de botones configurados en la barra de
herramientas.
Consulte también
ToolbarButtonEnabled (RT Professional)
Descripción
Determina si se puede utilizar la tecla de la barra de herramientas definida por el usuario.
Sintaxis
Object.ToolbarButtonEnabled[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional. TRUE si puede utilizarse la tecla definida por el usuario seleccionada en la barra
de herramientas.
Consulte también
ToolbarButtonHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolbarButtonHotKey (RT Professional)
Descripción
Define el método abreviado de teclado para el botón seleccionado del objeto. Indique el
método abreviado de teclado en código ASCII; p. ej., "112" para la tecla <F1>.
Ajuste además "ToolbarUseHotKeys (Página 1096)" a "TRUE".
Sintaxis
Object.ToolbarButtonHotKey[=Int32]
Object
● AlarmControl

VB Scripting
Int32
Opcional. Valor o constante que define la tecla de acceso directo para el botón seleccionado.
Consulte también
TrendIndex (Página 1117)
ToolbarButtonID (RT Professional)
Descripción
Hace referencia a un botón mediante su ID. Para acceder a las propiedades de un elemento
de la barra de estado, se debe activar "ToolbarButtonID".
El referenciado de un botón mediante su ID no depende del orden real de los botones. Las
ID se encuentran en una lista en la ventana de inspección del objeto correspondiente en
"Propiedades > Propiedades > Barra de herramientas > Barra de herramientas - Botones".
Sintaxis
Object.ToolbarButtonID[=Int32]
Object
● AlarmControl

VB Scripting
Int32
Opcional. Valor o constante que determina mediante la ID el botón de la barra de herramientas
que va a editarse.
Consulte también
ToolbarButtonClick (Página 1079)
ToolbarButtonIndex (RT Professional)
Descripción
Hace referencia a un botón. Para acceder a las propiedades de un botón, es necesario activar
"ToolbarButtonIndex".
Los valores válidos para "ToolbarButtonIndex" se encuentran entre 0 y "ToolbarButtonCount"
menos 1. La propiedad "ToolbarButtonCount" indica el número de botones configurados.
Sintaxis
Object.ToolbarButtonIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define a través del índice el botón que va a editarse.

VB Scripting
Consulte también
ToolbarButtonCount (Página 1079)
ToolbarButtonLocked (RT Professional)
Descripción
Define si se mostrará el estado pulsado (enclavado) de un botón definido por el usuario
referenciado mediante "ToolbarButtonIndex".
Sintaxis
Object.ToolbarButtonLocked[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si se muestra el estado pulsado del botón referenciado y definido por el
usuario de la barra de herramientas.
Consulte también

VB Scripting

ToolbarButtonName (RT Professional)
Descripción
Define el nombre de un botón definido por el usuario y referenciado mediante
Sintaxis
Object.ToolbarButtonName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del botón definido por el usuario y
referenciado.
Consulte también

VB Scripting
ToolbarButtonRemove (RT Professional)
Descripción
Elimina un botón definido por el usuario y referenciado mediante su nombre.
Sintaxis
Object.ToolbarButtonRemove[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del botón referenciado y definido por el
usuario que se borrará.
Consulte también
ToolbarButtonRename (RT Professional)
Descripción
Define el nuevo nombre de un botón definido por el usuario y referenciado mediante

VB Scripting
Sintaxis
Object.ToolbarButtonRename[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nuevo nombre del botón definido por el usuario
seleccionado.
Consulte también
ToolbarButtonRepos (RT Professional)
Descripción
Define la posición de un botón referenciado mediante "ToolbarButtonIndex" en la barra de
herramientas del objeto.
Si ha modificado la posición del botón con "ToolbarButtonRepos", a "ToolbarButtonIndex" se
le asignará el valor de "ToolbarButtonRepos".
Sintaxis
Object.ToolbarButtonRepos[=Int32]

VB Scripting
Object
● AlarmControl
Int32
Opcional. Valor o constante que define la posición del botón referenciado en la barra de
herramientas. Rango de valores de 0 a "ToolbarButtonCount" menos 1. Los valores fuera de
este rango de valores no tienen ningún efecto.
0: El botón referenciado se posiciona a la izquierda.
Consulte también
ToolbarButtonCount (Página 1079)
ToolbarButtons (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolbarButtonSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
ToolbarButtonsForMigration (RT Advanced)
Descripción
ToolbarButtonTooltipText (RT Professional)
Descripción
Define el texto para el tooltip del botón definido por el usuario en la barra de herramientas.
Sintaxis
Object.ToolbarButtonTooltipText[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina el texto del tooltip del botón definido por el usuario
seleccionado.
Consulte también

VB Scripting
ToolbarButtonUserDefined (RT Professional)
Descripción
Define si la tecla de la barra de herramientas ha sido agregada por el ingeniero como tecla
nueva definida por el usuario.
Sintaxis
Object.ToolbarButtonUserDefined[=BOOLEAN]
Object
● AlarmControl
Boolean
Opcional.
TRUE si la tecla de la barra de herramientas está definida por el usuario.
FALSE si la tecla de la barra de herramientas viene dada por el sistema.
Consulte también
ToolbarButtonVisible (RT Professional)
Descripción
Define si se mostrará el botón referenciado mediante "ToolbarButtonIndex" en la barra de
herramientas.

VB Scripting
Sintaxis
Object.ToolbarButtonVisible[=<BOOLEAN>]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza el botón referenciado.
FALSE si se oculta el botón referenciado.
Consulte también
ToolbarButtonWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolbarEnabled (RT Advanced)
Descripción

VB Scripting
ToolbarHeight (RT Advanced)
Descripción
ToolbarIconStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ToolbarLeft (RT Advanced)
Descripción
ToolbarShowTooltips (RT Professional)
Descripción
Define si en runtime se mostrarán los tooltips de las funciones de tecla. La propiedad puede
dinamizarse con el nombre ToolbarShowTooltips. La propiedad para definir el texto del tooltip
es "ToolbarButtonTooltipText".
Sintaxis
Object.ToolbarShowTooltips[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.

VB Scripting
TRUE si deben mostrarse los tooltips.

FALSE si no deben mostrarse los tooltips.
Consulte también
ToolbarStyle (RT Advanced)
Descripción
ToolbarTop (RT Advanced)
Descripción
ToolbarUseBackColor (RT Professional)
Descripción
Define si visualizará el color de fondo de la barra de herramientas.
Sintaxis
Object.ToolbarUseBackColor[=BOOLEAN]
Object
● AlarmControl

VB Scripting
BOOLEAN
Opcional.
TRUE si se muestra el color de fondo de la barra de herramientas.
FALSE si no se muestra el color de fondo de la barra de herramientas.
Consulte también
ToolbarUseHotKeys (RT Professional)
Descripción
Define si las teclas de acceso rápido para los botones de la barra de herramientas están
activadas. Las teclas de acceso directo se determinan para cada botón mediante
"ToolbarButtonHotKey (Página 1081)".
Sintaxis
Object.ToolbarUseHotKeys[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si las teclas de acceso rápido están activadas.

VB Scripting
Consulte también
ToolbarVisible (RT Professional)
Descripción
Define si se debe visualizar la barra de herramientas del control.
Sintaxis
Object.ToolbarVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se visualiza la barra de herramientas.
FALSE si no se visualiza la barra de herramientas.
Consulte también

VB Scripting

ToolbarWidth (RT Advanced)
Descripción
ToolTipText (RT Advanced, RT Professional)
Descripción
Define el texto del tooltip.
Sintaxis
Object.ToolTipText[=STRING]
ToolTipText
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit

VB Scripting
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton *
● StatusForce *
● Switch *
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowSlider *
STRING
Opcional. Un valor o una constante que determina el texto del tooltip.
Top (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el valor de la coordenada Y.
Sintaxis
Object.Top[=Int32]
Object
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox

VB Scripting
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● ProDiagOverview
● RangeLabelView
● RecipeView *
● Rectangle
● RoundButton *
● S7GraphOverview

VB Scripting
● ScreenWindow
● Slider **
● SmartClientView
● StatusForce *
● Switch *
● SymbolLibrary
● SysDiagControl *
● TextField
● TrendView *
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView **
● WLanQualityView
● WindowSlider *
● ZoneLabelView
● ZoneQualityView
** RT Professional: Solo acceso de lectura
Int32
Opcional. Valor o constante que contiene el valor de la coordenada Y en píxeles (medido
desde el borde superior izquierdo de la imagen).
Observaciones
La coordenada Y hace referencia al ángulo superior izquierdo del recuadro que rodea al objeto.
En runtime se vigilan también los límites de la imagen. Si el valor de coordenada asignado
excede el tamaño de la pantalla, el script de usuario se cancelará con un mensaje de error.

VB Scripting
TopMargin (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TopOffset (RT Professional)
Descripción
Determina el desplazamiento vertical del punto cero de la visualización de una imagen que
sea más grande que la ventana de imagen. El desplazamiento está referido al borde superior
de la ventana de imagen.
La imagen se muestra recortada. Las barras de desplazamiento de la imagen están ubicadas
en el borde izquierdo y borde superior de la imagen.
Si desea representar la imagen en la ventana de imagen con el desplazamiento horizontal y
vertical de las barras de desplazamiento de la imagen, utilice para el desplazamiento las
propiedades "HorizontalScrollBarPosition (Página 749)" y "VerticalScrollBarPosition
(Página 1219)".
Sintaxis
Object.TopOffset[=Int32]
Object
● Screenwindow
Int32
Opcional. Valor o constante que determina el desplazamiento vertical del punto cero de la
visualización de la imagen desde el borde superior de la ventana de imagen.
Consulte también
Total (RT Professional)
Descripción
Define la capacidad de memoria.

VB Scripting
Sintaxis
Object.Total[=DOUBLE]
Object
● DiskSpaceView
DOUBLE
Opcional. Valor o constante que define la capacidad de memoria.
TransitionHeaderFont (RT Professional)
Descripción
Determina la fuente del área de información de este visor de código PLC.
Sintaxis
Object.TransitionHeaderFont[=Font]
Object
● PLCCodeViewer
Font
Consulte también
Transparency (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la transparencia del objeto en forma de porcentaje.
Significado: 0 = sin transparencia y 100 = transparencia completa (invisibilidad).
Los textos y los campos de los objetos gráficos se representan transparentes solo con el valor
"100".
En Runtime funciona también un objeto completamente transparente y por lo tanto invisible.

VB Scripting
Sintaxis
Object.Transparency[=Int32]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton *
● Slider *
● TextField
● TubeArcObject
● TubeTeeObject

VB Scripting
● Tubepolyline
● WindowSlider *
Int32
Opcional. Valor o constante que define la transparencia del objeto en forma de porcentaje.
TransparentColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define qué color del gráfico asignado (*.bmp, *.dib) se ajustará a "transparente".
Para ello, determine además que el color se represente transparente mediante
"UseTransparentColor".
Sintaxis
Object.TransparentColor[=Color]
Object
● GraphicIOField
● GraphicView
Color
Opcional. Valor o constante que determina el color que se verá transparente.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
TransparentColorDeactivatedPicture (RT Professional)
Descripción
Determina qué color del objeto de mapa de bits asignado se pone en "transparent" para el
estado "Desactivado".
Sintaxis
Object.TransparentColorDeactivatedPicture[=Color]
Object
● RoundButton
Color
Opcional. Un valor o una constante que determina el color del objeto de mapa de bits asignado
que se pone en transparent" para el estado "Desactivado".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
La propiedad "PicDeactUseTransColor" debe tener el valor TRUE para que el color se ponga
en "transparent".
Consulte también
TransparentColorPictureOff (RT Professional)
Descripción
Determina qué color del objeto de mapa de bits asignado para el estado "Off" se pone en
transparent".
Sintaxis
Object.TransparentColorPictureOff[=Color]

VB Scripting
Object
● Button
● RoundButton *
Color
Opcional. Un valor o una constante que determina el color del objeto de mapa de bits asignado
que se pone en transparent" para el estado "Off".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TransparentColorPictureOn (RT Professional)
Descripción
Determina qué color del objeto de mapa de bits asignado para el estado "On" se pone en
transparent".
La propiedad "PicDownUseTransColor" debe tener el valor TRUE para que el color se ponga
en "transparent".
Sintaxis
Object.TransparentColorPictureOn[=Color]
Object
● Button
● RoundButton *
Color
Opcional. Valor o constante que determina el color del objeto de mapa de bits asignado que
se pone en "transparent" para el estado "On".

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TrendActualize (RT Professional)
Descripción
Define si se actualizará la curva seleccionada.
Sintaxis
Object.TrendActualize[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la curva seleccionada se actualiza siempre.
FALSE si la curva seleccionada no se actualiza. Este ajuste es útil si se compara una curva
archivada con una curva actual.
Consulte también
TrendAdd (RT Professional)
Descripción
Crea una curva nueva. La curva recién creada se referencia automáticamente mediante
"TrendIndex".

VB Scripting
Sintaxis
Object.TrendAdd[=STRING]
Object
STRING
Necesario. Valor o constante que define el nombre de la nueva curva mediante "TrendName".
TrendAutoRangeBeginTagName (RT Professional)
Descripción
Determina una variable que define el valor inicial del rango de datos de la curva. Mediante la
propiedad "TrendAutoRangeSource (Página 1111)" debe especificarse además la
determinación dinámica del rango de datos de la curva.
Sintaxis
Object.TrendAutoRangeBeginTagName[=STRING]
Object
STRING
Opcional. Valor o constante que determina la variable del valor inicial.
Consulte también
TrendAutoRangeBeginValue (RT Professional)
Descripción
Determina el valor inicial del rango de datos de la curva. Mediante la propiedad
"TrendAutoRangeSource (Página 1111)" debe especificarse además la determinación
estática del rango de datos de la curva.

VB Scripting
Sintaxis
Object.TrendAutoRangeBeginValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que determina el valor inicial del rango de datos de la curva.
Consulte también
TrendAutoRangeEndTagName (RT Professional)
Descripción
Determina una variable que define el valor final del rango de datos de la curva. Mediante la
propiedad "TrendAutoRangeSource (Página 1111)" debe especificarse además la
determinación dinámica del rango de datos de la curva.
Sintaxis
Object.TrendAutoRangeEndTagName[=STRING]
Object
STRING
Opcional. Valor o constante que determina la variable del valor final.
Consulte también

VB Scripting
TrendAutoRangeEndValue (RT Professional)
Descripción
Determina el valor final del rango de datos de la curva. Mediante la propiedad
"TrendAutoRangeSource (Página 1111)" debe especificarse además la determinación
estática del rango de datos de la curva.
Sintaxis
Object.TrendAutoRangeEndValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que determina el valor final del rango de datos de la curva.
Consulte también
TrendAutoRangeSource (RT Professional)
Descripción
Define cómo se determinará el área de datos automática de los datos de la curva.
Sintaxis
Object.TrendAutoRangeSource[=AutorangeSourceType]
Object
AutorangeSourceType
Opcional. Valor o constante que determina el tipo del rango de datos.

VB Scripting

x Adaptar automáticamente Determina que el rango de valores mostrado se adapte au‐
tomáticamente a los valores actuales.
1 Rango dinámico Determina que el límite inferior y el superior del rango de
valores mostrado se formen con los valores de las variables
online conectadas. Las variables del límite inferior y el supe‐
rior se representan en las propiedades "TrendAutoRangeBe‐
ginTagName (Página 1107)" y "TrendAutoRangeEndTagNa‐
me (Página 1108)".
2 Rango estático Determina que el rango de valores mostrado se establezca
mediante la configuración del límite inferior y el superior del
rango de valores. Los valores del límite inferior y el superior
se representan en las propiedades "TrendAutoRangeBegin‐
Value (Página 1107)" y "TrendAutoRangeEndValue (Pági‐
na 1109)".
TrendBeginTime (RT Professional)
Descripción
Define el inicio del rango de tiempo para el suministro de datos de la curva seleccionada.
Sintaxis
Object.TrendBeginTime[=DateTime]
Object
DateTime
Opcional. Define el instante de inicio para el suministro de datos de la curva seleccionada.
Consulte también
TrendColor (RT Professional)
Descripción
Define el color de la línea de una curva referenciada del visor de curvas.

VB Scripting
Sintaxis
Object.TrendColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de la línea de una curva referenciada en
el objeto.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TrendCount (RT Professional)
Descripción
Determina el número de curvas configuradas.
Sintaxis
Object.TrendCount[=Int32]
Object

VB Scripting
Int32
Opcional. Valor o constante que define el número de curvas configuradas.
Consulte también
TrendEndTime (RT Professional)
Descripción
Define el fin del intervalo de tiempo para la conexión de datos de la curva seleccionada.
Sintaxis
Object.TrendEndTime[=DateTime]
Object
DateTime
Opcional. Define el instante final para el suministro de datos de la curva seleccionada.
Consulte también
TrendExtendedColorSet (RT Professional)
Descripción
Define si se mostrarán el color de punto y el color de relleno de la curva.
Sintaxis
Object.TrendExtendedColorSet[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si los ajustes en "TrendFillColor (Página 1116)" y "TrendPointColor (Página 1124)" son
efectivos.
FALSE si los ajustes para color de punto y color de relleno no son efectivos.
Consulte también
TrendFill (RT Professional)
Descripción
Define si se debe mostrar rellena la superficie debajo de la curva.
Si "TrendExtendedColorSet (Página 1112)" se ajusta a "FALSE", el color de curva también
se utiliza como color de relleno.
Sintaxis
Object.TrendFill[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la superficie por debajo de la curva se muestra rellena.
FALSE si la curva no se muestra rellena.

VB Scripting
Consulte también
TrendFillColor (RT Professional)
Descripción
Define el color de relleno de la curva.
El ajuste será efectivo si las propiedades "TrendExtendedColorSet (Página 1112)" y
"TrendFill (Página 1113)" se ajustan a "TRUE".
Sintaxis
Object.TrendFillColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de relleno de la curva seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
TrendIndex (RT Professional)
Descripción
Hace referencia a una curva configurada. Para acceder a las propiedades de una curva, es
necesario activar "TrendIndex".
Los valores válidos para "TrendIndex" se encuentran entre 0 y "TrendCount" menos 1. La
propiedad "TrendCount" indica el número de curvas configuradas.
Sintaxis
Object.TrendIndex[=Int32]
Object
Int32
Opcional. Valor o constante que define a través del índice la curva que va a editarse.
Consulte también
TrendCount (Página 1111)
TrendIndicatorColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del visor de tendencias. El visor de tendencias representa con una pequeña
flecha la tendencia (ascendente o descendente) del valor medido que debe vigilarse. Para
activar el visor de tendencias, la propiedad "ShowTrendIndicator" debe tener el valor "TRUE".
Sintaxis
Object.TrendIndicatorColor[=Color]
Object
● Bar

VB Scripting
Color
Opcional. Un valor o una constante que determina el color del visor de tendencias.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
TrendLabel (RT Professional)
Descripción
Define el texto con el que se titulará la curva referenciada mediante "TrendIndex".
Sintaxis
Object.TrendLabel[=STRING]
Object
STRING
Opcional. Valor o constante que define el texto del título de la curva referenciada.
Consulte también

VB Scripting
TrendLineStyle (RT Professional)
Ejemplo
Define qué tipo de línea se utilizará para la representación de la curva.
Sintaxis
Object.TrendLineStyle[=LineStyle]
Object
LineStyle
Opcional. Valor o constante que determina el tipo de línea que se utiliza para representar la
curva.
Valor Explicación
0 La curva se muestra con una línea continua.
1 La curva se representa discontinua.
2 La curva se mostrará con una línea de puntos.
3 La curva se mostrará con una línea punto-raya.
4 La curva se mostrará con una línea punto punto raya.
Consulte también
TrendLineType (RT Professional)
Descripción
Define cómo se mostrará la curva.
Sintaxis
Object.TrendLineType[=TrendLineTypeScada]

VB Scripting
Object
TrendLineTypeScada
Opcional. Valor o constante que define cómo se mostrará la curva.
Valor Explicación
0 Solo se muestran los puntos de la curva.
1 Se mostrará una curva con los puntos enlazados linealmente.
2 Se mostrará una curva escalonada con los puntos enlazados linealmente.
Consulte también
TrendLineWidth (RT Professional)
Descripción
Define el grosor de línea en píxeles de la curva seleccionada.
Sintaxis
Object.TrendLineWidth[=Int32]
Object
Int32
Opcional. Valor o constante que define el grosor de línea en píxeles de la curva seleccionada.
Consulte también

VB Scripting
TrendLowerLimit (RT Professional)
Descripción
Indica el límite inferior de una variable que se visualiza como curva en el objeto. Si la variable
no alcanza el valor de "TrendLowerLimit", se marcarán los puntos correspondientes de la
curva con el color definido mediante "TrendLowerLimitColor (Página 1121)".
Para ello, especifique además, mediante la propiedad "TrendLowerLimitColoring
(Página 1122)", que la visualización del rebase por defecto del valor límite esté activada.
Sintaxis
Object.TrendLowerLimit[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que determina el valor límite inferior de una variable representada
en un visor de curvas.
Consulte también
TrendLowerLimitColor (RT Professional)
Descripción
Define el color que marcará los valores de curva que se encuentren por debajo del valor de
"TrendLowerLimit (Página 1119)".
El ajuste será efectivo si la propiedad "TrendLowerLimitColoring (Página 1122)" tiene el valor
"TRUE".
Sintaxis
Object.TrendLowerLimitColor[=Color]

VB Scripting
Object
Color
Opcional. Valor o constante que establece el color de los valores de curva situados por debajo
del valor de "TrendLowerLimit (Página 1119)".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
TrendLowerLimitColoring (RT Professional)
Descripción
Establece si se utilizará "TrendLowerLimitColor" para marcar los valores de variable que se
encuentren por debajo del valor "TrendLowerLimit".
Sintaxis
Object.TrendLowerLimitColoring[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la propiedad "TrendLowerLimitColor" es efectiva.
FALSE si la propiedad "TrendLowerLimitColor" no es efectiva.

VB Scripting
TrendMeasurePoints (RT Professional)
Descripción
Define el número de puntos de medida que se utilizará para representar la curva seleccionada.
Establece la cantidad de pares de valores si la curva serán suministrados a través del fichero
de usuario.
Sintaxis
Object.TrendMeasurePoints[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de puntos de medición o de pares de
valores de la curva seleccionada.
Consulte también
TrendName (RT Professional)
Descripción
Define el nombre de una curva referenciada mediante "TrendIndex".
Sintaxis
Object.TrendName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la curva referenciada.

VB Scripting
Consulte también
TrendPointColor (RT Professional)
Descripción
Define el color de los puntos de la curva referenciada.
El ajuste será efectivo si la propiedad "TrendExtendedColorSet (Página 1112)" tiene el valor
"TRUE".
Sintaxis
Object.TrendPointColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de los puntos de la curva referenciada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
TrendPointStyle (RT Professional)
Descripción
Define cómo se mostrarán los puntos en la curva.
Sintaxis
Object.TrendPointStyle[=PointStyle]
Object
PointStyle
Opcional. Valor o constante que define cómo se mostrarán los puntos en la curva.
Valor Explicación
0 No se visualizan los puntos. El ancho de punto configurado no tiene efecto.
1 Los puntos de la curva se mostrarán como puntos de un píxel de tamaño. El ancho de
punto configurado no tiene efecto.
2 Los puntos se mostrarán como cuadrados. El ancho de punto configurado tiene efecto.
3 Los puntos se mostrarán como círculos. El ancho de punto configurado tiene efecto.
Consulte también
TrendPointWidth (RT Professional)
Descripción
Establece el ancho de punto en píxeles. El ancho de punto solamente se puede configurar
para los tipos de punto "Cuadrados" y "Círculos".
Sintaxis
Object.TrendPointWidth[=Int32]

VB Scripting
Object
Int32
Opcional. Valor o constante que establece el ancho de punto en píxeles de la curva
seleccionada.
Consulte también
TrendProvider (RT Professional)
Descripción
Define el suministro de datos de la curva seleccionada.
Sintaxis
Object.TrendProvider[=DataSourceType]
Object
DataSourceType
Opcional. Valor o constante que define el suministro de datos de la curva seleccionada.

0 Ninguno No se ha configurado ningún suministro de datos para establecer una
conexión en runtime con un script de usuario.
1 Variables de fiche‐ Origen de datos con variables de fichero de un fichero de valores de
ro proceso.
2 Variables HMI Origen de datos con valores de variables HMI.
3 Datos de receta Origen de datos con columnas de una receta.

VB Scripting
Consulte también
TrendProviderCLSID (RT Professional)
Descripción
Define la CLSID de proveedor para los datos de una curva.
Sintaxis
Object.TrendProviderCLSID[=STRING]
Object
STRING
Opcional. Valor o constante que determina la CLSID de proveedor.
Valor Explicación
Ningún origen de datos configurado para establecer una conexión
vía script en runtime.
{416A09D2-8B5A-11D2-8B81-0 Origen de datos con variables de fichero de un fichero de valores
06097A45D48} de proceso.
{A3F69593-8AB0-11D2- Origen de datos con variables
A440-00A0C9DBB64E} online de la administración de variables.
{2DC9B1C8-4FC1-41B1- Origen de datos con columnas de un fichero de usuario.
B354-3E469A13FBFD}
Consulte también
TrendRangeType (RT Professional)
Descripción
Define el rango de tiempo en el que se suministrarán datos a la curva seleccionada.

VB Scripting
Mediante un suministro de datos mediante archivo de usuario solamente podrá establecer el

número de puntos de medición.
Sintaxis
Object.TrendRangeType[=TimeRangeMode]
Object
TimeRangeMode
Opcional. Valor o constante que define el rango de tiempo en que se suministrarán datos a
la curva seleccionada.

0 Intervalo de tiempo Para la conexión de datos se establecerá el momento de inicio
y el intervalo de tiempo.
1 Instante inicial a final Para la conexión de datos se establecerá el momento de inicio
y finalización.
2 Número de puntos de medi‐ Para la conexión de datos se establecerá el número de puntos
da de medida.
Consulte también
TrendRemove (RT Professional)
Descripción
Elimina una curva referenciada mediante su nombre.
Sintaxis
Object.TrendRemove[=STRING]
Object

VB Scripting
STRING
Opcional. Valor o constante que define el nombre de la curva referenciada que se borrará.
Consulte también
TrendRename (RT Professional)
Descripción
Define el nombre nuevo de una curva referenciada mediante "TrendIndex".
Sintaxis
Object.TrendRename[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nuevo nombre de la curva seleccionada.
Consulte también
TrendRepos (RT Professional)
Descripción
Define la posición de una curva referenciada mediante "TrendIndex" en la ventana de curvas
del objeto.
Si ha modificado la posición de la curva con "TrendRepos", a "TrendIndex" se le asignará el
valor de "TrendRepos".

VB Scripting
Sintaxis
Object.TrendRepos[=Int32]
Object
Int32
Opcional. Valor o constante que define la posición de la curva referenciada en la ventana de
curvas. Rango de valores de 0 a "TrendCount" menos 1. Los valores fuera de este rango de
0: La curva referenciada se posiciona delante.
Consulte también
TrendCount (Página 1111)
Trends (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
TrendSelectTagName (RT Professional)
Descripción
Determina que en runtime se muestre primero el cuadro de diálogo para seleccionar el nombre
de la variable del origen de los datos del eje de valores.
Sintaxis
Object.TrendSelectTagName[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si se muestra en la imagen el cuadro de diálogo para seleccionar el nombre de variable
del origen de los datos del eje de valores.
FALSE, si no se muestra en la imagen el cuadro de diálogo para seleccionar el nombre de
variable del origen de los datos del eje de valores.
TrendSelectTagNameX (RT Professional)
Descripción
Define que en runtime se muestre primero el cuadro de diálogo para seleccionar el nombre
de variable del origen de los datos del eje X.
Sintaxis
Object.TrendSelectTagNameX[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si en la imagen se muestra el cuadro de diálogo para seleccionar el nombre
de variable de la fuente de datos del eje X.
Consulte también
TrendSelectTagNameY (RT Professional)
Descripción
de variable del origen de los datos del eje Y.
Sintaxis
Object.TrendSelectTagNameY[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional. TRUE si en la imagen se muestra el cuadro de diálogo para seleccionar el nombre
de variable de la fuente de datos del eje Y.
Consulte también
TrendsForPrinting (RT Advanced)
Descripción
TrendTagName (RT Professional)
Descripción
Determina el nombre de la variable que suministra datos al eje de valores.
Sintaxis
Object.TrendTagName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la variable para el eje de valores.
TrendTagNameX (RT Professional)
Descripción
Define el nombre de las variables HMI o columnas asociadas para el eje X. Con el botón de
selección se selecciona una variable HMI o una columna.

VB Scripting
Sintaxis
Object.TrendTagNameX[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre de las variables HMI o la columna del
eje X.
Consulte también
TrendTagNameY (RT Professional)
Descripción
Define el nombre de las variables HMI o columnas asociadas para el eje Y. Con el botón de
selección se selecciona una variable HMI o una columna.
Sintaxis
Object.TrendTagNameY[=STRING]
Object
STRING
Opcional. Valor o constante que establece el nombre de la variable HMI o la columna del eje
Y.
Consulte también

VB Scripting
TrendTimeAxis (RT Professional)
Descripción
Define qué eje de tiempo se utilizará para la curva seleccionada.
Sintaxis
Object.TrendTimeAxis[=STRING]
Object
STRING
Opcional. Valor o constante que define el eje de tiempo de la curva seleccionada.
Consulte también
TrendTimeRangeBase (RT Professional)
Descripción
Define la unidad de tiempo para determinar rango de tiempo.
Sintaxis
Object.TrendTimeRangeBase[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
Opcional. Valor o constante que define la unidad de tiempo para determinar el rango de tiempo.
Valor Descripción
500 500 ms
1000 1 segundo

VB Scripting
Valor Descripción
60000 1 minuto
3600000 1 hora
86400000 1 día
Consulte también
TrendTimeRangeFactor (RT Professional)
Descripción
Establece el factor que determina el intervalo de tiempo del que se visualizará la curva
referenciada.
El intervalo se determina multiplicando el factor por la unidad de tiempo.
El ajuste se hará efectivo cuando esté ajustado el valor "0" para la propiedad
"TrendRangeType (Página 1125)".
Sintaxis
Object.TrendTimeRangeFactor[=Int32]
Object
Int32
Opcional. Valor o constante que establece el factor para determinar el intervalo de tiempo de
la curva referenciada.
TrendTrendWindow (RT Professional)
Descripción
Determina en qué ventana de curvas se mostrará la curva seleccionada.
Las ventanas de curvas disponibles se establecerán en la ficha "Ventana de curvas".
Sintaxis
Object.TrendTrendWindow[=STRING]

VB Scripting
Object
STRING
Opcional. Valor o constante que establece el nombre de la ventana de curvas para la curva
seleccionada.
Consulte también
TrendUncertainColor (RT Professional)
Descripción
Define el color de los valores con estado inseguro.
Sintaxis
Object.TrendUncertainColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de los valores con estado inseguro de la
curva seleccionada.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
TrendUncertainColoring (RT Professional)
Descripción
Define que se resalten los valores con estado inseguro.
Sintaxis
Object.TrendUncertainColoring[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se resaltan los valores con estado inseguro.
Consulte también
TrendUpperLimit (RT Professional)
Descripción
Define el límite superior de una variable que se representa como curva en un objeto dado. Si
la variable supera el valor de "TrendUpperLimit", se marcarán los puntos correspondientes de
la curva con el color definido mediante "TrendUpperLimitColor (Página 1138)".
Para ello, defina además mediante "TrendUpperLimitColoring (Página 1139)" que la indicación
del rebase por exceso del valor límite esté activada.
Sintaxis
Object.TrendUpperLimit[=DOUBLE]

VB Scripting
Object
DOUBLE
Opcional. Valor o constante que determina el valor límite superior para los valores de la curva
seleccionada.
Consulte también
TrendUpperLimitColor (RT Professional)
Descripción
Define el color que marcará los valores de curva que se encuentren por encima del valor de
"TrendUpperLimit (Página 1135)".
El ajuste es efectivo si "TrendUpperLimitColoring (Página 1139)" tiene el valor "TRUE".
Sintaxis
Object.TrendUpperLimitColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de los valores de curva situados por encima
del valor de "TrendUpperLimit (Página 1135)".
Observaciones
siguiente:

VB Scripting
RGB (255, 0, 0)
vbGreen.
Consulte también
TrendUpperLimitColoring (RT Professional)
Descripción
Define si el borde de selección se representará en el color definido por el sistema.
Sintaxis
Object.TrendUpperLimitColoring[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si la propiedad "TrendUpperLimitColor" es efectiva.
FALSE si la propiedad "TrendUpperLimitColor" no es efectiva.
Consulte también
TrendValueAlign (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
TrendValueAxis (RT Professional)
Descripción
Define qué eje de valores se utilizará para la curva seleccionada.
Sintaxis
Object.TrendValueAxis[=STRING]
Object
STRING
Opcional. Valor o constante que define el eje de valores de la curva seleccionada.
Consulte también
ValueAxisCount (Página 1192)
TrendValueUnit (RT Professional)
Descripción
Define para el tipo de curva "Mostrar valores" una unidad de valores que se añadirá al valor
que se va a mostrar, p. ej., "%" o "°C".
Sintaxis
Object.TrendValueUnit[=STRING]
Object
STRING
Opcional. Valor o constante que define la unidad de los valores del eje de valores.

VB Scripting
Consulte también
TrendVisible (RT Professional)
Descripción
Define si se mostrará la curva referenciada mediante "TrendIndex" en el objeto.
Sintaxis
Object.TrendVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra la curva referenciada.
FALSE si no se muestra la curva referenciada.
Consulte también
TrendWindowAdd (RT Professional)
Descripción
Crea un nuevo visor de curvas. El visor de curvas recién creado se referencia
automáticamente mediante "TrendWindowIndex".
Sintaxis
Object.TrendWindowAdd[=STRING]

VB Scripting
Object
STRING
Necesario. Valor o constante que define el nombre del nuevo visor de curvas mediante
"TrendWindowName".
Consulte también
TrendWindowIndex (Página 1147)
TrendWindowCoarseGrid (RT Professional)
Descripción
Define si se mostrarán las líneas de cuadrícula y la escala principal.
Sintaxis
Object.TrendWindowCoarseGrid[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran las líneas de cuadrícula de la escala principal.
FALSE si no se muestran las líneas de cuadrícula de la escala principal.
Consulte también

VB Scripting
TrendWindowCoarseGridColor (RT Professional)
Descripción
Define el color de la cuadrícula principal para el diagrama referenciado en el objeto.
Sintaxis
Object.TrendWindowCoarseGridColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de la cuadrícula principal para el diagrama
referenciado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TrendWindowCount (RT Professional)
Descripción
Define el número de diagramas de curva configurados en el visor de curvas.

VB Scripting
Sintaxis
Object.TrendWindowCount[=Int32]
Object
Int32
Opcional. Valor o constante que define el número de diagramas de curvas configurados en
el visor de curvas.
Consulte también
TrendWindowFineGrid (RT Professional)
Descripción
Define si se mostrarán las líneas de cuadrícula de la escala auxiliar.
Sintaxis
Object.TrendWindowFineGrid[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran las líneas de retícula de la escala auxiliar.
FALSE si no se muestran las líneas de retícula de la escala auxiliar.
Consulte también

VB Scripting
TrendWindowFineGridColor (RT Professional)
Descripción
Define el color de la cuadrícula auxiliar para el diagrama referenciado en el objeto.
Sintaxis
Object.TrendWindowFineGridColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de la cuadrícula auxiliar para el diagrama
referenciado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TrendWindowForegroundTrendGrid (RT Professional)
Descripción
Define si se mostrarán solamente las líneas de cuadrícula para la curva de primer plano de
la ventana de curvas seleccionada.

VB Scripting
Sintaxis
Object.TrendWindowForegroundTrendGrid[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran las líneas de cuadrícula de la curva de primer plano de la ventana de
curvas.
FALSE si se muestran las líneas de cuadrícula de todas las curvas de la ventana de curvas.
Consulte también
TrendWindowGridInTrendColor (RT Professional)
Descripción
Define si se mostrarán las líneas de cuadrícula de la escala principal en el color de la curva.
Sintaxis
Object.TrendWindowGridInTrendColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si las líneas de la cuadrícula se muestran con el color de la curva.
FALSE si las líneas de la cuadrícula se muestran con el color configurado en
"TrendWindowCoarseGridColor (Página 1141)".

VB Scripting
Consulte también
TrendWindowHorizontalGrid (RT Professional)
Descripción
Determina si se mostrarán las líneas de cuadrícula horizontales.
Sintaxis
Object.TrendWindowHorizontalGrid[=BOOLEAN]
Object
BOOLEAN
TRUE: Se mostrarán las líneas de retícula horizontales.
FALSE: No se mostrarán las líneas de retícula horizontales.
Consulte también
TrendWindowIndex (RT Professional)
Descripción
Hace referencia a un visor de curvas. Para acceder a las propiedades de un visor de curvas
es necesario activar "TrendWindowIndex".
Los valores válidos para "TrendWindowIndex" se encuentran entre 0 y "TrendWindowCount"
menos 1. La propiedad "TrendWindowCount" indica el número de visores de curvas
configurados.
Sintaxis
Object.TrendWindowIndex[=Int32]

VB Scripting
Object
Int32
Opcional. Valor o constante que define a través del índice el visor de curvas que va a editarse.
Consulte también
TrendWindowName (RT Professional)
Descripción
Define el nombre de un visor de curvas referenciado mediante "TrendWindowIndex".
Sintaxis
Object.TrendWindowName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del visor de curvas referenciado.
Consulte también

VB Scripting
TrendWindowRemove (RT Professional)
Descripción
Elimina un visor de curvas referenciado mediante su nombre.
Sintaxis
Object.TrendWindowRemove[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre del visor de curvas referenciado que se
borrará.
Consulte también
TrendWindowRename (RT Professional)
Descripción
Define el nombre nuevo de un visor de curvas referenciado mediante "TrendWindowIndex".
Sintaxis
Object.TrendWindowRename[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nuevo nombre de la ventana de curvas
seleccionada.

VB Scripting
Consulte también
TrendWindowRepos (RT Professional)
Descripción
Define la posición de un visor de curvas referenciado mediante "TrendWindowIndex".
Si ha modificado la posición del visor de curvas con "TrendWindowRepos", a
"TrendWindowIndex" se le asignará el valor de "TrendWindowRepos".
Sintaxis
Object.TrendWindwRepos[=Int32]
Object
Int32
Opcional. Valor o constante que define la posición del visor de curvas referenciado. Rango
de valores de 0 a "TrendWindowCount" menos 1. Los valores fuera de este rango de valores
no tienen ningún efecto.
0: El visor de curvas referenciado se posiciona delante.
Consulte también
TrendWindowRulerColor (RT Professional)
Descripción
Define el color de la regla.

VB Scripting
"TrendWindowRulerStyle (Página 1152)".
Sintaxis
Object.TrendWindowRulerColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de la regla.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
TrendWindowRulerLayer (RT Professional)
Descripción
Define el nivel de representación de la regla en el visor de curvas.
Sintaxis
Object.TrendWindowRulerLayer[=RulerLayer]

VB Scripting
Object
RulerLayer
Opcional. Valor o constante que define el nivel de representación de la regla en el visor de
curvas.
Valor Explicación
0 La imagen se situará detrás de la retícula.
1 La imagen se situará detrás de las curvas y delante de la retícula.
2 La regla se situará delante de las curvas.
Consulte también
TrendWindowRulerStyle (RT Professional)
Descripción
Define la representación de la regla.
Sintaxis
Object.TrendWindowRulerStyle[=RulerStyle]
Object
RulerStyle
Opcional. Valor o constante que define cómo se mostrará la regla.
Valor Explicación
0 La regla se muestra como una línea negra sencilla.
1 La regla se muestra con el color y el grosor de línea configurados.

VB Scripting
Consulte también
TrendWindowRulerWidth (RT Professional)
Descripción
Define en píxeles el grosor de la regla.
"TrendWindowRulerStyle (Página 1150)".
Sintaxis
Object.TrendWindowRulerWidth[=Int32]
Object
Int32
Opcional. Valor o constante que determina el grosor en píxeles de la regla.
Consulte también
TrendWindows (RT Professional)
Descripción
TrendWindowSpacePortion (RT Professional)
Descripción
Define la proporción del área del diagrama referenciado en el área de diagramas del objeto.

VB Scripting
Sintaxis
Object.TrendWindowSpacePortion[=Int32]
Object
Int32
Opcional. Valor o constante que determina la proporción del diagrama referenciado en el área
de diagramas del objeto.
Observaciones
La altura de cada proporción del área se calcula partiendo del número total de proporciones.
Si, por ejemplo, se ha configurado un total de tres diagramas, con una proporción de "1"
respectivamente se obtendrán tres diagramas de igual tamaño. Para ampliar la proporción
relativa entre los diagramas, aumente la proporción de uno o varios de ellos.
Consulte también
TrendWindowStatisticRulerColor (RT Professional)
Descripción
Define el color de la regla de estadísticas. Mediante la propiedad
"TrendWindowStatisticRulerStyle (Página 1155)" debe especificarse además que la regla de
estadísticas pueda configurarse gráficamente.
Sintaxis
Object.TrendWindowStatisticRulerColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de la regla de estadísticas.

VB Scripting
Observaciones
RGB (255, 0, 0)
vbGreen.
Consulte también
TrendWindowStatisticRulerStyle (RT Professional)
Descripción
Define la posibilidad de configurar gráficamente las líneas para definir el área de estadísticas
en la ventana de curvas.
Sintaxis
Object.TrendWindowStatisticRulerStyle[=RulerStyle]
Object
RulerStyle
Opcional. Valor o constante que determina la posibilidad de configurar gráficamente la regla
de estadísticas.

0 Simple La regla se mostrará como una línea negra simple.
1 Gráfico La regla se mostrará con el color y el grosor de línea confi‐
gurados.
Consulte también

VB Scripting
TrendWindowStatisticRulerWidth (RT Professional)
Descripción
Define el grosor de línea de la regla de estadísticas. Mediante la propiedad
"TrendWindowStatisticRulerStyle (Página 1153)" debe especificarse además que la regla de
estadísticas pueda configurarse gráficamente.
Sintaxis
Object.TrendWindowStatisticRulerWidth[=Int32]
Object
Int32
Opcional. Valor o constante que determina el grosor de línea de la regla de estadísticas.
Consulte también
TrendWindowVerticalGrid (RT Professional)
Descripción
Define si se mostrarán las líneas de cuadrícula verticales.
Sintaxis
Object.TrendWindowVerticalGrid[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestran las líneas de cuadrícula verticales.
FALSE si no se visualizan las líneas de cuadrícula verticales.

VB Scripting
Consulte también
TrendWindowVisible (RT Professional)
Descripción
Define si se muestra el visor de curvas referenciado mediante "TrendWindowIndex".
Sintaxis
Object.TrendWindowVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra el visor de curvas referenciado.
FALSE si no se muestra el visor de curvas referenciado.
Consulte también
TrendXAxis (RT Professional)
Descripción
Determina qué eje X se utilizará para la curva referenciada.
Sintaxis
Object.TrendXAxis[=STRING]

VB Scripting
Object
STRING
Opcional. Valor o constante que define el nombre del eje X utilizado para la curva referenciada.
Consulte también
TrendYAxis (RT Professional)
Descripción
Determina qué eje Y se utilizará para la curva referenciada.
Sintaxis
Object.TrendYAxis[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje Y utilizado para la curva referenciada.
Consulte también

VB Scripting
1.5.5.14 Propiedades U-W (Panels, Comfort Panels, RT Advanced, RT Professional)
Unit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la unidad de medida.
Sintaxis
Object.Unit[=STRING]
Object
● Bar
● IOField
STRING
Opcional. Valor o constante que determina la unidad de medida.
Consulte también
Bar (Página 261)
UnitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de texto del nombre de la unidad de medida.
Sintaxis
Object.UnitColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color de texto de la unidad de medida.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)
UnitFont (RT Professional)
Descripción
Define la fuente de la unidad de medida.
Sintaxis
Object.UnitFont[=Font]
Object
● Gauge
Font
Consulte también
Gauge (Página 324)
UnitText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el texto para la unidad de medida.

VB Scripting
Sintaxis
Object.UnitText[=STRING]
Object
● Gauge
STRING
Opcional. Valor o constante que determina el texto de la unidad de medida.
Observaciones
Introduzca un texto para mostrar, p. ej., la unidad física del valor representado.
Consulte también
Gauge (Página 324)
UnitTop (RT Professional)
Descripción
Define la distancia de la unidad de medida respecto del borde superior del objeto. El texto
solo puede posicionarse a lo largo del diámetro vertical del escala circular. El valor de la
propiedad hace referencia a la altura del objeto y se mide desde el borde superior del objeto
hasta el borde inferior del texto.
Sintaxis
Object.UnitTop[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Valor o constante que determina la distancia de la unidad de medida respecto del
borde superior del objeto.
Valor Explicación
0 el borde inferior del texto se encuentra sobre la delimitación superior del objeto indicado.
El texto ya no se ve porque se encuentra fuera.
1 El borde inferior del texto se encuentra sobre la delimitación inferior.

VB Scripting
Consulte también
Gauge (Página 324)
UnitViewColumnOrder (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UpdateButtonVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UpperLimit (RT Professional)
Descripción
Determina el valor límite superior para valores de entrada.
Sintaxis
Object.UpperLimit[=DOUBLE]
Object
● IOField
DOUBLE
Opcional. Un valor o una constante que determina el valor límite superior para valores de
entrada.
Consulte también
UseAutoScaling (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UseButtonFirstGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseButtonSecondGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseColumnBackColor (RT Professional)
Descripción
Define los ajustes del color de fondo de las columnas.
Sintaxis
Object.UseColumnBackColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se utiliza el color de fondo que se ha configurado en "TableColor (Página 1000)".
FALSE si se utiliza el color de fondo que se ha configurado para las columnas del visor de
tablas.
Consulte también
UseColumnForeColor (RT Professional)
Descripción
Define los ajustes del color de fuente de las columnas.

VB Scripting
Sintaxis
Object.UseColumnForeColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se utiliza el color de fuente que se ha determinado mediante "TableForeColor
(Página 1003)".
FALSE, si se utiliza el color de fuente que se ha determinado para las columnas del visor de
tablas.
Consulte también
UseCurserKeyScroll (RT Advanced)
Descripción
Consulte también
Used (RT Professional)
Descripción
Devuelve el tamaño de la memoria ocupada.
Sintaxis
Object.Used[=DOUBLE]
Object
● DiscSpaceView

VB Scripting
DOUBLE
Opcional. Un valor o una constante que devuelve el tamaño de la memoria ocupada.
Consulte también
UseDesignColorSchema (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si los colores definidos en el esquema cromático global del diseño actual se utilizarán
para este objeto.
Acceso en runtime:
Sintaxis
Object.UseDesignColorSchema[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicView
● IOField
● Line

VB Scripting
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton*
● Slider*
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowSlider*

● AlarmView
● DateTimeField
● RecipeView
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
BOOLEAN
Opcional.
TRUE si el objeto se representa con los colores del Esquema cromático global definido para
este tipo de objeto.
FALSE si el objeto se representa con los colores correspondientes a la configuración del
objeto.

VB Scripting
UseDesignShadowSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el objeto se representará con el sombreado global. El sombreado global se ha
definido en el diseño actual.
Sintaxis
Object.UseDesignShadowSettings[=BOOLEAN]
Object
● Bar
● Button
● CheckBox
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Connector
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polyline
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TubeArcObject

VB Scripting
● TubeTeeObject
● Tubepolyline
● WindowSlider
● CircleSegment
BOOLEAN
Opcional.
TRUE si el objeto se representará con el sombreado global establecido para este tipo de
objeto.
FALSE si el objeto se representará sin sombra.
Consulte también
Line (Página 341)
Bar (Página 261)
Clock (Página 290)
Gauge (Página 324)

VB Scripting

UsedPercent (RT Professional)
Descripción
Determina el porcentaje de los valores medidos de la memoria ocupada. Los valores pueden
consultarse en runtime. Los valores no pueden predefinirse.
Sintaxis
Object.UsedPercent[=Int32]
Object
● DiscSpaceView
Int32
Opcional. Un valor o una constante que devuelve en porcentaje los valores medidos de la
memoria ocupada.
Consulte también
UseExponentialFormat (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si los números se representan con exponentes (p. ej., "1,00e+000").

VB Scripting
Sintaxis
Object.UseExponentialFormat[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si los números se representan con exponentes (p. ej., "1,00e+000").
Consulte también
Bar (Página 261)
UseFirstGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseFlashTransparentColor (RT Professional)
Descripción
Determina si el color del objeto de mapa de bits de una imagen intermitente se establece en
"transparent".
Sintaxis
Object.UseFlashTransparentColor[=BOOLEAN]
Object
● "GraphicIOField"
BOOLEAN
Opcional. TRUE si el color del objeto de mapa de bits de una imagen intermitente se ajusta
a "transparent".
Consulte también

VB Scripting
UseMessageColor (RT Professional)
Descripción
Determina si deben mostrarse los colores acordados para las categorías.
Sintaxis
Object.UseMessageColor [=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se muestran los colores.
FALSE si son efectivos en la ficha "Representación" los ajustes de color que se han indicado
para el contenido de la tabla.
Consulte también
UserData (Professional) (RT Professional)
Descripción
Define el valor que se transfiere al script VB al ejecutar un icono u opción de menú definidos
por el usuario.
Utilice en el editor "Menús y barras de herramientas" el campo "Datos" para transferir un
parámetro al procedimiento.
Sintaxis
Object.UserData[=String]
Object
Se necesita. Un objeto del tipo "Item".

VB Scripting
String
Opcional. Un valor o una constante que se transfiere al script VB al ejecutar un icono u opción
de menú definidos por el usuario.
Ejemplo
El siguiente ejemplo muestra el script "ChangeScreen", que se ejecuta al hacer clic en una
opción de menú definida por el usuario. Con el campo "Datos" se transfiere el nombre de la
imagen al script.
Sub ChangeScreen (ByVal Item)

Dim objScreen, strScreenName
' "UserData" contains the screen name specified
' in editor menus and toolbars.
strScreenName = Item.Userdata
HMIRuntime.BaseScreenName = strScreenName
End Sub
UserName (RT Professional)
Descripción
Devuelve el nombre del usuario que habilitó el objeto Alarm.
UseScadaRendererStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseSecondGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseSelectedTitleColor (RT Professional)
Descripción
Define si se utilizará un color de selección para los títulos de las celdas de tabla
seleccionadas.

VB Scripting
Sintaxis
Object.UseSelectedTitleColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se utiliza un color de selección. Los ajustes de "Fondo" y "Fuente" serán efectivos
en runtime.
FALSE si no se utiliza un color de selección. Los ajustes de "Fondo" y "Fuente" no serán
efectivos en runtime.
Consulte también
UseSourceBackColors (RT Professional)
Descripción
Determina que se utilice el color de fondo del origen de los datos.
Sintaxis
Object.UseSourceBackColors[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se utiliza el color de fondo del visor de curvas o de tablas conectado.

VB Scripting
FALSE si se utiliza el color de fondo configurado en la tabla de valores.
Consulte también
UseSourceForeColors (RT Professional)
Descripción
Determina que se utilice el color de fuente del origen de los datos.
Sintaxis
Object.UseSourceForeColors[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se utiliza el color de fuente del visor de curvas o de tablas conectado.
FALSE si se utiliza el color de fuente configurado en la tabla de valores.
Consulte también
UseSystemScrollbarWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseTableColor2 (RT Professional)
Descripción
Define si se utilizará un segundo color de fila en la representación de la tabla.

VB Scripting
Sintaxis
Object.UseTableColor2[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si los colores de fondo de "TableColor (Página 1000)" y "TableColor2 (Página 1001)"
se utilizan alternativamente.
FALSE si los colores de fondo de "TableColor (Página 1000)" se utilizan para todas las líneas.
Consulte también
TableColor2 (Página 1001)
UseTableHeaderFirstGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseTableHeaderSecondGradient (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UseTagLimitColors (RT Professional)
Descripción
Determina si el rebase por exceso o por defecto de los valores límite configurados para el
objeto se resaltará en color.
Sintaxis
Object.UseTagLimitColors[=BOOLEAN]
Object
● IOField
BOOLEAN
Opcional. TRUE si los valores límite se destacan en color.
Consulte también
UseTransparentColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el color definido con la propiedad "TransparentColor" debe verse transparente.
Sintaxis
Object.UseTransparentColor[=BOOLEAN]
Object
● GraphicIOField
● GraphicView
BOOLEAN
Opcional. TRUE si el color definido se muestra transparente.

VB Scripting
Consulte también
UseTransparentColorDeactivatedPicture (RT Professional)
Descripción
Determina si el color transparente determinado con la propiedad
"TransparentColorDeactivatedPicture" se utiliza para el estado "Desactivado".
Sintaxis
Object.UseTransparentColorDeactivatedPicture[=BOOLEAN]
Object
● RoundButton
BOOLEAN
Opcional. TRUE si el color transparente determinado con la propiedad
"TransparentColorDeactivatedPicture" se utiliza para el estado "Desactivado".
Consulte también
UseTransparentColorPictureOff (RT Professional)
Descripción
Determina si el color transparente determinado con la propiedad "TransparentColorPictureOff"
se utiliza para el estado "Off".
Sintaxis
Object.UseTransparentColorPictureOff[=BOOLEAN]

VB Scripting
Object
● Button
● RoundButton*
BOOLEAN
"TransparentColorPictureOff" se utiliza para el estado "Off".
UseTransparentColorPictureOn (RT Professional)
Descripción
Determina si el color transparente determinado con la propiedad "TransparentColorPictureOn"
se utiliza para el estado "On".
Sintaxis
Object.UseTransparentColorPictureOn[=BOOLEAN]
Object
● Button
● RoundButton*
BOOLEAN
"TransparentColorPictureOn" se utiliza para el estado "On".
UseTrendNameAsLabel (RT Professional)
Descripción
Define si las propiedades "Nombre" o "Rotulación" se utilizarán como nombre de la curva en
runtime.
Sintaxis
Object.UseTrendNameAsLabel[=BOOLEAN]

VB Scripting
Object
BOOLEAN
Opcional.
TRUE si se utiliza el nombre configurado en "Propiedades > Propiedades > Curvas > Nombre".
FALSE si se utiliza el nombre configurado en "Propiedades > Propiedades > Curvas >
Rotulación".
Consulte también
UseTwoHandOperation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UseUdp (RT Professional)
Descripción
UV_ColumnWidth_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UV_ColumnWidth_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UV_ColumnWidth_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UV_ColumnWidth_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_InstallationDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_LADDR (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UV_ShowItem_Name (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_OKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_OperationState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_OrderID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_ProfileID (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_Rack (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_Slot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UV_ShowItem_SoftwareRevision (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_SpecificProfileData (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_State (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_Station (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_SubAddress (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_SubSlot (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ShowItem_SubSystem (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

VB Scripting
UV_ShowItem_Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Value (RT Professional)
Descripción
Define o devuelve un valor según el objeto utilizado.
Sintaxis
Object.Value[=VARIANT]
Object
Obligatorio. Un objeto del tipo "Tag", "DataItem" o "ScreenItem" con la apariencia "Gauge".
VARIANT
Opcional. El valor que se define según el objeto utilizado:
● Tag.Value: devuelve el valor de variable del último acceso de lectura o define el futuro
valor de variable. Para leer el valor de variable de la propiedad "Value" se utiliza el método
"Read". El método "Write" asigna un nuevo valor de variable a la propiedad "Value".
● Dataset.Value: define un valor o devuelve una copia del valor o de la referencia de objeto.
Al devolver referencias de objetos, asegúrese de que las referencias sean aptas para
multithread.
● ScreenItem("Gauge_1").Value: define el valor que indica el puntero del indicador gauge.
Rango de valores dentro de los valores ajustados mediante las propiedades "ValueMin" y
"ValueMax".
Ejemplos
El siguiente ejemplo escribe un nuevo valor en la variable "Tag1":
'VBS94
Dim objTag
objTag.Value = 50
objTag.Write

VB Scripting
El ejemplo muestra la forma de incluir un valor en un listado de variables y emitirlo como Trace.
A continuación el valor es modificado, nuevamente emitido y luego eliminado. Esto tiene lugar
en diferentes acciones:
'VBS198
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.DataSet("motor1").Value = 55
Consulte también
DataItem (Página 205)
Tag (Página 230)
Gauge (Página 324)
ValueAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ValueAxis1AutoRange (RT Advanced)
Descripción
ValueAxis1Begin (RT Advanced)
Descripción
ValueAxis1End (RT Advanced)
Descripción

VB Scripting
ValueAxis1LabelLength (RT Advanced)
Descripción
ValueAxis1Style (RT Advanced)
Descripción
ValueAxis2AutoRange (RT Advanced)
Descripción
ValueAxis2Begin (RT Advanced)
Descripción
ValueAxis2End (RT Advanced)
Descripción
ValueAxis2LabelLength (RT Advanced)
Descripción
ValueAxis2Style (RT Advanced)
Descripción

VB Scripting
ValueAxisAdd (RT Professional)
Descripción
Crea un nuevo eje de valores. El eje de valores recién creado se referencia automáticamente
mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisAdd[=STRING]
Object
STRING
Necesario. Valor o constante que determina el nombre del nuevo eje de valores mediante
"ValueAxisName".
Consulte también
ValueAxisIndex (Página 1193)
ValueAxisAlignment (RT Professional)
Descripción
Define la alineación del eje de valores referenciado mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisAlignment[=AxisAlignment]
Object

VB Scripting
AxisAlignment
Opcional. Valor o constante que define la alineación del eje de valores.

0 Izquierda El eje de valores seleccionado se mostrará a la izquierda de la curva.
1 Derecha El eje de valores seleccionado se mostrará a la derecha de la curva.
Consulte también
ValueAxisAutoPrecisions (RT Professional)
Descripción
Define si se determinará automáticamente el número de decimales de un eje de valores
referenciado mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Opcional.
FALSE si se utiliza el valor de "ValueAxisPrecisions".
Consulte también
ValueAxisPrecisions (Página 1196)

VB Scripting
ValueAxisAutoRange (RT Professional)
Descripción
Define si se determinará automáticamente el rango de valores de un eje de valores
referenciado mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el rango de valores se define automáticamente.
FALSE si el rango de valores se define mediante "ValueAxisBeginValue" y
"ValueAxisEndValue".
Consulte también
ValueAxisBeginValue (Página 1190)
ValueAxisEndValue (Página 1192)
ValueAxisBeginValue (RT Professional)
Descripción
Define el punto inferior del rango de valores de un eje de valores referenciado mediante
"ValueAxisIndex".
Ajuste además "ValueAxisAutoRange" a "FALSE".
Sintaxis
Object.ValueAxisBeginValue[=DOUBLE]

VB Scripting
Object
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje de valores
referenciado.
Consulte también
ValueAxisAutoRange (Página 1188)
ValueAxisColor (RT Professional)
Descripción
Define el color de un eje de valores referenciado mediante "ValueAxisIndex". Esta propiedad
se evalúa solo si la propiedad "ValueAxisInTrendColor (Página 1194)" está ajustada a
"FALSE".
Sintaxis
Object.ValueAxisColor[=Color]
Object
Color
Opcional. Valor o constante que define el color del eje de valores.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.

VB Scripting
Consulte también
ValueAxisCount (RT Professional)
Descripción
Define el número de ejes de valores configurados.
Sintaxis
Object.ValueAxisCount[=Int32]
Object
Int32
Opcional. Valor o constante que define el número de ejes de valores configurados.
Consulte también
ValueAxisEndValue (RT Professional)
Descripción
Define el punto superior del rango de valores de un eje de valores referenciado mediante
"ValueAxisIndex".
Ajuste además "ValueAxisAutoRange" a "FALSE".
Sintaxis
Object.ValueAxisEndValue[=DOUBLE]
Object

VB Scripting
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje de valores
referenciado.
Consulte también
ValueAxisAutoRange (Página 1188)
ValueAxisExponentialFormat (RT Professional)
Descripción
Determina si los valores de un eje de valores referenciado mediante "ValueAxisIndex" se
mostrarán en representación exponencial.
Sintaxis
Object.ValueAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Opcional.
Consulte también
ValueAxisIndex (RT Professional)
Descripción
Hace referencia a un eje de valores. Para acceder a las propiedades de un eje de valores, es
necesario activar "ValueAxisIndex".

VB Scripting
Los valores válidos para "ValueAxisIndex" se encuentran entre 0 y "ValueAxisCount" menos

1. La propiedad "ValueAxisCount" indica el número de ejes de valores configurados.
Sintaxis
Object.ValueAxisIndex[=Int32]
Object
Int32
Opcional. Valor o constante que define a través del índice el eje de valores que va a editarse.
Consulte también
ValueAxisInTrendColor (RT Professional)
Descripción
Define si el color del eje referenciado mediante "ValueAxisIndex" debe corresponderse con
el color de la curva.
Sintaxis
Object.ValueAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se debe mostrar el eje referenciado con el color de la curva. El valor de
"ValueAxisColor" no es efectivo.
FALSE si debe mostrarse el eje referenciado con el color determinado en "ValueAxisColor".

VB Scripting
Consulte también
ValueAxisLabel (RT Professional)
Descripción
Determina el texto con el que se rotulará un eje de valores referenciado mediante
"ValueAxisIndex".
Sintaxis
Object.ValueAxisLabel[=STRING]
Object
STRING
Opcional. Valor o constante que define el texto de rotulación del eje de valores referenciado.
Consulte también
ValueAxisName (RT Professional)
Descripción
Define el nombre de un eje de valores referenciado mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisName[=STRING]
Object

VB Scripting
STRING
Opcional. Valor o constante que define el nombre del eje de valores referenciado.
Consulte también
ValueAxisPrecisions (RT Professional)
Descripción
Define el número de decimales para la rotulación del eje de valores referenciado mediante
"ValueAxisIndex".
Sintaxis
Object.ValueAxisPrecisions[=Int16]
Object
Int16
Consulte también
ValueAxisRemove (RT Professional)
Descripción
Elimina un eje de valores referenciado mediante su nombre.
Sintaxis
Object.ValueAxisRemove[=STRING]

VB Scripting
Object
STRING
Opcional. Valor o constante que define el nombre del eje de valores referenciado que se
borrará.
Consulte también
ValueAxisRename (RT Professional)
Descripción
Define el nombre nuevo de un eje de valores referenciado mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisRename[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nuevo nombre del eje de valores.
Consulte también
ValueAxisRepos (RT Professional)
Descripción
Define la posición de un eje de valores referenciado mediante "ValueAxisIndex".
Si ha modificado la posición del eje de valores con "ValueAxisRepos", a "ValueAxisIndex" se
le asignará el valor de "ValueAxisRepos".

VB Scripting
Sintaxis
Object.ValueAxisRepos[=Int32]
Object
Int32
Opcional. Valor o constante que define la posición del eje de valores referenciado. Rango de
valores de 0 a "ValueAxisCount" menos 1. Los valores fuera de este rango de valores no
tienen ningún efecto.
0: El eje de valores referenciado se posiciona fuera.
Consulte también
ValueAxisScalingType (RT Professional)
Descripción
Define el tipo de escala del eje de valores referenciado mediante "ValueAxisIndex".
Sintaxis
Object.ValueAxisScalingType[=AxisScalingType]
Object
AxisScalingType
Opcional. Valor o constante que define el tipo de escala del eje de valores referenciado.
Valor Constante VB Nombre

0 hmiBarScalingLinear Lineal
1 hmiBarScalingLogarithmic Logarítmico
2 hmiBarScalingNegativeLogarithmic Logarítmico negativo

VB Scripting
Consulte también
ValueAxisTrendWindow (RT Professional)
Descripción
Define el diagrama de curvas en el que se mostrará el eje referenciado mediante
"ValueAxisIndex".
Sintaxis
Object.ValueAxisTrendWindow[=STRING]
Object
STRING
Consulte también
ValueAxisVisible (RT Professional)
Descripción
Define si se mostrará el eje de valores referenciado mediante "ValueAxisIndex" en el objeto.
Sintaxis
Object.ValueAxisVisible[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si se visualiza el eje de valores referenciado.
FALSE si no se visualiza el eje de valores referenciado.
Consulte también
ValueCaption (RT Advanced)
Descripción
ValueColumnAdd (RT Professional)
Descripción
Crea una nueva columna de valores. La columna de valores recién creada se referencia
automáticamente mediante "ValueColumnIndex".
Sintaxis
Object.ValueColumnAdd[=STRING]
Object
STRING
Necesario. Valor o constante que define el nombre de la nueva columna de valores mediante
"ValueColumnName".
Consulte también
ValueColumnIndex (Página 1206)

VB Scripting
ValueColumnAlignment (RT Professional)
Descripción
Define cómo se alineará el texto dentro la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnAlignment[=HorizontalAlignment]
Object
HorizontalAlignment
Opcional. Valor o constante que define cómo se alinea el texto dentro de la columna de valores
referenciada.

0 hmiAlignmentLeft El texto se alinea a la izquierda.
1 hmiAlignmentCentered El texto se centra.
2 hmiAlignmentRight El texto se alinea a la derecha.
Consulte también
ValueColumnAutoPrecisions (RT Professional)
Descripción
Define si se definirá automáticamente el número de decimales de una columna de valores
Sintaxis
Object.ValueColumnAutoPrecisions[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
FALSE si se utiliza el valor de "ValueColumnPrecisions".
Consulte también
ValueColumnPrecisions (Página 1208)
ValueColumnBackColor (RT Professional)
Descripción
Define el color de fondo de la columna de valores referenciada mediante "ValueColumnIndex".
Ajuste además "UseColumnBackColor (Página 1161)" a "TRUE".
Sintaxis
Object.ValueColumnBackColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de fondo.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
ValueColumnCaption (RT Professional)
Descripción
Define el nombre de la columna de valores referenciada mediante "ValueColumnIndex".
Sintaxis
Object.ValueColumnCaption[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la columna de valores.
Consulte también
ValueColumnCount (RT Professional)
Descripción
Define el número de columnas de valores configuradas.
Sintaxis
Object.ValueColumnCount[=Int32]
Object
Int32
Opcional. Valor o constante que define el número de columnas de valores configuradas.
Consulte también

VB Scripting
ValueColumnExponentialFormat (RT Professional)
Descripción
Define si los valores de una columna de valores referenciada mediante "ValueColumnIndex"
se mostrarán en representación exponencial.
Sintaxis
Object.ValueColumnExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Opcional.
Consulte también
ValueColumnForeColor (RT Professional)
Descripción
Define el color de fuente de la columna de valores referenciada mediante
"ValueColumnIndex".
Ajuste además "UseColumnForeColor (Página 1161)" a "TRUE".
Sintaxis
Object.ValueColumnForeColor[=Color]
Object

VB Scripting
Color
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
ValueColumnHideText (RT Professional)
Descripción
Define si se ocultará el texto de la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnHideText[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el texto de la columna de valores está oculto.
FALSE si el texto de la columna de valores es visible.
Consulte también

VB Scripting
ValueColumnHideTitleText (RT Professional)
Descripción
Define si se ocultará el texto del título de la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnHideTitleText[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el texto del título de la columna de valores está oculto.
FALSE si el texto del título de la columna de valores es visible.
Consulte también
ValueColumnIndex (RT Professional)
Descripción
Hace referencia a una columna de valores. Para acceder a las propiedades de una columna
de valores, es necesario activar "ValueColumnIndex".
Los valores válidos para "ValueColumnIndex" se encuentran entre 0 y "ValueColumnCount"
menos 1. La propiedad "ValueColumnCount" indica el número de columnas de valores
configuradas.
Sintaxis
Object.ValueColumnIndex[=Int32]
Object

VB Scripting
Int32
Opcional. Valor o constante que define a través del índice la columna de valores que va a
editarse.
Consulte también
ValueColumnCount (Página 1201)
ValueColumnLength (RT Professional)
Descripción
Define el ancho de la columna de valores referenciada mediante "ValueColumnIndex" en
número de caracteres.
Sintaxis
Object.ValueColumnLength[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de caracteres mostrados.
Consulte también
ValueColumnName (RT Professional)
Descripción
Define el nombre de una columna de valores referenciada mediante "ValueColumnIndex".
Sintaxis
Object.ValueColumnName[=STRING]

VB Scripting
Object
STRING
Opcional. Valor o constante que define el nombre de la columna de valores referenciada.
Consulte también
ValueColumnPrecisions (RT Professional)
Descripción
Define el número de decimales de los valores de la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnPrecisions[=Int16]
Object
Int16
Consulte también
ValueColumnProvider (RT Professional)
Descripción
Define el suministro de datos de la columna de valores referenciada mediante
"ValueColumnIndex".

VB Scripting
Sintaxis
Object.ValueColumnProvider[=STRING]
Object
STRING
Opcional. Valor o constante que establece el origen de datos de una columna de valores.
Valor Explicación
Variables de fichero Origen de datos con variables de fichero de un fichero de valores
de proceso.
Variables Origen de datos con variables
online de la administración de variables.
Consulte también
ValueColumnProviderCLSID (RT Professional)
Descripción
Define la CLSID de proveedor para los datos de una columna de valores referenciada
mediante "ValueColumnIndex".
Sintaxis
Object.ValueColumnProviderCLSID[=STRING]
Object
STRING
Opcional. Valor o constante que determina la CLSID de proveedor.
Valor Explicación
{416A09D2-8B5A-11D2-8B81-006097A Origen de datos con variables de fichero de un fichero de valores de proceso.
45D48}
{A3F69593-8AB0-11D2- Origen de datos con variables
A440-00A0C9DBB64E} online de la administración de variables.

VB Scripting
Consulte también
ValueColumnRemove (RT Professional)
Descripción
Elimina una columna de valores referenciada mediante su nombre.
Sintaxis
Object.ValueColumnRemove[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la columna de valores referenciada que
se borrará.
Consulte también
ValueColumnRename (RT Professional)
Descripción
Define el nombre nuevo de una columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnRename[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nuevo nombre de la columna de valores.

VB Scripting
Consulte también
ValueColumnRepos (RT Professional)
Descripción
Define la posición de una columna de valores referenciada mediante "ValueColumnIndex".
Si ha modificado la posición de la columna de valores con "ValueColumnRepos", a
"ValueColumnIndex" se le asignará el valor de "ValueColumnRepos".
Sintaxis
Object.ValueColumnRepos[=Int32]
Object
Int32
Opcional. Valor o constante que define la posición de la columna de valores referenciada.
Rango de valores de 0 a "ValueColumnCount" menos 1. Los valores fuera de este rango de
0: La columna de valores referenciada se posiciona a la izquierda.
Consulte también
ValueColumnCount (Página 1201)
ValueColumns (RT Professional)
Descripción

VB Scripting
ValueColumnSelectTagName (RT Professional)
Descripción
de la variable del origen de los datos de la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnSelectTagName[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra en la imagen el cuadro de diálogo para seleccionar el nombre de variable
del origen de los datos de la columna de valores.
FALSE, si no se muestra en la imagen el cuadro de diálogo para seleccionar el nombre de
variable del origen de los datos de la columna de valores.
Consulte también
ValueColumnShowIcon (RT Professional)
Descripción
Define si se mostrará un símbolo en la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnShowIcon[=BOOLEAN]
Object

VB Scripting
BOOLEAN
Opcional.
TRUE si se muestra un símbolo.
FALSE si no se muestra ningún símbolo.
Consulte también
ValueColumnShowTitleIcon (RT Professional)
Descripción
Define si se mostrará un símbolo en el título de la columna de valores referenciada mediante
"ValueColumnIndex".
Sintaxis
Object.ValueColumnShowTitleIcon[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra un símbolo en el título de la columna actual.
FALSE si no se muestra ningún símbolo en el título de la columna actual.
Consulte también
ValueColumnSort (RT Professional)
Descripción
Define la clase de clasificación en la columna de valores referenciada mediante
"ValueColumnIndex".

VB Scripting
Sintaxis
Object.ValueColumnSort[=SortMode]
Object
SortMode
Opcional. Valor o constante que establece el tipo de clasificación en la columna actual.

0 Sin clasificación Los valores de la columna de valores no se ordenan.
1 Orden ascendente Los valores de la columna de valores se ordenan de menor a mayor em‐
pezando por la fila superior.
2 Orden descendente Los valores de la columna de valores se ordenan de mayor a menor em‐
pezando por la fila superior.
Consulte también
ValueColumnSortIndex (RT Professional)
Descripción
Determina el orden en la clasificación.
Sintaxis
Object.ValueColumnSortIndex[=Int32]
Object
Int32
Opcional. Valor o constante que establece el orden de la clasificación.
Consulte también

VB Scripting
ValueColumnTagName (RT Professional)
Descripción
Define el nombre de las variables cuyos valores se muestran en la columna de valores
Sintaxis
Object.ValueColumnTagName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre de la variable cuyos valores se mostrarán
en la columna actual.
Consulte también
ValueColumnTimeColumn (RT Professional)
Descripción
Determina la correspondiente columna de tiempo.
Sintaxis
Object.ValueColumnTimeColumn[=STRING]
Object
STRING
Opcional. Valor o constante que determina la columna de tiempo correspondiente.
Consulte también

VB Scripting
ValueColumnVisible (RT Professional)
Descripción
Define si la columna de valores referenciada mediante "ValueColumnIndex" se muestra en el
objeto.
Sintaxis
Object.ValueColumnVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se muestra la columna de valores referenciada.
FALSE si no se muestra la columna de valores referenciada.
Consulte también
ValueColumnWidth (RT Advanced)
Descripción
ValueTableHeight (RT Advanced)
Descripción
ValueTableLeft (RT Advanced)
Descripción

VB Scripting
ValueTableTop (RT Advanced)
Descripción
ValueTableWidth (RT Advanced)
Descripción
ValueY1HlpLine (RT Advanced)
Descripción
ValueY2HlpLine (RT Advanced)
Descripción
VerticalAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la alineación vertical del texto en el objeto indicado.
Sintaxis
Object.VerticalAlignment[=VerticalAlignment]
Object
● Button
● CheckBox
● DateTimeField
● IOField
● OptionGroup

VB Scripting
● RoundButton *
● Switch *
● SymbolicIOField **
● TextField
VerticalAlignment
Opcional. Valor que determina la alineación vertical.

0 hmiAlignmentTop El texto se representa en el borde superior.
1 hmiAlignmentMiddle El texto se representa en el centro.
2 hmiAlignmentBottom El texto se representa en el borde inferior.
Consulte también
VerticalGridLines (RT Professional)
Descripción
Define si se deben visualizar líneas verticales.
Sintaxis
Object.VerticalGridLines[=BOOLEAN]

VB Scripting
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE si se muestran líneas de separación verticales.
FALSE si no se muestran líneas de separación verticales.
Consulte también
VerticalPictureAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
VerticalScrollBarEnabled (RT Advanced)
Descripción
VerticalScrollBarPosition (RT Professional)
Descripción
Determina la posición del deslizador en la barra de desplazamiento vertical del objeto. La
imagen se muestra en la ventana de imagen con el desplazamiento vertical del deslizador de
la barra de desplazamiento.
Para visualizar la imagen recortada, con barras de desplazamiento en el borde izquierdo y
superior de la imagen, utilice las propiedades "LeftOffset (Página 785)" y "LeftOffset
(Página 785)" para el origen de la sección.

VB Scripting
Sintaxis
Object.VerticalScrollBarPosition[=Int32]
Object
● Screenwindow
Int32
Opcional. Valor o constante que define la posición vertical del deslizador en la barra de
desplazamiento del objeto.
Consulte también
TopOffset (Página 1100)
VerticalScrolling (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
VerticalScrollingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ViewOnly (RT Advanced)
Descripción
Determina si el visor Sm@rtClient debe utilizarse para la monitorización o el mantenimiento
a distancia.
Mantenimiento a distancia significa que los ajustes del dispositivo vigilado pueden modificarse.
Monitorización a distancia significa que los ajustes del dispositivo vigilado no pueden
modificarse.

VB Scripting
Sintaxis
Object.ViewOnly[=BOOLEAN]
Object
● SmartClientView
BOOLEAN
Opcional. TRUE si el visor Sm@rtClient sólo debe utilizarse para la monitorización a distancia.
Consulte también
ViewType (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ViewTypeForSaveStream (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Acceso en runtime:
Sintaxis
Object.ViewTimeForSaveStream[=[!]: AlarmViewBasicMode | Int16 | PasswordViewType]
Object
● RecipeView
● AlarmView
● UserView
[!]: AlarmViewBasicMode | Int16 | PasswordViewType:

Opcional. tbd tbd tbd tbd.

VB Scripting
Visible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el objeto indicado será visible.
Sintaxis
Object.Visible[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem"" con la apariencia:
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● CircleSegment
● CircularArc
● ComboBox
● Connector
● DateTimeField
● DiscSpaceView
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTMLBrowser
● IOField
● ListBox
● MediaPlayer
● MultiLineEdit

VB Scripting
● OptionGroup
● PLCCodeViewer
● ProDiagOverview
● RangeLabelView
● RecipeView
● RoundButton
● S7GraphOverview
● ScreenWindow
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WLanQualityView
● WindowSlider
● ZoneLabelView
● ZoneQualityView
● PdfView
BOOLEAN
Opcional. TRUE si el objeto es visible.

VB Scripting
Consulte también
Bar (Página 261)
Clock (Página 290)
Gauge (Página 324)
Line (Página 341)

VB Scripting

VisibleItems (RT Advanced)
Descripción

VB Scripting
Warning (RT Professional)
Descripción
Define a partir de qué porcentaje de memoria ocupada se emitirá una advertencia.
Sintaxis
Object.Warning[=Int32]
Object
● DiskSpaceView
Int32
Opcional. Valor o constante que indica el valor porcentual de memoria ocupada a partir del
cual se emitirá una advertencia.
Consulte también
WarningColor (RT Professional)
Descripción
Define el color en el que se representará la barra del visor de memoria en cuanto se alcanza
el rango de advertencia.
Sintaxis
Object.WarningColor[=Color]
Object
● DiskSpaceView
Color
Opcional. Un valor o una constante que determina el color en el que se representa la barra
del visor de memoria en cuanto se alcanza el rango de advertencia.

VB Scripting
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
WarningLowerLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el valor límite inferior "WarningLowerLimit".
La propiedad "WarningLowerLimitEnable" debe tener el valor "TRUE" para que se vigile el
valor límite.
Sintaxis
Object.WarningLowerLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Un valor o una constante que determina el valor límite inferior "WarningLowerLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "WarningLowerLimitColor"
y "WarningLowerLimitRelative":
Consulte también
Bar (Página 261)

VB Scripting
WarningLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color para el valor límite inferior "WarningLowerLimit".
La propiedad "WarningLowerLimitEnable" debe tener el valor "TRUE" cuando deba
modificarse el color de barra al alcanzar el valor límite.
Sintaxis
Object.WarningLowerLimitColor[=Color]
Object
● Bar
Color
Opcional. Valor o constante que establece el color del valor límite inferior "WarningLowerLimit".
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Los siguientes valores se determinan por medio de las propiedades "WarningUpperLimit",
"WarningUpperLimitColor" y "WarningUpperLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)
WarningLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite "WarningLowerLimit".

VB Scripting
Sintaxis
Object.WarningLowerLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "WarningLowerLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "WarningLowerLimit",
"WarningLowerLimitColor" y "WarningLowerLimitRelative":
● Valor límite
Consulte también
Bar (Página 261)
WarningLowerLimitRelative (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define si el valor límite inferior "WarningLowerLimit" se evaluará en porcentaje o de forma
absoluta.
Sintaxis
Object.WarningLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE si se evalúa el valor límite inferior "WarningLowerLimit" en porcentaje.

VB Scripting
FALSE si se evalúa el valor límite inferior "WarningLowerLimit" de forma absoluta.
Consulte también
Bar (Página 261)
WarningRangeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del rango de advertencia en la escala del objeto "Gauge".
La propiedad "WarningRangeVisible" debe tener el valor TRUE para que se visualice el rango
de peligro.
Sintaxis
Object.WarningRangeColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color del rango de peligro.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Gauge (Página 324)

VB Scripting
WarningRangeStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina a partir de qué valor de la escala comienza el rango de advertencia del objeto
"Gauge".
La propiedad "WarningRangeVisible" debe tener el valor TRUE para que se visualice el rango
de advertencia.
Sintaxis
Object.WarningRangeStart[=SINGLE]
Object
● Gauge
SINGLE
Opcional. Valor o constante que determina el valor de la escala para el comienzo del rango
de advertencia.
Observaciones
El rango va desde el valor "Warning" hasta el valor "Danger". Si no hay ningún rango activado
para Danger", el rango para "Warning" llega hasta el final de la escala.
Consulte también
Gauge (Página 324)
WarningRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse el rango de advertencia en la escala del objeto "Gauge".
Sintaxis
Object.WarningRangeVisible[=BOOLEAN]
Object
● Gauge

VB Scripting
BOOLEAN
Opcional. TRUE si debe mostrarse el rango de advertencia en la escala.
Observaciones
El color del rango de advertencia se define con la propiedad "WarningRangeColor".
El comienzo del rango de advertencia se define con la propiedad "WarningRangeStart".
Consulte también
Gauge (Página 324)
WarningUpperLimit (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el límite de advertencia superior.
La propiedad "WarningUpperLimitEnabled"" debe tener el valor TRUE para que se vigile el
valor límite.
Sintaxis
Object.WarningUpperLimit[=DOUBLE]
Object
● Bar
DOUBLE
Opcional. Valor o constante que determina el valor límite superior.
Observaciones
"WarningUpperLimitColor" determina la representación al alcanzarse el valor límite.
"WarningUpperLimitRelative" define el tipo de evaluación.
Consulte también
Bar (Página 261)

VB Scripting
WarningUpperLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color del límite superior de advertencia.
La propiedad "WarningUpperLimitEnabled" debe tener el valor TRUE si el color de la barra
debe cambiar al alcanzarse el valor límite.
Acceso en runtime:
Sintaxis
Object.WarningUpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Valor o constante que define el color para el valor límite superior.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también
Bar (Página 261)
WarningUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite superior.

VB Scripting
Acceso en runtime:
Sintaxis
Object.WarningUpperLimitEnabled[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior.
WarningUpperLimitRelative (RT Professional)
Descripción
Define si el valor límite superior "WarningUpperLimit" se evaluará en porcentaje o de forma
absoluta.
Sintaxis
Object.WarningUpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si se evalúa el valor límite inferior "WarningUpperLimit" en porcentaje.
Consulte también
Bar (Página 261)
Width (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del objeto en píxeles.

VB Scripting
Acceso en runtime: Lectura y escritura.
Sintaxis
Object.Width[=Int32]
Object
● AlarmControl
● AlarmView*
● ChannelDiagnose
● CircularArc
● ComboBox
● DiscSpaceView
● EllipticalArc
● FunctionTrendControl*
● GraphicIOField*
● GraphicView*
● HTMLBrowser*
● ListBox
● MediaPlayer*
● MultiLineEdit
● PLCCodeViewer*
● ProDiagOverview*
● S7GraphOverview*
● ScreenWindow
● SmartClientView
● Switch*
● SymbolLibrary*
● TrendView*
● TubeArcObject

VB Scripting
● TubeTeeObject
● WindowSlider
*: En "Runtime Advanced" y "Panel Runtime", no se tiene acceso.
Int32
Opcional. Valor o constante que determina el ancho del objeto en píxeles.
Consulte también
Bar (Página 261)
Clock (Página 290)
Gauge (Página 324)
Line (Página 341)

VB Scripting


VB Scripting
WindowCloseEnabled (RT Professional)
Descripción
Indica si puede cerrarse una ventana en runtime.
Sintaxis
Object.WindowCloseEnabled[=BOOLEAN]
Object
● ScreenWindow
BOOLEAN
Opcional. TRUE si la ventana puede cerrarse en runtime.
Consulte también
WindowMaximizeEnabled (RT Professional)
Descripción
Devuelve si el objeto se puede maximizar en runtime.
Sintaxis
Object.WindowMaximizeEnabled[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Opcional.
TRUE si el objeto puede maximizarse en runtime.

VB Scripting
FALSE si el objeto no puede maximizarse en runtime.
Consulte también
WindowMovingEnabled (RT Professional)
Descripción
Devuelve si el objeto se puede desplazar en runtime.
Sintaxis
Object.WindowMovingEnabled[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
Opcional.
TRUE si el objeto puede desplazarse en runtime.
FALSE si el objeto no puede desplazarse en runtime.
Consulte también
WindowOnTop (RT Professional)
Descripción
Devuelve si el objeto permanece siempre en primer plano en runtime.
Sintaxis
Object.WindowOnTop[=BOOLEAN]

VB Scripting
Object
● Screenwindow
BOOLEAN
Opcional.
TRUE si el objeto permanece siempre en primer plano en runtime.
FALSE si el objeto no permanece siempre en primer plano en runtime.
Consulte también
WindowsContents (RT Professional)
Descripción
Devuelve el contenido del trabajo de impresión o del diagnóstico de script.
Sintaxis
Object.WindowsContents[=WindowContent]
Object
WindowContent
Opcional. Valor o constante que devuelve el contenido que se muestra en el objeto.
Nombre Explicación
Función Se muestra una aplicación Global Script. Defina las plantillas que vaya a utilizar en la propiedad
"Template (Página 1012)":
● Diagnóstico GSC
Se representan resultados del sistema de diagnóstico.
● Runtime GSC
Se representan resultados de análisis del comportamiento en runtime.
Trabajos de impresión Se muestra un informe.
Las plantillas que se utilizarán al efecto se definen en la propiedad "Template (Página 1012)".

VB Scripting
Consulte también
WindowSizingEnabled (RT Professional)
Descripción
Indica si puede modificarse el tamaño.
Sintaxis
Object.WindowSizingEnabled[=BOOLEAN]
Object
● ScreenWindow
BOOLEAN
Opcional. TRUE, si puede modificarse el tamaño.
Consulte también
WindowsStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto se mostrará en el estilo general de Windows.
Acceso en runtime:
Sintaxis
Object.WindowsStyle[=BOOLEAN]

VB Scripting
Object
● Button
● WindowSlider
● Switch
BOOLEAN
Opcional. TRUE si el objeto se representa en el estilo general de Windows.
Consulte también
WindowStartupPosition (RT Professional)
Descripción
Devuelve la posición y el modo de la ventana de imagen si se ha configurado una ventana de
imagen independiente. Para ello ajuste "IndipendentWindow (Página 752)" a "TRUE".
Sintaxis
Object.WindowsStartupPosition[=PositionMode]
Object
● ScreenWindow
PositionMode
Opcional. Valor o constante que devuelve la posición y el modo de la ventana de imagen.
Nombre Explicación
Maximizado La ventana de imagen se adaptará al tamaño del monitor.
Como configurado La ventana de imagen se mostrará con el tamaño configurado y en la posi‐
ción configurada.
Centrado La ventana de imagen se mostrará con el tamaño configurado y en posición
central.

VB Scripting
Consulte también
1.5.5.15 Propiedades X-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
XAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
XAxisAdd (RT Professional)
Descripción
Crea un nuevo eje X. El eje X creado se referencia automáticamente mediante "XAxisIndex".
Sintaxis
Object.XAxisAdd[=STRING]
Object
STRING
Necesario. Valor o constante que define el nombre del nuevo eje X mediante "XAxisName".
Consulte también
XAxisIndex (Página 1248)
XAxisAlignment (RT Professional)
Descripción
Define la alineación del eje X referenciado mediante "XAxisIndex".

VB Scripting
Sintaxis
Object.XAxisAlignment[=AxisAlignment]
Object
AxisAlignment
Opcional. Valor o constante que determina la orientación del eje X con respecto a la ventana
de curvas:
Valor Nombre
0 Izquierda
1 Derecha
Consulte también
XAxisAutoPrecisions (RT Professional)
Descripción
Define si se determinará automáticamente el número de decimales de un eje X referenciado
mediante "XAxisIndex".
Sintaxis
Object.XAxisAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Opcional.
FALSE si se utiliza el valor de "XAxisPrecisions".
Consulte también

VB Scripting
XAxisAutoRange (RT Professional)
Descripción
Define si se determinará automáticamente el rango de valores de un eje X referenciado
mediante "XAxisIndex".
Sintaxis
Object.XAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Opcional.
FALSE si el rango de valores se define mediante "XAxisBeginValue" y "XAxisEndValue".
Consulte también
XAxisEndValue (Página 1247)
XAxisBeginValue (Página 1245)
XAxisBeginValue (RT Professional)
Descripción
Define el punto inferior del rango de valores de un eje X referenciado mediante "XAxisIndex".
Ajuste además "XAxisAutoRange" a "FALSE".
Sintaxis
Object.XAxisBeginValue[=DOUBLE]
Object

VB Scripting
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje X
referenciado.
Consulte también
XAxisAutoRange (Página 1243)
XAxisColor (RT Professional)
Descripción
Define el color de un eje X referenciado mediante "XAxisIndex".
Ajuste además "XAxisInTrendColor" a "FALSE".
Sintaxis
Object.XAxisColor[=Color]
Object
Color
Opcional. Valor o constante que define el color del eje referenciado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
XAxisCount (RT Professional)
Descripción
Define el número de ejes X configurados.
Sintaxis
Object.XAxisCount[=Int32]
Object
Int32
Opcional. Valor o constante que define el número de ejes X configurados.
Consulte también
XAxisEndValue (RT Professional)
Descripción
Define el punto superior del rango de valores de un eje X referenciado mediante "XAxisIndex".
Ajuste además "XAxisAutoRange" a "FALSE".
Sintaxis
Object.XAxisEndValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje X
referenciado.

VB Scripting
Consulte también
XAxisAutoRange (Página 1243)
XAxisExponentialFormat (RT Professional)
Descripción
Determina si los valores de un eje X referenciado mediante "XAxisIndex" se mostrarán en
Sintaxis
Object.XAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Opcional.
Consulte también
XAxisIndex (RT Professional)
Descripción
Hace referencia a un eje X. Para acceder a las propiedades de un eje X, es necesario activar
"YAxisIndex".
Los valores válidos para "XAxisIndex" se encuentran entre 0 y "XAxisCount" menos 1. La
propiedad "XAxisCount" indica el número de ejes X configurados.

VB Scripting
Sintaxis
Object.XAxisIndex[=Int32]
Object
Int32
Opcional. Valor o constante que define el eje X que va a editarse a través del índice.
Consulte también
XAxisCount (Página 1245)
XAxisInTrendColor (RT Professional)
Descripción
Define si el color del eje referenciado mediante "XAxisIndex" debe corresponderse con el color
de la curva.
Sintaxis
Object.XAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se debe mostrar el eje referenciado con el color de la curva. El valor de "XAxisColor"
no es efectivo.
FALSE si debe mostrarse el eje referenciado con el color determinado en "XAxisColor".
Consulte también

VB Scripting
XAxisLabel (RT Professional)
Descripción
Define el texto con el que se titulará un eje X referenciado mediante "XAxisIndex".
Sintaxis
Object.XAxisLabel[=STRING]
Object
STRING
Opcional. Valor o constante que determina el texto de rotulación del eje X referenciado.
Consulte también
XAxisName (RT Professional)
Descripción
Define el nombre de un eje X referenciado mediante "XAxisIndex".
Sintaxis
Object.XAxisName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje X referenciado.

VB Scripting
Consulte también
XAxisPrecisions (RT Professional)
Descripción
Define con cuántos decimales se mostrarán los valores de un eje X referenciado mediante
"XAxisIndex".
Ajuste además "XAxisAutoPrecisions" a "FALSE".
Sintaxis
Object.XAxisPrecisions[=Int16]
Object
Int16
Consulte también
XAxisRemove (RT Professional)
Descripción
Elimina un eje X referenciado mediante su nombre.
Sintaxis
Object.XAxisRemove[=STRING]
Object

VB Scripting
STRING
Opcional. Valor o constante que define el nombre del eje X referenciado que se borrará.
Consulte también
XAxisRename (RT Professional)
Descripción
Define el nombre nuevo de un eje X referenciado mediante "XAxisIndex".
Sintaxis
Object.XAxisRename[=STRING]
Object
STRING
Opcional. Valor o constante que establece el nombre nuevo del eje X.
Consulte también
XAxisRepos (RT Professional)
Descripción
En el caso de varios ejes X, define la posición de un eje X referenciado mediante "XAxisIndex".
Si ha modificado la posición del eje Y con "XAxisRepos", a "XAxisIndex" se le asignará el valor
de "XAxisRepos".
Sintaxis
Object.XAxisRepos[=Int32]

VB Scripting
Object
Int32
Opcional. Valor o constante que define la posición del eje X referenciado. Rango de valores
de 0 a "XAxisCount" menos 1. Los valores fuera de este rango de valores no tienen ningún
efecto.
0: El eje X referenciado se posiciona fuera.
Consulte también
XAxisCount (Página 1245)
XAxisScalingType (RT Professional)
Descripción
Define el tipo de escala del eje X referenciado mediante "XAxisIndex".
Sintaxis
Object.XAxisScalingType[=AxisScalingType]
Object
AxisScalingType
Opcional. Valor o constante que establece el tipo de escala para el eje X referenciado.

Consulte también

VB Scripting
XAxisTrendWindow (RT Professional)
Descripción
Define el diagrama de curvas en el que se mostrará el eje referenciado mediante "XAxisIndex".
Sintaxis
Object.XAxisTrendWindow[=STRING]
Object
STRING
Consulte también
XAxisVisible (RT Professional)
Descripción
Define si se mostrará el eje X referenciado mediante "XAxisIndex" en el objeto.
Sintaxis
Object.XAxisVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el eje X referenciado se muestra.
FALSE si el eje X referenciado no se muestra.

VB Scripting
Consulte también
YAxes (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
YAxisAdd (RT Professional)
Descripción
Crea un nuevo eje Y. El eje Y recién creado se referencia automáticamente mediante
"YAxisIndex".
Sintaxis
Object.YAxisAdd[=STRING]
Object
STRING
Necesario. Valor o constante que establece el nombre del nuevo eje Y mediante "YAxisName".
Consulte también
YAxisIndex (Página 1260)
YAxisAlignment (RT Professional)
Descripción
Define la alineación del eje Y referenciado mediante "YAxisIndex".

VB Scripting
Sintaxis
Object.YAxisAlignment[=AxisAlignment]
Object
AxisAlignment
Opcional. Valor o constante que determina la orientación del eje Y con respecto a la ventana
de curvas:
Valor Nombre
0 Izquierda
1 Derecha
Consulte también
YAxisAutoPrecisions (RT Professional)
Descripción
Define si se determinará automáticamente el número de decimales de un eje Y referenciado
mediante "YAxisIndex".
Sintaxis
Object.YAxisAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
Opcional.
FALSE si se utiliza el valor de "YAxisPrecisions".
Consulte también

VB Scripting
YAxisAutoRange (RT Professional)
Descripción
Define si se determinará automáticamente el rango de valores de un eje Y referenciado
mediante "YAxisIndex".
Sintaxis
Object.YAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Opcional.
FALSE si el rango de valores se define mediante "YAxisBeginValue" y "YAxisEndValue".
Consulte también
YAxisBeginValue (RT Professional)
Descripción
Define el extremo inferior del rango de valores de un eje Y referenciado mediante
"YAxisIndex".
Ajuste además "YAxisAutoRange" a "FALSE".
Sintaxis
Object.YAxisBeginValue[=DOUBLE]
Object

VB Scripting
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje Y
referenciado.
Consulte también
YAxisColor (RT Professional)
Descripción
Define el color de un eje Y referenciado mediante "YAxisIndex".
Ajuste además "YAxisInTrendColor" a "FALSE".
Sintaxis
Object.YAxisColor[=Color]
Object
Color
Opcional. Valor o constante que define el color del eje referenciado.
Observaciones
siguiente:
RGB (255, 0, 0)
vbGreen.
Consulte también

VB Scripting
YAxisCount (RT Professional)
Descripción
Define el número de ejes Y configurados.
Sintaxis
Object.YAxisCount[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de ejes Y configurados.
Consulte también
YAxisEndValue (RT Professional)
Descripción
Define el extremo superior del rango de valores de un eje Y referenciado mediante
"YAxisIndex".
Ajuste además "YAxisAutoRange" a "FALSE".
Sintaxis
Object.YAxisEndValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje Y
referenciado.

VB Scripting
Consulte también
YAxisExponentialFormat (RT Professional)
Descripción
Determina si los valores de un eje Y referenciado mediante "YAxisIndex" se mostrarán en
Sintaxis
Object.YAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
Opcional.
Consulte también
YAxisIndex (RT Professional)
Descripción
Hace referencia a un eje Y. Para acceder a las propiedades de un eje Y, es necesario activar
"YAxisIndex".
Los valores válidos para "YAxisIndex" se encuentran entre 0 y "YAxisCount" menos 1. La
propiedad "YAxisCount" indica el número de ejes Y configurados.
Sintaxis
Object.YAxisIndex[=Int32]

VB Scripting
Object
Int32
Opcional. Valor o constante que define a través del índice el eje X que va a editarse.
Consulte también
YAxisInTrendColor (RT Professional)
Descripción
Define si el color del eje referenciado mediante "YAxisIndex" debe corresponderse con el color
de la curva.
Sintaxis
Object.YAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si se debe mostrar el eje referenciado con el color de la curva. El valor de "YAxisColor"
no es efectivo.
FALSE si debe mostrarse el eje referenciado con el color determinado en "YAxisColor".
Consulte también
YAxisIndex (Página 1258)
YAxisLabel (RT Professional)
Descripción
Define el texto con el que se titulará un eje Y referenciado mediante "YAxisIndex".

VB Scripting
Sintaxis
Object.YAxisLabel[=STRING]
Object
STRING
Opcional. Valor o constante que define el texto de rotulación del eje Y referenciado.
Consulte también
YAxisName (RT Professional)
Descripción
Define el nombre de un eje Y referenciado mediante "YAxisIndex".
Sintaxis
Object.YAxisName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje Y referenciado.
Consulte también

VB Scripting
YAxisPrecisions (RT Professional)
Descripción
Define con cuántos decimales se mostrarán los valores de un eje Y referenciado mediante
"YAxisIndex".
Ajuste además "YAxisAutoPrecisions" a "FALSE".
Sintaxis
Object.YAxisPrecisions[=Int16]
Object
Int16
Consulte también
YAxisRemove (RT Professional)
Descripción
Elimina un eje Y referenciado mediante su nombre.
Sintaxis
Object.YAxisRemove[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje Y referenciado que se borrará.

VB Scripting
Consulte también
YAxisRename (RT Professional)
Descripción
Define el nombre nuevo de un eje Y referenciado mediante "YAxisIndex".
Sintaxis
Object.YAxisRename[=STRING]
Object
STRING
Opcional. Valor o constante que establece el nombre nuevo del eje Y seleccionado.
Consulte también
YAxisRepos (RT Professional)
Descripción
En el caso de varios ejes Y, define la posición de un eje Y referenciado mediante "YAxisIndex".
Si ha modificado la posición del eje Y con "YAxisRepos", a "YAxisIndex" se le asigna el valor
de "YAxisRepos".
Acceso en runtime:
Sintaxis
Object.YAxisRepos[=Int32]
Object

VB Scripting
Int32
Opcional. Valor o constante que determina la posición del eje Y referenciado. Rango de
valores de 0 a "YAxisCount" menos 1. Los valores fuera de este rango de valores no tienen
ningún efecto.
0: El eje Y referenciado se posiciona fuera.
YAxisScalingType (RT Professional)
Descripción
Define el tipo de escala del eje Y referenciado mediante "YAxisIndex".
Acceso en runtime:
Sintaxis
Object.YAxisScalingType[=AxisScalingType]
Object
AxisScalingType
Opcional. Valor o constante que establece el tipo de escala para el eje Y referenciado.

YAxisTrendWindow (RT Professional)
Descripción
Define el diagrama de curvas en el que se mostrará el eje referenciado mediante "YAxisIndex".
Acceso en runtime:

VB Scripting
Sintaxis
Object.YAxisTrendWindow[=STRING]
Object
STRING
YAxisVisible (RT Professional)
Descripción
Define si se mostrará el eje Y referenciado mediante "YAxisIndex" en el objeto.
Acceso en runtime:
Sintaxis
Object.YAxisVisible[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE si el eje Y referenciado se muestra.
FALSE si el eje Y referenciado no se muestra.
ZeroPoint (RT Professional)
Descripción
Determina la posición del punto cero en porcentaje respecto de la altura de la barra. El valor
cero también puede estar fuera del área representada.
La propiedad "ScalingType" debe estar puesta en "Auto".
La propiedad "ShowScale" debe estar puesta en "TRUE".

VB Scripting
Sintaxis
Object.ZeroPoint[=Int32]
Object
● Bar
Int32
Opcional. Un valor o una constante que determina la posición del punto cero en porcentaje
respecto de la altura de la barra.
Consulte también
Bar (Página 261)
ZoomFactor (RT Professional)
Descripción
Define el factor de zoom de una imagen o una ventana de imagen.
Sintaxis
Object.ZoomFactor[=Int32]
Object
● ScreenWindow
Int32
Opcional. Valor o constante que devuelve el factor de zoom para la visualización del gráfico
incrustado.
Consulte también

VB Scripting
1.5.6 Métodos (Panels, Comfort Panels, RT Advanced, RT Professional)
1.5.6.1 Métodos A-G (Panels, Comfort Panels, RT Advanced, RT Professional)
Activate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
El método Activate puede utilizarse de forma adecuada con los siguientes objetos de imagen
manejables. En los objetos gráficos no activables, como rectángulo, se emite un aviso de
error.
● IOField
● Switch
● SymbolLibrary
● TrendView
● HTMLBrowser
● Slider
● GraphicIOField
● SymbolicIOField
● Button
● AlarmControl
● UserView
● SmartClientView
● StatusForce
En el caso de Runtime Advanced y Panels, se activará el área permanente cuando el método
se aplique sobre un objeto "Screen". Para activar una imagen no seleccionada, utilice la
propiedad "BaseScreenName".
Sintaxis
Expression.Activate()
Expression
Necesario. Expresión que devuelve un objeto del tipo "Screen" o "ScreenItem".
Parámetros
--

VB Scripting
Ejemplo
Dim objO
Set objO = HMIRuntime.Screens("Screen_1").ScreenItems("IO-Field_1")
objO.Activate
Consulte también
Clock (Página 290)
Gauge (Página 324)

VB Scripting

Line (Página 341)
Bar (Página 261)
ActivateDynamic (RT Professional)
Descripción
Activa dinámicamente un disparador y el ciclo fijado para una propiedad durante el runtime.
Para ello se requiere un VB Script en la propiedad y un disparo definido como "Bajo demanda".
Con cada activación del disparador puede usarse otro ciclo de activación.

VB Scripting
Sintaxis
Expression.ActivateDynamic (ByVAl Property name As String, ByVal
Cycle name As Cycle)
Expression
Necesario. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
Parámetro Descripción
Property name Propiedad a la que se refiere el disparador. Utilice
el nombre VBS de la propiedad.
Cycle name Nombre del ciclo de activación, p. ej., "CycleTi‐
me1s".
Consulte también
Clock (Página 290)
Gauge (Página 324)

VB Scripting

Line (Página 341)
Bar (Página 261)
Add (RT Professional)
Descripción para objeto TagSet

Agrega una variable al listado. La variable se puede agregar a través del nombre o a través
de una referencia de un objeto Tag.
Sintaxis
Expresión.Add [Tag]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "TagSet".

VB Scripting
Parámetros
VARIANT
Parámetros Descripción
Variable;Tag Nombre de una variable WinCC o referencia de
un objeto Tag que deberá ser agregado al listado.
Ejemplo
En el siguiente ejemplo se genera un objeto TagSet y se agrega una variable.
'VBS170
Dim group
group.Add "Motor1"
Objetos Tag también pueden ser aceptados de la siguiente manera.
'VBS171
Dim Tag
Set Tag = HMIRuntime.Tags("Motor2")
Dim group2
Set group2 = HMIRuntime.Tags.CreateTagSet
group2.Add Tag
Descripción para objeto DataSet

Agrega al listado un valor o una referencia de objeto.
Nota
El objeto DataSet no soporta ninguna clase.
Objetos del tipo Screen, Screens, ScreenItem, ScreenItems, Tag y TagSet no pueden ser
incluidos en el listado DataSet.
En las referencias de objetos hay que estar seguro de que los objetos son aptos para
multithread.
Sintaxis
Expresión.Add [vtName], [vtUserData]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataSet".

VB Scripting
Parámetros
VARIANT
vtName Nombre con el que se debe agregar el valor o la
variable al listado.
vtUserData Valor que debe ser agregado al listado.
Ejemplo
En este ejemplo se acepta un valor en el listado DataSet.
'VBS172
HMIRuntime.DataSet.Add "Motor1",23
Consulte también
DataSet (lista) (Página 208)
Método AttachDB (RT Professional)
Descripción
Ejecuta la función de tecla "Conectar copia de seguridad" del control.
Sintaxis
Expression.AttachDB()
Expression
Parámetros
--
Consulte también

VB Scripting
CalculateStatistic (RT Professional)
Descripción
Ejecuta la función de tecla "Calcular estadística" del visor de curvas f(t) y del visor de tablas.
Sintaxis
Expression.CalculateStatistic()
Expression
Parámetro
--
Consulte también
CopyRows (RT Professional)
Descripción
Ejecuta la función de tecla "Copiar filas" del control.
Sintaxis
Expression.CopyRows()
Expression
Parámetro
--
Consulte también

VB Scripting
Create (RT Professional)
Descripción
Crea un nuevo objeto Alarm.
Sintaxis
Expression.Create (VARIANT vtApplication)
Expression
Necesario. Una expresión que devuelve un objeto del tipo "Alarm".
Parámetro
VARIANT
vtApplication Nombre del objeto Alarm (opcional)
Consulte también
CreateTagSet (RT Professional)
Descripción
Crea un nuevo objeto TagSet. Este objeto se puede usar para accesos Multi-Tag optimizados.
Sintaxis
Expresión.CreateTagSet()
Expresión
Obligatorio. Una expresión que retorna un objeto de tipo "TagSet".
Parámetro
VARIANT

VB Scripting
Ejemplo
El siguiente ejemplo muestra cómo se crea un objeto TagSet.
'VBS168
'Build a Reference to the TagSet Object
Dim group
Consulte también
CutRows (RT Professional)
Descripción
Ejecuta la función de tecla "Cortar líneas" del visor de recetas.
Sintaxis
Expression.CutRows()
Expression
Parámetro
--
Consulte también
DeactivateDynamic (RT Professional)
Descripción
Desactiva en/durante el runtime el disparador usado del método "ActivateDynamic" para la
propiedad fijada.
Sintaxis
Expression.DeactivateDynamic(ByVal Property name As String)

VB Scripting
Expression
Parámetro
Property name Propiedad cuyo disparador se desactiva. Utilice el
nombre VBS de la propiedad.
Consulte también
Clock (Página 290)
Gauge (Página 324)

VB Scripting

Line (Página 341)
Bar (Página 261)
DeleteRows (RT Professional)
Descripción
Ejecuta la función de tecla "Borrar líneas" del visor de recetas.
Sintaxis
Expression.DeleteRows()
Expression
Parámetro
--
Consulte también

VB Scripting
DetachDB (RT Professional)
Descripción
Ejecuta la función de tecla "Desconectar copia de seguridad" del control.
Sintaxis
Expression.DetachDB()
Expression
Parámetros
--
Consulte también
Edit (RT Professional)
Descripción
Ejecuta la función de tecla "Editar" del visor de tablas.
Sintaxis
Expression.Edit()
Expression
Parámetro
--

VB Scripting
Consulte también
Exportación (RT Professional)
Descripción
Ejecuta la función de tecla "Exportar fichero" o "Exportar datos" del control.
Sintaxis
Expression.Export()
Expression
Parámetro
--
Consulte también
GetColumn (RT Professional)
Descripción
Devuelve el objeto de columna designado por nombre o índice del visor de recetas como tipo
"ICCAxUAColumn".
Sintaxis
Expresión.GetColumn(ByVal vIndex As Variant)

VB Scripting
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
vIndex Índice o nombre de la columna del visor de recetas.
Ejemplo
'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
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Column" debe escribirse, p. ej., "objColumn.Align" en lugar de
"objColumn.ColumnAlign".
Consulte también
GetColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna del visor de recetas como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetColumnCollection()

VB Scripting
Expresión
Parámetro
--
Propiedades y funciones de ICCAxCollection

En ICCAxCollection encontrará las siguientes propiedades:
● Count
● Item
En ICCAxCollection encontrará las siguientes funciones:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Ejemplo
'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
Consulte también
GetHitlistColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna de la lista de aciertos del visor de avisos
como tipo "ICCAxCollection".

VB Scripting
Sintaxis
Expresión.GetHitlisteColumnCollection()
Expresión
Parámetro
--

● Count
● Item
Ejemplo
'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
Consulte también

VB Scripting
GetHitlistColumn (RT Professional)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la lista de aciertos del visor
de avisos como tipo "ICCAxMessageColumn".
Sintaxis
Expresión.GetHitlistColumn(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la columna de la lista de acier‐
tos
Ejemplo
'VBS314
Dim ctrl
Dim objHitlistColumn
Set objHitlistColumn = ctrl.GetHitlistColumn("Date")
objHitlistColumn.Sort = 2
Set objHitlistColumn = ctrl.GetHitlistColumn("AverageComeGo")
objHitlistColumn.Visible = FALSE
Nota
del listado.
En el listado "HitlistColumn" debe escribirse, p. ej., "objHitlistColumn.Visible" en lugar de
"objHitlistColumn.HitlistColumnVisible".
Consulte también

VB Scripting
GetMessageBlock (RT Professional)
Descripción
Devuelve el objeto de bloque de aviso designado por nombre o índice del visor de avisos
como tipo "ICCAxMessageBlock".
Sintaxis
Expresión.GetMessageBlock(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre del bloque de mensajes.
Ejemplo
'VBS316
Dim ctrl
Dim objMsgBlock
Set objMsgBlock = ctrl.GetMessageBlock("Date")
objMsgBlock.Align = 2
Set objMsgBlock = ctrl.GetMessageBlock("Number")
objMsgBlock.LeadingZeros = 4
Nota
del listado.
En el listado "MessageBlock" debe escribirse, p. ej., "objMsgBlock.Align" en lugar de
"objMsgBlock.MessageBlockAlign".
Consulte también

VB Scripting
GetMessageBlockCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de bloque de aviso del visor de avisos como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetMessageBlockCollection()
Expresión
Parámetro
--

● Count
● Item
Ejemplo
'VBS317
Dim ctrl
Dim coll
Dim msgblock
Set coll = ctrl.GetMessageBlockCollection
For Each msgblock In coll
msgblock.Align = 1
msgblock.Length = 12
msgblock.Selected = TRUE
Next

VB Scripting
Nota
del listado.
En el listado "MessageBlock" debe escribirse, p. ej., "msgblock.Align" en lugar de
"msgblock.MessageBlockAlign".
Consulte también
GetMessageColumn (RT Professional)
Descripción
Devuelve el objeto de columna designado por nombre o índice del visor de avisos como tipo
"ICCAxMessageColumn".
Sintaxis
Expresión.GetMessageColumn(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la columna en la lista de avisos.
Ejemplo
'VBS318
Dim ctrl
Dim objMessColumn
Set objMessColumn = ctrl.GetMessageColumn("Date")
objMessColumn.Visible = FALSE
Set objMessColumn = ctrl.GetMessageColumn("Number")
objMessColumn.Sort = 1

VB Scripting
Nota
del listado.
En el listado "MessageColumn" debe escribirse, p. ej., "objMessColumn.Visible" en lugar de
"objMessColumn.MessageColumnVisible".
Consulte también
GetMessageColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna del visor de avisos como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetMessageColumnCollection()
Expresión
Parámetro
--

● Count
● Item

VB Scripting
Ejemplo
'VBS319
Dim ctrl
Dim coll
Dim msgcol
Set coll = ctrl.GetMessageColumnCollection
HMIRuntime.Trace "Number of message columns:" & coll.Count & vbCrLf
For Each msgcol In coll
HMIRuntime.Trace msgcol.Index & vbCrLf
HMIRuntime.Trace msgcol.Name & vbCrLf
HMIRuntime.Trace msgcol.Sort & vbCrLf
HMIRuntime.Trace msgcol.SortIndex & vbCrLf
Next
Consulte también
GetOperatorMessage (RT Professional)
Descripción
Devuelve el objeto de aviso de operador designado por nombre o índice del visor de avisos
como tipo "ICCAxOperatorMessage".
Sintaxis
Expresión.GetOperatorMessage(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre del aviso de operador.

VB Scripting
Ejemplo
'VBS320
Dim ctrl
Dim objOpMess
Set objOpMess = ctrl.GetOperatorMessage(0)
objOpMess.Source1 = "Number"
objOpMess.SourceType1 = 1
Nota
del listado.
En el listado "OperatorMessage" debe escribirse, p. ej., "objOpMess.Source1" en lugar de
"objOpMess.OperatorMessageSource1".
Consulte también
GetOperatorMessageCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de aviso de operador del visor de avisos como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetOperatorMessageCollection()
Expresión
Parámetro
--

VB Scripting

● Count
● Item
Ejemplo
'VBS321
Dim ctrl
Dim coll
Dim opmsg
Set coll = ctrl.GetOperatorMessageCollection
For Each opmsg In coll
HMIRuntime.Trace opmsg.Index & vbCrLf
HMIRuntime.Trace opmsg.Name & vbCrLf
HMIRuntime.Trace opmsg.Number & vbCrLf
HMIRuntime.Trace opmsg.Selected & vbCrLf
Next
Consulte también
GetRow (RT Professional)
Descripción
Devuelve el objeto de filas designado mediante el número de fila de los controles basados en
tablas como tipo "ICCAxDataRow".
Sintaxis
Expresión.GetRow(ByVal IRow As Long)
Expresión

VB Scripting
Parámetros
Long
IRow Número de fila deseada del control.
Ejemplo
'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
Nota
del listado.
En el listado "Row" debe escribirse, p. ej., "objRow.CellCount" en lugar de
"objRow.RowCellCount".
Consulte también

VB Scripting
GetRowCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de filas de los controles basados en tablas como tipo
"ICCAxDataRowCollection".
Sintaxis
Expresión.GetRowCollection()
Expresión
Parámetro
--
Propiedades de ICCAxDataRowCollection
ICCAxDataRowCollection se refiere a datos runtime. Los datos solo se pueden leer. No es
posible añadir ni modificar los datos.
En ICCAxDataRowCollection encontrará las siguientes propiedades:
● Count, determina el número de filas de la Collection (colección)
● Item, acceso a una fila determinada de la Collection mediante el número de fila. La
numeración va de 1 a Count. Se devuelve un objeto Row.
Ejemplo
'VBS357
Dim ctrl
Dim coll
Dim lIndex
Dim lCellIndex
Set coll = ctrl.GetRowCollection
HMIRuntime.Trace "Number of message rows:" & coll.Count & vbCrLf
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.Trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.Trace ctrl.GetMessageColumn(lCellIndex -1).Name & " "
HMIRuntime.Trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.Trace vbNewLine
Next

VB Scripting
Consulte también
GetRulerBlock (RT Professional)
Descripción
Devuelve el objeto de bloque designado por nombre o índice de la tabla de evaluación como
tipo "ICCAxRulerBlock".
Sintaxis
Expresión.GetRulerBlock(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre del bloque de la tabla de evalua‐
ción
Ejemplo
'VBS322
Dim ctrl
Dim objRulerBlock
Set ctrl = ScreenItems("RulerControl")
Set objRulerBlock = ctrl.GetRulerBlock(0)
objRulerBlock.Caption = "RulerBlock1"
Set objRulerBlock = ctrl.GetRulerBlock("Name")
objRulerBlock.Length = 10

VB Scripting
Nota
del listado.
En el listado "RulerBlock" debe escribirse, p. ej., "objRulerBlock.Caption" en lugar de
"objRulerBlock.BlockCaption".
Consulte también
GetRulerBlockCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de bloque de la tabla de evaluación como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetRulerBlockCollection()
Expresión
Parámetro
--

● Count
● Item

VB Scripting
Ejemplo
'VBS323
Dim ctrl
Dim coll
Dim rulerblock
Set coll = ctrl.GetRulerBlockCollection
For Each rulerblock In coll
rulerblock.Align = 1
rulerblock.Length = 12
Next
Nota
del listado.
En el listado "RulerBlock" debe escribirse, p. ej., "rulerblock.Align" en lugar de
"rulerblock.RulerBlockAlign".
Consulte también
GetRulerColumn (RT Professional)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la tabla de evaluación como
tipo "ICCAxRulerColumn".
Sintaxis
Expresión.GetRulerColumn(ByVal vIndex As Variant)
Expresión

VB Scripting
Parámetro
VARIANT
vIndex Índice o nombre de la columna de la tabla de evalua‐
ción.
Ejemplo
'VBS324
Dim ctrl
Dim objRulercol
Set objRulercol = ctrl.GetRulerColumn("Name")
objRulercol.Sort = 0
Set objRulercol = ctrl.GetRulerColumn("ValueY")
objRulercol.Visible = FALSE
Nota
del listado.
En el listado "RulerColumn" debe escribirse, p. ej., "objRulercol.Visible" en lugar de
"objRulercol.ColumnVisible".
Consulte también
GetRulerColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna de la tabla de evaluación como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetRulerColumnCollection()
Expresión

VB Scripting
Parámetro
--

● Count
● Item
Ejemplo
'VBS325
Dim ctrl
Dim coll
Dim rulercol
Set coll = ctrl.GetRulerColumnCollection
HMIRuntime.Trace "Number of ruler columns:" & coll.Count & vbCrLf
For Each rulercol In coll
HMIRuntime.Trace rulercol.Index & vbCrLf
HMIRuntime.Trace rulercol.Name & vbCrLf
HMIRuntime.Trace rulercol.Sort & vbCrLf
HMIRuntime.Trace rulercol.SortIndex & vbCrLf
Next
Consulte también
GetRulerData (RT Professional)
Descripción
Devuelve el valor de la curva solicitada en la posición de la regla.
Sintaxis
Expresión.GetRulerData(ByVal RulerIndex As Long, pvValue As Variant,
Optional pvTimeStamp As Variant, Optional pvFlags As Varian) Long

VB Scripting
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "Trend".
Parámetro
RulerIndex 0 =Lineal
pvValue Valor del eje X
pvTimeStamp Instante y valor del eje Y
pvFlags Qualitycode
Ejemplo
'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
Consulte también
GetSelectedRow (RT Professional)
Descripción
Devuelve como tipo "ICCAxDataRow" el objeto de filas seleccionado de un control basado en
tablas.
Sintaxis
Expresión.GetSelectedRow()
Expresión

VB Scripting
Parámetro
--
Ejemplo
'VBS358
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim headingRow
Dim selectedRow
Set ctrl = ScreenItems("TableControl")
Set headingRow = ctrl.GetRow(0)
Set selectedRow = ctrl.GetSelectedRow
lCellCount = headingRow.CellCount
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
Next
Nota
del listado.
Consulte también
GetSelectedRows (RT Professional)
Descripción
Con selección múltiple, devuelve como tipo "ICCAxDataRow" los objetos de filas
seleccionados de un control basado en tablas.

VB Scripting
Sintaxis
Expresión.GetSelectedRows()
Expresión
Parámetro
--
Ejemplo
'VBS359
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim lRowIndex
Dim lRowCount
Dim headingRow
Dim selectedRow
Dim selectedRows
Set headingRow = ctrl.GetRow(0)
Set selectedRows = ctrl.GetSelectedRows
lCellCount = headingRow.CellCount
lRowCount = selectedRows.Count
'enumerate selected rows
For lRowIndex = 1 To lRowCount
Set selectedRow = selectedRows(lRowIndex)
HMIRuntime.Trace "Row number: " & CStr(lRowIndex) & vbNewLine
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
Next
Next
Nota
del listado.

VB Scripting
Consulte también
GetStatisticAreaColumn (RT Professional)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la ventana del área
estadística de la tabla de evaluación como tipo "ICCAxRulerColumn".
Sintaxis
Expresión.GetStatisticAreaColumn(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la columna de la ventana del
área estadística.
Ejemplo
'VBS327
Dim ctrl
Dim objStatAreaCol
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("DatasourceY")
objStatAreaCol.Visible = FALSE
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("ValueY(LL)")
objStatAreaCol.Sort = 1

VB Scripting
Nota
del listado.
En el listado "StatisticAreaColumn" debe escribirse, p. ej., "objStatAreaCol.Visible" en lugar
de "objStatAreaCol.ColumnVisible".
Consulte también
GetStatisticAreaColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna de la ventana del área estadística de la
tabla de evaluación como tipo "ICCAxCollection".
Sintaxis
Expresión.GetStatisticAreaColumnCollection()
Expresión
Parámetro
--

● Count
● Item

VB Scripting
Ejemplo
'VBS328
Dim ctrl
Dim coll
Dim statcol
Set coll = ctrl.GetStatisticAreaColumnCollection
HMIRuntime.Trace "Number of statistic Area columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
Consulte también
GetStatisticResultColumn (RT Professional)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la ventana estadística de
la tabla de evaluación como tipo "ICCAxRulerColumn".
Sintaxis
Expresión.GetStatisticResultColumn(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la columna de la ventana es‐
tadística.

VB Scripting
Ejemplo
'VBS329
Dim ctrl
Dim objStatResCol
Set objStatResCol = ctrl.GetStatisticResultColumn("MaxValue")
objStatResCol.Visible = FALSE
Set objStatResCol = ctrl.GetStatisticResultColumn("Average")
objStatResCol.Sort = 2
Nota
del listado.
En el listado "StatisticResultColumn" debe escribirse, p. ej., "objStatResCol.Visible" en lugar
de "objStatResCol.ColumnVisible".
Consulte también
GetStatisticResultColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna de la ventana estadística de la tabla de
evaluación como tipo "ICCAxCollection".
Sintaxis
Expresión.GetStatisticResultColumnCollection()
Expresión
Parámetro
--

VB Scripting

● Count
● Item
Ejemplo
'VBS330
Dim ctrl
Dim coll
Dim statcol
Set coll = ctrl.GetStatisticResultColumnCollection
HMIRuntime.Trace "Number of statistic result columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
Consulte también
GetStatusbarElement (RT Professional)
Descripción
Devuelve el elemento de la barra de estado designado por nombre o índice del control como
tipo "ICCAxStatusbarElement".
Sintaxis
Expresión.GetColumn(ByVal vIndex As Variant)
Expresión

VB Scripting
Parámetro
VARIANT
vIndex Índice o nombre del elemento de la barra de esta‐
do.
Ejemplo
'VBS331
Dim ctrl
Dim objStatusBar
Set objStatusBar = ctrl.GetStatusbarElement(1)
objStatusBar.Visible = FALSE
Set objStatusBar = ctrl.GetStatusbarElement(3)
objStatusBar.Width = 10
Nota
del listado.
En el listado "StatusbarElement" debe escribirse, p. ej., "objStatusBar.Visible" en lugar de
"objStatusBar.StatusbarElementVisible".
Consulte también
GetStatusbarElementCollection (RT Professional)
Descripción
Devuelve el listado de todos los elementos de la barra de estado del control como tipo
"ICCAxCollection".

VB Scripting
Sintaxis
Expresión.GetStatusbarElementCollection()
Expresión
Parámetro
--

● Count
● Item
Ejemplo
'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
Nota
del listado.
En el listado "StatusbarElement" debe escribirse, p. ej., "statelement.Name" en lugar de
"statelement.StatusbarElementName".

VB Scripting
Consulte también
GetTimeAxis (RT Professional)
Descripción
Devuelve el objeto de eje de tiempo, designado con un nombre o índice, del visor de curvas
f(t) como tipo "ICCAxTimeAxis".
Sintaxis
Expresión.GetTimeAxis(ByVal vIndex As Variant)
Expresión
Parámetros
VARIANT
vIndex Índice o nombre del eje temporal.

VB Scripting
Ejemplo
'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
Nota
del listado.
En el listado "TimeAxis" debe escribirse, p. ej., "objTimeAx.Visible" en lugar de
"objTimeAx.TimeAxisVisible".
Consulte también
GetTimeAxisCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de eje de tiempo del visor de curvas f(t) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetTimeAxisCollection()
Expresión
Parámetros
--

VB Scripting

● Count
● Item
Ejemplo
'VBS334
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis1
Dim objTimeAxis2
Dim objTrend
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis1 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2010")
Set objTimeAxis2 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2011")
objTimeAxis1.TrendWindow = objTrendWnd.Name
objTimeAxis1.Label = "2010"
objTimeAxis1.RangeType = 1
objTimeAxis1.BeginTime = "01.01.2010 0:00:00"
'objTimeAxis1.BeginTime = "01/01/2010 0:00:00"
objTimeAxis1.EndTime = "31.12.2010 11:59:59"
'objTimeAxis1.EndTime = "12/31/2010 11:59:59"
objTimeAxis2.TrendWindow = objTrendWnd.Name
objTimeAxis2.Label = "2011"
objTimeAxis2.RangeType = 1
objTimeAxis2.BeginTime = "01.01.2011 0:00:00"
'objTimeAxis2.BeginTime = "01/01/2011 0:00:00"
objTimeAxis2.EndTime = "31.12.2011 11:59:59"
'objTimeAxis2.EndTime = "12/31/2011 11:59:59"
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis1.Name
objTrend.TimeAxis = objTimeAxis2.Name

VB Scripting
Nota
del listado.
En el listado "TimeAxis" debe escribirse, p. ej., "objTimeAxis1.Label" en lugar de
"objTimeAxis1.TimeAxisLabel".
Consulte también
GetTimeColumn (RT Professional)
Descripción
Devuelve el objeto de columna de tiempo designado por nombre o índice del visor de tablas
como tipo "ICCAxTimeColumn".
Sintaxis
Expresión.GetTimeColumn(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la columna de tiempo.
Ejemplo
'VBS335
Dim ctrl
Dim objTimeCol
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn1")
objTimeCol.ShowDate = FALSE
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn2")
objTimeCol.Visible = FALSE

VB Scripting
Nota
del listado.
En el listado "TimeColumn" debe escribirse, p. ej., "objTimeColumn.ShowDate" en lugar de
"objTimeColumn.TimeColumnShowDate".
Consulte también
GetTimeColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna de tiempo del visor de tablas como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetTimeColumnCollection()
Expresión
Parámetros
--

● Count
● Item

VB Scripting
Ejemplo
'VBS336
Dim ctrl
Dim objTimeCol1
Dim objTimeCol2
Dim coll
Dim timecol
Set objTimeCol1 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2010")
Set objTimeCol2 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2011")
objTimeCol1.Caption = "2010"
objTimeCol1.RangeType = 1
objTimeCol1.BeginTime = "01.01.2010 0:00:00"
'objTimeCol1.BeginTime = "01/01/2010 0:00:00"
objTimeCol1.EndTime = "31.12.2010 11:59:59"
'objTimeCol1.EndTime = "12/31/2010 11:59:59"
objTimeCol2.Caption = "2011"
objTimeCol2.RangeType = 0
objTimeCol2.BeginTime = "01.01.2011 0:00:00"
'objTimeCol2.BeginTime = "01/01/2011 0:00:00"
objTimeCol2.TimeRangeFactor = 1
objTimeCol2.TimeRangeBase = 3600000
Set coll = ctrl.GetTimeColumnCollection
For Each timecol In coll
timecol.Align = 1
timecol.Length = 12
timecol.BackColor = RGB(240,240,0)
timecol.ForeColor = RGB(130,160,255)
Next
Consulte también
GetToolbarButton (RT Professional)
Descripción
Devuelve la función de tecla designada por nombre o índice de la barra de herramientas del
control como tipo "ICCAxToolbarButton".
Sintaxis
Expresión.GetToolbarButton(ByVal vIndex As Variant)

VB Scripting
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la función de tecla de la barra
de herramientas.
Ejemplo
'VBS337
Dim ctrl
Dim toolbu
Set toolbu = ctrl.GetToolbarButton ("ShowHelp")
HMIRuntime.Trace "Name: " & toolbu.Name & vbCrLf
HMIRuntime.Trace "Index: " & toolbu.Index & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
Nota
del listado.
En el listado "ToolbarButton" debe escribirse, p. ej., "toolbu.Index" en lugar de
"toolbu.ToolbarButtonIndex".
Consulte también

VB Scripting
GetToolbarButtonCollection (RT Professional)
Descripción
Devuelve el listado de todas las funciones de tecla de la barra de herramientas del control
Sintaxis
Expresión.GetToolbarButtonCollection()
Expresión
Parámetro
--

● Count
● Item
En ICCAxCollection encontrará los siguientes métodos:
Ejemplo
'VBS338
Dim ctrl
Dim coll
Dim toolbu
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
HMIRuntime.Trace "Authorization: " & toolbu.PasswordLevel & vbCrLf
Next

VB Scripting
Consulte también
GetTrend (RT Professional)
Descripción
Devuelve la curva designada por nombre o índice del visor de curvas f(t) o f(x) como tipo
"ICCAxTrend" o "ICCAxFunctionTrend".
Sintaxis
Expresión.GetTrend(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la curva.
Ejemplo de Runtime Professional
'VBS339
Dim ctrl
Dim objTrend
Set objTrend = ctrl.GetTrend( "Trend 1" )
objTrend.PointStyle = 1
objTrend.LineWidth = 4
Set objTrend = ctrl.GetTrend(2)
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag2"

VB Scripting
Nota
del listado.
En el listado "Trend" debe escribirse, p. ej., "objTrend.PointStyle" en lugar de
"objTrend.TrendPointStyle".
Consulte también
GetTrendCollection (RT Professional)
Descripción
Devuelve el listado de todas las curvas del visor de curvas f(t) o f(x) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetTrendCollection()
Expresión
Parámetro
--

● Count
● Item

VB Scripting
'VBS340
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Dim objTrend
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag1"
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValAxis.Name
Nota
del listado.
En el listado "Trend" debe escribirse, p. ej., "objTrend.TagName" en lugar de
"objTrend.TrendTagName".
Consulte también
GetTrendWindow (RT Professional)
Descripción
Devuelve el objeto de ventana de curvas designado por nombre o índice del visor de curvas
f(t) o f(x) como tipo "ICCAxTrendWindow".
Sintaxis
Expresión.GetTrendWindow(ByVal vIndex As Variant)

VB Scripting
Expresión
Parámetro
VARIANT
vIndex Índice o nombre de la ventana de curva.
'VBS341
Dim ctrl
Dim objTrendWnd
Set objTrendWnd = ctrl.GetTrendWindow(1)
objTrendWnd.Visible = FALSE
Set objTrendWnd = ctrl.GetTrendWindow("trend window 2")
objTrendWnd.VerticalGrid = TRUE
objTrendWnd.FineGrid = TRUE
Nota
del listado.
En el listado "TrendWindow" debe escribirse, p. ej., "objTrendWnd.Visible" en lugar de
"objTrendWnd.TrendWindowVisible".
Consulte también
GetTrendWindowCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de ventana de curvas del visor de curvas f(t) o f(x)

VB Scripting
Sintaxis
Expresión.GetTrendWindowCollection()
Expresión
Parámetro
--

● Count
● Item
'VBS342
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
Consulte también
GetValueAxis (RT Professional)
Descripción
Devuelve el objeto de eje de valores designado por nombre o índice del visor de curvas f(t)
como tipo "ICCAxValueAxis".

VB Scripting
Sintaxis
Expresión.GetValueAxis(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre del eje de valores.
Ejemplo
'VBS343
Dim ctrl
Dim objValAxis
Set objValAxis = ctrl.GetValueAxis(1)
objValAxis.Visible = FALSE
Set objValAxis = ctrl.GetValueAxis("axis 2")
objValAxis.Label = "Value axis 2"
objValAxis.ScalingType = 0
objValAxis.Precisions = 2
objValAxis.AutoRange = TRUE
Nota
del listado.
En el listado "ValueAxis" debe escribirse, p. ej., "objValueAx.Visible" en lugar de
"objValueAx.ValueAxisVisible".
Consulte también

VB Scripting
GetValueAxisCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de eje de valores del visor de curvas f(t) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetValueAxisCollection()
Expresión
Parámetro
--

● Count
● Item

VB Scripting
Ejemplo
'VBS344
Dim ctrl
Dim objTrendWnd
Dim objValAxis1
Dim objValAxis2
Dim objTrend
Set objValAxis1 = ctrl.GetValueAxisCollection.AddItem("myValueAxis1")
Set objValAxis2 = ctrl.GetValueAxisCollection.AddItem("myValueAxis2")
objValAxis1.TrendWindow = objTrendWnd.Name
objValAxis1.Label = "Value1"
objValAxis2.TrendWindow = objTrendWnd.Name
objValAxis2.inTrendColor = TRUE
objTrend.ValueAxis = objValAxis1.Name
objTrend.ValueAxis = objValAxis2.Name
Nota
del listado.
En el listado "ValueAxis" debe escribirse, p. ej., "objValueAxis1.Label" en lugar de
"objValueAxis1.ValueAxisLabel".
Consulte también
GetValueColumn (RT Professional)
Descripción
Devuelve el objeto de columna de valores, designado con un nombre o índice, del visor de
tablas como tipo "ICCAxValueColumn".
Sintaxis
Expresión.GetValueColumn(ByVal vIndex As Variant)

VB Scripting
Expresión
Parámetros
VARIANT
vIndex Índice o nombre de la columna de valores del visor de curvas
f(t).
Ejemplo
'VBS345
Dim ctrl
Dim objValueColumn
Set objValueColumn = ctrl.GetValueColumn("Valuecolumn1")
objValueColumn.Precisions = 4
Set objValueColumn = ctrl.GetValueColumn(2)
objValueColumn.ExponentialFormat = TRUE
Nota
del listado.
En el listado "ValueColumn" debe escribirse, p. ej., "objValueColumn.Precisions" en lugar de
"objValueColumn.ValueColumnPrecisions".
Consulte también
GetValueColumnCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de columna de valores del visor de curvas f(t) como
tipo "ICCAxCollection".

VB Scripting
Sintaxis
Expresión.GetValueColulmnCollection()
Expresión
Parámetro
--

● Count
● Item
Ejemplo
'VBS346
Dim ctrl
Dim objValCol1
Dim objValCol2
Dim coll
Dim valcol
Set objValCol1 = ctrl.GetValueColumnCollection.AddItem("ValueColumn1")
Set objValCol2 = ctrl.GetValueColumnCollection.AddItem("ValueColumn2")
objValCol1.Caption = "Value Archive"
objValCol1.Provider = 1
objValCol1.TagName = "ProcessValueArchive\arch1"
objValCol1.TimeColumn = "TimeColumn1"
objValCol2.Caption = "Value Tag"
objValCol2.Provider = 2
objValCol2.TagName = "tagxx"
objValCol2.TimeColumn = "TimeColumn2"
Set coll = ctrl.GetValueColumnCollection
For Each valcol In coll
valcol.Align = 2
valcol.Length = 10
valcol.AutoPrecisions = TRUE
Next

VB Scripting
Consulte también
GetXAxis (RT Professional)
Descripción
Devuelve el objeto de eje X designado por nombre o índice del visor de curvas f(x) como tipo
"ICCAxValueAxis".
Sintaxis
Expresión.GetXAxis(ByVal vIndex As Variant)
Expresión
Parámetro
VARIANT
vIndex Índice o nombre del eje X.
Ejemplo
'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)
Nota
del listado.
En el listado "XAxis" debe escribirse, p. ej., "objXAx.Visible" en lugar de "objXAx.XAxisVisible".

VB Scripting
Consulte también
GetXAxisCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de eje X del visor de curvas f(x) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetXAxisCollection()
Expresión
Parámetro
--

● Count
● Item

VB Scripting
Ejemplo
'VBS348
Dim ctrl
Dim objXAxis1
Dim objXAxis2
Dim coll
Dim axes
Set objXAxis1 = ctrl.GetXAxisCollection.AddItem("myXAxis1")
objXAxis1.Label = "temperature"
Set objXAxis2 = ctrl.GetXAxisCollection.AddItem("myXAxis2")
objXAxis2.Label = "pressure"
Set coll = ctrl.GetXAxisCollection
HMIRuntime.Trace "Number of XAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
Nota
del listado.
En el listado "XAxis" debe escribirse, p. ej., "objXAxis1.Label" en lugar de
"objXAxis1.XAxisLabel".
Consulte también
GetYAxis (RT Professional)
Descripción
Devuelve el objeto de eje Y designado por nombre o índice del visor de curvas f(x) como tipo
"ICCAxValueAxis".
Sintaxis
Expresión.GetYAxis(ByVal vIndex As Variant)
Expresión

VB Scripting
Parámetro
VARIANT
vIndex Índice o nombre del eje Y.
Ejemplo
'VBS349
Dim ctrl
Dim objYAx
Set objYAx = ctrl.GetYAxis(1)
objYAx.Visible = FALSE
Set objYAx = ctrl.GetYAxis("axis 2")
objYAx.Label = "Y axis 2"
objYAx.Align = 0
objYAx.Precisions = 3
objYAx.EndValue = 90.000
objYAx.BeginValue = 10.000
Nota
del listado.
En el listado "YAxis" debe escribirse, p. ej., "objYAx.Visible" en lugar de "objYAx.YAxisVisible".
Consulte también
GetYAxisCollection (RT Professional)
Descripción
Devuelve el listado de todos los objetos de eje Y del visor de curvas f(x) del tipo
"ICCAxCollection".
Sintaxis
Expresión.GetYAxisCollection()

VB Scripting
Expresión
Parámetro
--

● Count
● Item
Ejemplo
'VBS350
Dim ctrl
Dim objYAxis1
Dim objYAxis2
Dim coll
Dim axes
Set objYAxis1 = ctrl.GetXAxisCollection.AddItem("myYAxis1")
objYAxis1.Label = "temperature"
Set objYAxis2 = ctrl.GetXAxisCollection.AddItem("myYAxis2")
objYAxis2.Label = "pressure"
Set coll = ctrl.GetYAxisCollection
HMIRuntime.Trace "Number of YAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
Nota
del listado.
En el listado "YAxis" debe escribirse, p. ej., "objYAxis1.Label" en lugar de
"objYAxis1.YAxisLabel".

VB Scripting
Consulte también
1.5.6.2 Métodos H-R (Panels, Comfort Panels, RT Advanced, RT Professional)
HideAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Ocultar aviso" del visor de avisos.
Sintaxis
Expression.HideAlarm()
Expression
Parámetro
--
Consulte también
InsertData (RT Professional)
Descripción
Añade datos a la curva solicitada.
Sintaxis
Expresión.InsertData(dblAxisX As Variant, dblAxisY As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "Trend".

VB Scripting
Parámetro
dblAxisX Valor del eje X
dblAxisY Valor del eje Y
Ejemplo
'VBS300
Dim lngFactor
Dim dblAxisX
Dim dblAxisY
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
For lngFactor = -100 To 100
dblAxisX = CDbl(lngFactor * 0.02)
dblAxisY = CDbl(dblAxisX * dblAxisX + 2 * dblAxisX + 1)
objTrend.InsertData dblAxisX, dblAxisY
Next
Item (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve un elemento de una lista.
Sintaxis
Expression.Item(Index)
Expression
Obligatorio. Expresión que devuelve una lista.
Parámetro
Índice
Nombre o número de índice de un elemento de la lista:
● Lista ScreenItems: Utilice el nombre de objeto, p. ej.
"HmiRuntime.Screens(1).ScreenItems("Circle")", o bien el número de índice.
● Lista Screens: Utilice el nombre o el número de índice.
● Lista SmartTags: En la lista "SmartTags", sólo los nombres de variables se pueden utilizar
como índice. Por tanto, no es posible enumerar todas las variables.

VB Scripting
Si el valor indicado no coincide con ningún elemento de la lista, aparecerá un error. El valor
de retorno obtendrá el valor "Nothing".
On Error Resume Next

Dim screen
Set screen = HmiRuntime.Screens("Screen_1")
If (screen is Nothing)
then...
Else...
End If
Para tener un soporte óptimo con la función de autocompletar, se recomienda utilizar un

direccionamiento combinado mediante los nombres de la imagen y del objeto, p. ej.
"HmiRuntime.Screens("Screen").ScreenItems("Circle")".
Ejemplo
El método "Item" es el método estándar para las listas. Por tanto, los dos siguientes ejemplos
ofrecen el mismo resultado:
'VBS_Example_Item
HMIRuntime.Screens.Item(1)
HMIRuntime.Screens(1)
Ambas instrucciones crean referencias respectivamente de la imagen raíz.
Consulte también
ScreenItems (lista) (Página 222)
LockAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Bloquear aviso" del visor de avisos.
Sintaxis
Expression.LockAlarm()
Expression

VB Scripting
Parámetro
--
Consulte también
LoopInAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Loop in Alarm" del visor de avisos.
Sintaxis
Expression.LoopInAlarm()
Expression
Parámetro
--
Consulte también
MoveAxis (RT Professional)
Descripción
Ejecuta la función del botón "Desplazar área del eje" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.MoveAxis()
Expression
Parámetro
--

VB Scripting
Consulte también
MoveToFirst (RT Professional)
Descripción
Ejecuta la función del botón "Primera fila" del control.
Sintaxis
Expression.MoveToFirst()
Expression
Parámetros
--
Consulte también
MoveToFirstLine (RT Professional)
Descripción
Ejecuta la función del botón "Primer aviso" del visor de avisos.
Sintaxis
Expression.MoveToFirstLine()
Expression
Parámetro
--

VB Scripting
Consulte también
MoveToFirstPage (RT Professional)
Descripción
Ejecuta la función del botón "Primera página" del visor de avisos.
Sintaxis
Expression.MoveToFirstPage()
Expression
Parámetro
--
Consulte también
MoveToLast (RT Professional)
Descripción
Ejecuta la función del botón "Último registro" del control.
Sintaxis
Expression.MoveToLast()
Expression
Parámetros
--

VB Scripting
Consulte también
MoveToLastLine (RT Professional)
Descripción
Ejecuta la función del botón "Último aviso" del visor de avisos.
Sintaxis
Expression.MoveToLastLine()
Expression
Parámetro
--
Consulte también
MoveToLastPage (RT Professional)
Descripción
Ejecuta la función del botón "Última página" del visor de avisos.
Sintaxis
Expression.MoveToLastPage()
Expression
Parámetro
--

VB Scripting
Consulte también
MoveToNext (RT Professional)
Descripción
Ejecuta la función del botón "Registro siguiente" del control.
Sintaxis
Expression.MoveToNext()
Expression
Parámetros
--
Consulte también
MoveToNextLine (RT Professional)
Descripción
Ejecuta la función del botón "Aviso siguiente" del visor de avisos.
Sintaxis
Expression.MoveToNextLine()
Expression
Parámetro
--

VB Scripting
Consulte también
MoveToNextPage (RT Professional)
Descripción
Ejecuta la función del botón "Página siguiente" del visor de avisos.
Sintaxis
Expression.MoveToNextPage()
Expression
Parámetro
--
Consulte también
MoveToPrevious (RT Professional)
Descripción
Ejecuta la función del botón "Registro anterior" del control.
Sintaxis
Expression.MoveToPrevious()
Expression
Parámetros
--

VB Scripting
Consulte también
MoveToPreviousLine (RT Professional)
Descripción
Ejecuta la función del botón "Aviso anterior" del visor de avisos.
Sintaxis
Expression.MoveToPreviousLine()
Expression
Parámetro
--
Consulte también
MoveToPreviousPage (RT Professional)
Descripción
Ejecuta la función del botón "Página anterior" del visor de avisos.
Sintaxis
Expression.MoveToPreviousPage()
Expression
Parámetro
--

VB Scripting
Consulte también
NextColumn (RT Professional)
Descripción
Ejecuta la función del botón "Columna siguiente" del visor de tablas.
Sintaxis
Expression.NextColumn()
Expression
Parámetro
--
Consulte también
NextTrend (RT Professional)
Descripción
Ejecuta la función del botón "Siguiente curva" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.NextTrend()
Expression
Parámetro
--
Consulte también

VB Scripting
OneToOneView (RT Professional)
Descripción
Ejecuta la función del botón "Vista original" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.OneToOneView()
Expression
Parámetro
--
Consulte también
PasteRows (RT Professional)
Descripción
Ejecuta la función del botón "Insertar líneas" del visor de recetas.
Sintaxis
Expression.PasteRows()
Expression
Parámetro
--
Consulte también

VB Scripting
PreviousColumn (RT Professional)
Descripción
Ejecuta la función del botón "Columna anterior" del visor de tablas.
Sintaxis
Expression.PreviousColumn()
Expression
Parámetro
--
Consulte también
PreviousTrend (RT Professional)
Descripción
Ejecuta la función del botón "Curva anterior" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.PreviousTrend()
Expression
Parámetro
--
Consulte también

VB Scripting
Print (RT Professional)
Descripción
Ejecuta la función del botón "Imprimir" del control.
Sintaxis
Expression.Print()
Expression
Parámetros
--
Consulte también
QuitHorn (RT Professional)
Descripción
Ejecuta la función del botón "Acuse de avisador central" del visor de avisos.
Sintaxis
Expression.QuitHorn()
Expression
Parámetro
--

VB Scripting
Consulte también
QuitSelected (RT Professional)
Descripción
Ejecuta la función del botón "Acuse individual" del visor de avisos.
Sintaxis
Expression.QuitSelected()
Expression
Parámetro
--
Consulte también
QuitVisible (RT Professional)
Descripción
Ejecuta la función del botón "Acuse de grupo" del visor de avisos.
Sintaxis
Expression.QuitVisible()
Expression
Parámetro
--
Consulte también

VB Scripting
Read (RT Professional)
Descripción para objeto Tag

Lee el estado de una variable (objeto Tag) poco después del momento de inicio.
Simultáneamente el objeto Tag es suministrado con los valores leídos. Cuando se leen las
variables se determina el valor, el Quality Code y el sello de tiempo de las variables. Por medio
de la propiedad "LastError" se puede determinar si el inicio fue exitoso.
Esto no modifica las propiedades "Name" y "Tagprefix".
Si se lee con éxito el valor de las variables, entonces las propiedades del objeto Tag serán
ocupadas con los siguientes valores:
Propiedad Ocupación
Value Valor de las variables
Nombre Nombre de variable (no modificado)
QualityCode Nivel de calidad
TimeStamp Sello de tiempo actual de las variables
LastError 0
ErrorDescription ""
Si no se lee con éxito el valor de las variables, entonces las propiedades del objeto Tag serán
Value VT_Empty
Nombre Nombre de variable (no modificado)
QualityCode Bad Out of Service
TimeStamp 0
LastError Código de error de la operación de lectura
ErrorDescription Descripción del error de LastError
Sintaxis
Expresión.Read([Readmode])
Expresión
Se necesita. Una expresión que retorna un objeto Tag. El valor de retorno del método Read
es el valor de las variables leídas.

VB Scripting
Parámetro
Por medio del parámetro opcional "Readmode" se diferencia entre dos tipos de lectura:
0 El valor de las variables es leído de la imagen del
proceso (cache). 0 es el valor Default.
1 El valor de las variables es leído directamente del
PLC o del canal (sincrónicamente).
Si se omite el parámetro "Readmode" se leerá de manera estándar de la imagen de proceso.

El valor de retorno del método Read es el valor de la variable leída como VARIANT.
Lectura desde la imagen de proceso

En una lectura desde una imagen de proceso, la variable será identificada (dada de alta) y a
partir de allí será solicitada cíclicamente del controlador. El ciclo de la identificación depende
del disparador configurado. El valor será leído de la imagen de variable de WinCC. Cuando
se deselecciona la imagen, las variables serán dadas de baja. La ejecución se caracteriza por
lo siguiente:
● El valor será leído de la imagen de variable de WinCC
● En comparación con la lectura directa, la ejecución es más rápida (a excepción de la
primera ejecución: La primera ejecución, por lo general, dura más tiempo, porque el valor
se lee y se da de alta desde el PLC).
● La duración de la llamada no depende de lo recargado que esté el bus o del PLC
Comportamiento en acciones con disparador de variable
Todas las variables contenidas en un disparador de variable ya son conocidas cuando se
selecciona la imagen, y se identificarán con el tiempo de control indicado. Como todas las
variables son solicitadas al mismo tiempo, el canal podrá lograr la mejor optimización posible.
Si dentro de una acción se solicita con Read una variable contenida en un disparador, ya
existirá el valor y será entregado a la llamada. Si se solicita una variable que no está en un
disparador, el comportamiento será como en un disparador estándar (trigger estándar).
Comportamiento en acciones con disparador cíclico
En una primera llamada, la variable será identificada con la mitad del ciclo. En cada llamada
siguiente ya existirá el valor.
Comportamiento en acciones disparadas por eventos
En una primera llamada, la variable será identificada en el modo "Al cambiar". Las variables
de proceso que están identificadas en el modo "Al cambiar" corresponden a una orden de
lectura cíclica con un ciclo de 1s.
Si con un evento (p. ej. clic del ratón) se solicita asincrónicamente un valor, la variable será
aceptada en la imagen de variable. A partir de este momento la variable será solicitada
cíclicamente del PLC y por consiguiente incrementará la carga básica. Para evadir este
incremento de la carga básica, Ud. puede leer el valor también sincrónicamente. La llamada
sincrónica ocasiona, por cierto, una vez una mayor carga de comunicación, pero la variable
no será aceptada en la imagen de variable.

VB Scripting
Leer directamente
En una lectura directa se retornará el valor actual. La variable no será identificada
cíclicamente, sino el valor será solicitado una vez del PLC. La lectura directa tiene las
siguientes propiedades:
● El valor será leído explícitamente del PLC
● La ejecución dura más tiempo en comparación a la lectura desde la imagen de proceso
● La duración de la llamada depende, entre otras razones, de lo recargado que esté el bus
o del PLC
Ejemplo
Lectura de una variable directamente desde el PLC o el canal
'VBS100
Dim objTag
Dim vntValue
vntValue = objTag.Read(1) 'Read direct
MsgBox vntValue
Lectura de una variable desde la imagen de proceso
'VBS101
Dim objTag
Dim vntValue
vntValue = objTag.Read 'Read from cache
MsgBox vntValue

El objeto TagSet ofrece la posibilidad de leer varias variables con una ejecución.
El modo de funcionamiento es igual al de un objeto Tag. A continuación se describirán
únicamente las diferencias.
Expresión
Lectura desde la imagen de proceso

El objeto TagSet ofrece la ventaja de poder solicitar varias variables con una orden de pedido.
En este caso se agrupan las variables, mejorándose por consiguiente el rendimiento.

VB Scripting
Leer directamente
En una ejecución se pueden procesar varias órdenes de lectura, mejorándose así el
rendimiento en comparación a varias ejecuciones individuales.
Ejemplo
El ejemplo siguiente muestra cómo se introducen variables en el listado TagSet y cómo se
leen después.
'VBS174
Dim group
group.Add "Motor1"
group.Add "Motor2"
group.Read
HMIRuntime.Trace "Motor1: " & group("Motor1").Value & vbNewLine
HMIRuntime.Trace "Motor2: " & group("Motor2").Value & vbNewLine
Si el parámetro opcional "Readmode" se define con 1, las variables de proceso no serán dadas
de alta sino serán leídas directamente desde el PLC o el canal.
group.Read 1
ReadTags (RT Professional)
Descripción
Ejecuta la función del botón "Leer variables" del visor de recetas.
Sintaxis
Expression.ReadTags()
Expression
Parámetro
--
Consulte también

VB Scripting
Refresh (RT Professional)
Descripción
Dibuja nuevamente todas las imágenes visibles.
Sintaxis
Expresión.Refresh
Expresión
Obligatorio. Una expresión que retorna un objeto de tipo "Screens" o "Screen".
Parámetro
--
Ejemplos
El primer ejemplo obliga el nuevo dibujo inmediato de todas las imágenes visibles:
'VBS149
HMIRuntime.Screens.Refresh
El segundo ejemplo obliga el nuevo dibujo inmediato de la imagen básica:
'VBS150
HMIRuntime.Screens(1).Refresh
Consulte también
Remove (RT Professional)

Elimina una variable del listado TagSet. La variable se puede eliminar a través del nombre o
a través de una referencia de un objeto Tag.
Sintaxis
Expresión.Remove [Tag]

VB Scripting
Expresión
Parámetro
VARIANT
Variable;Tag Nombre de una variable WinCC o referencia de
un objeto Tag que deberá ser eliminado del lista‐
do.
Ejemplo
El siguiente ejemplo muestra cómo se incluyen varias variables en un listado TagSet y cómo
se elimina luego una variable.
'VBS175
Dim group
group.Add "Motor1"
group.Add "Motor2"
group.Remove "Motor1"

Borra de un listado el elemento indicado en el parámetro "Name".
Sintaxis
Expresión.Remove [Name]
Expresión
Parámetro
VARIANT
Nombre Nombre del objeto que debe ser eliminado del lis‐
tado.

VB Scripting
Ejemplo
El ejemplo muestra cómo se elimina del listado el objeto "motor1".
'VBS166
Descripción para objetos Logging, AlarmLogs, DataLogs

El método borra del proyecto runtime segmentos de fichero que han sido almacenados
anteriormente.
Los segmentos de fichero borrados con el método "Remove" se eliminarán de la carpeta
"Common Archiving" del proyecto.
La ejecución pude durar un tiempo prolongado dependiendo de los datos del fichero. Esto
puede bloquear el procesamiento de los siguientes scripts. Se puede evitar un bloqueo de las
acciones en la imagen iniciando la llamada en una acción en el Global Scripting, por ejemplo
iniciando la acción por medio de una variable de disparador.
Desconectando / borrando los ficheros se genera la carga CPU. Esto tiene efecto en el
rendimiento.
Nota
La activación del método "Remove" se puede ejecutar actualmente sólo en el servidor. Sin
embargo existe un ejemplo que muestra cómo se puede iniciar el método en el cliente desde
el servidor.
Sintaxis
Objetos Logging, AlarmLogs

Expresión.Remove [TimeFrom] [TimeTo] [TimeOut] [ServerPrefix]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "Logging" o "AlarmLogs".
Objeto DataLogs
Expresión.Remove [TimeFrom] [TimeTo] [TimeOut] [Type] [ServerPrefix]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataLogs".

VB Scripting
Parámetro
TimeFrom
Momento a partir del cual se deben borrar los ficheros.
Al indicar el instante, es posible también una forma abreviada, como se describe en el apartado
"Formato de los datos de tiempo".
TimeTo
Momento hasta el que se deben borrar los segmentos de fichero.
Timeout
Timeout en milisegundos.
Si introduce "-1" como valor, se esperará de manera infinita (infinite). Si introduce el valor "0",
no se esperará
Tipos
Tipo de fichero.
Este parámetro se puede utilizar (opcional) únicamente para borrar segmentos de ficheros de
Tag Logging.
Pueden introducirse estos valores:
Valor asignado Tipo Descripción

1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reservado para versiones futuras.
Valor de retorno
Si se ha presentado un error durante el borrado de los segmentos de fichero, el método retorna
un mensaje de error. Para más información consultar el tema "Avisos de fallos del área de
bases de datos".
Formato de los datos de tiempo

El formato de indicación de los instantes se define de la siguiente manera: YYYY-MM-DD
hh:mm:ss, siendo YYYY el año, MM el mes, DD el día, hh la hora, mm los minutos y ss los
segundos. A modo de ejemplo, la hora 2 minutos y un segundo después de las 11 horas del
26 de julio de 2004 se representa así: 2004-07-26 11:02:01.
En los parámetros "TimeFrom" y "TimeTo" se puede indicar en forma abreviada la fecha y la
hora. En esta forma no es necesario rellenar todos los campos del formato. La forma abreviada
significa que en la indicación de fecha/hora se pueden suprimir uno o varios parámetros que
comienzan con el valor de segundos. Según esto, la indicación podría realizarse, p. ej., en los
formatos "YYYY-MM" o "YYYY-MM-DD hh". Con la indicación "TimeFrom" = "2004-09" y

VB Scripting
"TimeTo" = "2004-10-04" se almacenan todos los segmentos de fichero desde septiembre del
2004 hasta el 4 de octubre inclusive.
Ejemplo
En el siguiente ejemplo se eliminarán posteriormente (otra vez) segmentos de fichero
almacenados de un intervalo de tiempo determinado, y el valor de retorno será emitido como
Trace.
'VBS182
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("2004-08-22","2004-09-22",-1) &
vbNewLine
En el siguiente ejemplo se eliminarán posteriormente (otra vez) segmentos de fichero

almacenados, y el valor de retorno será emitido como Trace.
'VBS183
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("","",-1) & vbNewLine
Consulte también
RemoveAll (RT Professional)

Borra todas las variables de un listado TagSet.
Sintaxis
Expresión.RemoveAll
Expresión
Parámetros
--

VB Scripting
Ejemplo
El siguiente ejemplo muestra cómo se incluyen varias variables en un listado TagSet y cómo
todas se eliminan luego.
'VBS176
Dim group
group.Add "Motor1"
group.Add "Motor2"
group.RemoveAll

Borra todos los valores o referencias de objetos de un listado DataSet.
Sintaxis
Expresión.RemoveAll
Expresión
Parámetros
--
Ejemplo
El ejemplo muestra cómo se eliminan todos los objetos del listado.
'VBS167
HMIRuntime.DataSet.RemoveAll
Consulte también
Restore (RT Professional)
Descripción para objetos Logging, AlarmLogs, DataLogs

El método agrega al proyecto runtime segmentos de fichero que han sido intercambiados.
Cuando se almacenan los segmentos de fichero, se copian en la carpeta "Common Archiving"
del proyecto. Para hacerlo debe existir la capacidad de memoria respectiva.

VB Scripting
La ejecución pude durar un tiempo prolongado dependiendo de los datos de fichero. Esto
puede bloquear el procesamiento de los siguientes scripts. Se puede evitar un bloqueo de las
acciones en la imagen iniciando la llamada en una acción en el Global Scripting, por ejemplo
iniciando la acción por medio de una variable de disparador.
Durante la conexión / copia de ficheros se carga la CPU, ya que el servidor SQL se recarga
más al estar activado especialmente el control de firma. Durante la copia de los segmentos
de fichero se vuelve más lento el acceso al disco duro.
Cuando el control de firma está conectado se retornará un mensaje de error en el caso de
que se tenga que almacenar un fichero sin firma o un fichero que ha sido modificado. Siempre
se retornará un mensaje de error, incluso cuando se presenten varios errores durante un
proceso de almacenamiento. Adicionalmente se genera un mensaje de sistema WinCC para
cada segmento de fichero. En el indicador de eventos de Windows se añade una entrada bajo
el punto "Aplicación". De este modo se tiene la posibilidad de comprobar qué segmentos de
fichero producen el error.
● En el caso de un fichero sin signatura se retorna el valor "0x8004720F". En el indicador de
eventos se introduce la entrada "Validation of database <db_name> failed ! No signature
found !".
El fichero es almacenado.
● En el caso de un fichero modificado se retorna el valor "0x80047207". En el indicador de
eventos aparece la entrada "Validation of database <db_name> failed !.
El fichero no es almacenado.
Nota
La activación del método "Restore" se puede ejecutar actualmente sólo en el servidor. Sin
embargo existe un ejemplo que muestra cómo se puede iniciar el método en el cliente
desde el servidor.
Sintaxis
Objetos Logging, AlarmLogs

Expresión.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut]
[ServerPrefix]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "Logging" o "AlarmLogs".
Objeto DataLogs
Expresión.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut] [Type]
[ServerPrefix]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataLogs".

VB Scripting
Parámetro
SourcePath
Ruta para los datos de fichero.
TimeFrom
Momento a partir del cual se deben almacenar los ficheros.
TimeTo
Momento hasta el que se deben almacenar los segmentos de fichero.
Timeout
Timeout en milisegundos.
Si introduce "-1" como valor, se esperará de manera infinita (infinite). Si introduce el valor "0",
no se esperará.
Tipos
Tipo de fichero.
Este parámetro se puede utilizar (opcional) únicamente para archivar segmentos de ficheros
de Tag Logging.
Pueden introducirse estos valores:
Valor asignado Tipo Descripción

1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reservado para versiones futuras.
Valor de retorno
Si se ha presentado un error durante el almacenamiento de los segmentos de fichero, el
método retorna un mensaje de error. Para más información consultar el tema "Avisos de fallos
del área de bases de datos".
Formato de los datos de tiempo

El formato de indicación de los instantes se define de la siguiente manera: YYYY-MM-DD
hh:mm:ss, siendo YYYY el año, MM el mes, DD el día, hh la hora, mm los minutos y ss los
segundos. A modo de ejemplo, la hora 2 minutos y un segundo después de las 11 horas del
26 de julio de 2004 se representa así: 2004-07-26 11:02:01.
En los parámetros "TimeFrom" y "TimeTo" se puede indicar en forma abreviada la fecha y la
hora. En esta forma no es necesario rellenar todos los campos del formato. La forma abreviada

VB Scripting
significa que en la indicación de fecha/hora se pueden suprimir uno o varios parámetros que
comienzan con el valor de segundos. Según esto, la indicación podría realizarse, p. ej., en los
formatos "YYYY-MM" o "YYYY-MM-DD hh". Con la indicación "TimeFrom" = "2004-09" y
"TimeTo" = "2004-10-04" se almacenan todos los segmentos de fichero desde septiembre de
2004 hasta el 4 de octubre inclusive.
Ejemplo
En el siguiente ejemplo se almacenarán otra vez todos los segmentos de fichero a partir del
período indicado, y el valor de retorno será emitido como Trace.
'VBS184
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:\Folder","2004-09-14","",-1) &
vbNewLine
En el siguiente ejemplo se almacenarán otra vez todos los segmentos de fichero de Tag
Logging Slow del período indicado, y el valor de retorno será emitido como 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
En el siguiente ejemplo se almacenarán otra vez todos los segmentos de fichero de Alarm
Logging hasta el período indicado, y el valor de retorno será emitido como Trace.
'VBS186
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Remove("","2004-09-20",-1) &
vbNewLine
Consulte también
1.5.6.3 Métodos S-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
SelectAll (RT Professional)
Descripción
Selecciona todas las filas en un control basado en tablas.

VB Scripting
Sintaxis
Expression.SelectAll()
Expression
Parámetro
--
Consulte también
SelectedStatisticArea (RT Professional)
Descripción
Ejecuta la función del botón "Definir área estadística" del visor de tablas.
Sintaxis
Expression.SelectedStatisticArea()
Expression
Parámetro
--
Consulte también
SelectRow (RT Professional)
Descripción
Selecciona una determinada fila en un control basado en tablas.

VB Scripting
Sintaxis
Expresión.SelectRow ByVal IRow As Long, Optional bExtendSelection As
Boolean
Expresión
Parámetro
IRow Número de fila que se ha de seleccionar.
bExtendSelection Opción que especifica si se amplía la selección actual. Es relevante sólo si se
permite selección múltiple.
Ejemplo
● Actualmente está marcada la fila 1. Si se llama SelectRow 4, True, se marcarán las
filas 1 y 4.
● Actualmente está marcada la fila 1. Si se llama SelectRow 4, False o SelectRow 4
sin parámetro opcional, se marca solo la fila 4.
Consulte también
ServerExport (RT Professional)
Descripción
Ejecuta la función del botón "Exportar fichero" del visor de recetas.
Sintaxis
Expression.ServerExport()
Expression
Parámetro
--

VB Scripting
Consulte también
ServerImport (RT Professional)
Descripción
Ejecuta la función del botón "Importar fichero" del visor de recetas.
Sintaxis
Expression.ServerImport()
Expression
Parámetro
--
Consulte también
SetHTML (RT Professional)
Descripción
Escribe un código HTML en el área de representación del navegador HTML.
Sintaxis
Epression.SetHTML string
Expression
Necesario. Expresión que devuelve un objeto del tipo "HTMLBrowser".
Ejemplo
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>"

VB Scripting
Consulte también
SetOperationLock (RT Professional)
Descripción
Desactiva temporalmente la posibilidad de manejar una ventana de imagen. La respectiva
ventana de imagen se puede definir como transparente. El propio usuario define el grado de
transparencia.
Nota
Esta función está disponible para todas las ventanas de imagen a excepción de la imagen
raíz.
Nota
Los contenidos de la ventana de imagen que se ha bloqueado temporalmente no se actualizan
en un PC con sistema operativo Windows 7.
En un PC con Windows 8 o Windows 10, los contenidos de la ventana de imagen se actualizan
continuamente.
Sintaxis
Expression.SetOperationLock(ByVal LockState as Bool, ByVal
TransparencyLevel as Long)
Expression
Parámetro
True Se ha desactivado temporalmente la operabilidad de la ventana de imagen.
False Se ha activado la operabilidad de la ventana de imagen.
Value Valor de transparencia de la ventana de imagen
Ejemplo
En el siguiente ejemplo se bloquean los contenidos de la ventana de imagen
"MyLockedWindow" para la imagen "Screen_1" ajustando el parámetro "SetOperationLock"
a "true":
HmiRuntime.Screens("Screen_1").ScreenItems("MyLockedWindow").SetOperationL
ock true, 20

VB Scripting
El número "20" determina la transparencia de la ventana de imagen.

Si ajusta el parámetro "SetOperationLock" a "false", la ventana de imagen "MyLockedWindow"
vuelve a estar operable.
HmiRuntime.Screens("Screen_1").ScreenItems("MyLockedWindow").SetOperationL
ock false, 20
ShowColumnSelection (RT Professional)
Descripción
Ejecuta la función del botón "Seleccionar columnas" del visor de tablas.
Sintaxis
Expression.ShowColumnSelection()
Expression
Parámetro
--
Consulte también
ShowComment (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de comentario" del visor de avisos.
Sintaxis
Expression.ShowComment()
Expression
Parámetro
--

VB Scripting
Consulte también
ShowDisplayOptionsDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de opciones de visualización" del visor de avisos.
Sintaxis
Expression.ShowDisplayOptionsDialog()
Expression
Parámetro
--
Consulte también
ShowEmergencyQuitDialog (RT Professional)
Descripción
Ejecuta la función del botón "Acuse de emergencia" del visor de avisos.
Sintaxis
Expression.ShowEmergencyQuitDialog()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowHelp (RT Professional)
Descripción
Ejecuta la función del botón "Ayuda" del control.
Sintaxis
Expression.ShowHelp()
Expression
Parámetros
--
Consulte también
ShowHideList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de los avisos a ocultar" del visor de avisos.
Sintaxis
Expression.ShowHideList()
Expression
Parámetro
--

VB Scripting
Consulte también
ShowHitList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de aciertos" del visor de avisos.
Sintaxis
Expression.ShowHitList()
Expression
Parámetro
--
Consulte también
ShowInfoText (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de texto informativo" del visor de avisos.
Sintaxis
Expression.ShowInfoText()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowLockDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de bloqueos" del visor de avisos.
Sintaxis
Expression.ShowLockDialog()
Expression
Parámetro
--
Consulte también
ShowLockList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de inhibiciones" del visor de avisos.
Sintaxis
Expression.ShowLockList()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowLongTermArchiveList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de ficheros de largo plazo" del visor de avisos.
Sintaxis
Expression.ShowLongTermArchiveList()
Expression
Parámetro
--
Consulte también
ShowMessageList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de avisos" del visor de avisos.
Sintaxis
Expression.ShowMessageList()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowPercentageAxis (RT Professional)
Descripción
Ejecuta la función del botón "Eje relativo" del visor de curvas f(t).
Sintaxis
Expression.ShowPercentageAxis()
Expression
Parámetro
--
Consulte también
ShowPropertyDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de configuración" del control.
Sintaxis
Expression.ShowPropertyDialog()
Expression
Parámetros
--
Consulte también

VB Scripting

ShowSelectArchive (RT Professional)
Descripción
Ejecuta la función del botón "Seleccionar conexión de datos" del visor de recetas.
Sintaxis
Expression.ShowSelectArchive()
Expression
Parámetro
--
Consulte también
ShowSelection (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de selección" del visor de recetas.
Sintaxis
Expression.ShowSelection()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowSelectionDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de selección" del visor de avisos.
Sintaxis
Expression.ShowSelectionDialog()
Expression
Parámetro
--
Consulte también
ShowSelectTimeBase (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de base de tiempo" del visor de recetas.
Sintaxis
Expression.ShowSelectTimeBase()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowShortTermArchiveList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de ficheros de corto plazo" del visor de avisos.
Sintaxis
Expression.ShowShortTermArchiveList()
Expression
Parámetro
--
Consulte también
ShowSort (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de ordenación" del visor de recetas.
Sintaxis
Expression.ShowSort()
Expression
Parámetro
--
Consulte también

VB Scripting
ShowSortDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de ordenación" del visor de avisos.
Sintaxis
Expression.ShowSortDialog()
Expression
Parámetro
--
Consulte también
ShowTagSelection (RT Professional)
Descripción
Ejecuta la función del botón "Seleccionar conexión de datos" del control.
Sintaxis
Expression.ShowTagSelection()
Expression
Parámetros
--
Consulte también

VB Scripting
ShowTimebaseDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de base de tiempo" del visor de avisos.
Sintaxis
Expression.ShowTimebaseDialog()
Expression
Parámetro
--
Consulte también
ShowTimeSelection (RT Professional)
Descripción
Ejecuta la función del botón "Rango de tiempo Seleccionar" del control.
Sintaxis
Expression.ShowTimeSelection()
Expression
Parámetros
--
Consulte también

VB Scripting
ShowTrendSelection (RT Professional)
Descripción
Ejecuta la función del botón "Seleccionar curvas" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.ShowTrendSelection()
Expression
Parámetro
-- -
Consulte también
StartStopUpdate (RT Professional)
Descripción
Ejecuta la función del botón "Iniciar" o "Detener" del control.
Sintaxis
Expression.StartStopUpdate()
Expression
Parámetros
--
Consulte también

VB Scripting
Stop (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Finaliza WinCC Runtime.
Sintaxis
Expression.Stop()
Expression
Necesario. Una expresión que devuelve un objeto del tipo "HMIRuntime".
Parámetro
--
Consulte también
Trace (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Retorna un texto personalizado a través del canal del sistema operativo para avisos de
depuración.
El método HMIRuntime.Trace solo funciona para WinCC Runtime Professional. El texto
transferido como parámetro puede mostrarse con el objeto "Trabajo de impresión/diagnóstico
de script" o con la herramienta de diagnóstico "ApDiag". La herramienta de diagnóstico
"ApDiag" se instalará con Runtime Professional de forma predeterminada. Encontrará la
herramienta de diagnóstico en la ruta siguiente: "C:\Program Files (x86)\Siemens\Automation
\SCADA-RT_V11\WinCC\uTools". Puede consultar más información en Internet (https://
support.industry.siemens.com/cs/de/en/view/102777629).
Si se requiere un trace para Runtime Advanced o en un panel, se puede utilizar la función de
sistema "MostrarAvisoDeSistema".
Sintaxis
Expression.Trace"STRING"
Expression
Necesario. Expresión que devuelve un objeto del tipo "HMIRuntime".

VB Scripting
Parámetro
STRING
Texto que se emitirá como aviso de depuración.
Ejemplo
En el siguiente ejemplo se emite un aviso de depuración:
'VBS_Example_Trace
HMIRuntime.Trace "Customized error message"
Consulte también
UnhideAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Mostrar aviso" del visor de avisos.
Sintaxis
Expression.UnhideAlarm()
Expression
Parámetro
--
Consulte también
UnlockAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Habilitar aviso" del visor de avisos.
Sintaxis
Expression.UnlockAlarm()

VB Scripting
Expression
Parámetro
--
Consulte también
UnselectAll (RT Professional)
Descripción
Elimina todas las marcas de las celdas de un control basado en tablas.
Sintaxis
Expression.UnselectAll()
Expression
Parámetro
--
Consulte también
UnselectRow (RT Professional)
Descripción
Elimina las marcas de una determinada celda de un control basado en tablas.
Sintaxis
Expression.UnselectRow(ByVal IRow As Long)

VB Scripting
Expression
Parámetro
Long
IRow Número de la celda que se deselecciona.
Consulte también
Write (RT Professional)
Descripción para objeto Tag

Escribe un valor en una variable. Por medio de la propiedad "LastError" se puede determinar
si el inicio fue exitoso.
Si se activa con éxito el valor de las variables, entonces las propiedades del objeto Tag serán
Value Valor de las variables definido por el usuario (no
modificado)
Name Nombre de variable (no modificado)
TimeStamp 0
LastError 0
ErrorDescription ""
Si no se activa con éxito el valor de las variables, entonces las propiedades del objeto Tag
serán ocupadas con los siguientes valores:
Value Valor de las variables definido por el usuario (no
modificado)
Name Nombre de variable (no modificado)
TimeStamp 0

VB Scripting
LastError Código de error de la operación de escritura
ErrorDescription Descripción del error de LastError
Sintaxis
Expresión.Write [Value],[Writemode]
Expresión
Obligatorio. Una expresión que devuelve un objeto Tags.
Parámetros
El valor que se va a escribir puede ser entregado como parámetro directamente al método.
Si el parámetro no se indica, se utilizará el valor de la propiedad "Value". Con el parámetro
opcional "Writemode" Ud. puede elegir si el valor de la variable se debe escribir sincrónica o
asincrónicamente. Si no se utiliza el parámetro "Writemode" se escribirá asincrónicamente
como valor Default.
Durante un proceso de escritura no se suministra ninguna información referente al estado de
las variables.
En la propiedad "Value" está el valor que se definió antes o durante la operación de escritura,
es decir, él no tiene entonces que corresponder al valor actual real de la variable. Si Ud. desea
actualizar las informaciones referentes a la variable, utilice el método Read.
Value (opcional) Se indica el valor de las variables. El valor indicado
sobrescribe el valor de la propiedad "Value" en un
objeto Tag.
No se indica el valor de las variables. La variable
recibe el valor actual de la propiedad "Value" del
objeto Tag.
Writemode (opcional) 0 o vacío: El valor de la variable se escribe asin‐
crónicamente. 0 es el valor Default.
1: El valor de la variable se escribe sincrónicamen‐
te.
En una escritura asincrónica se escribe inmediatamente en la imagen de la variable. El usuario

no recibe ninguna respuesta que indique si el valor también fue escrito en el AS.
En una escritura sincrónica (directamente al AS) se escribe recién cuando el autómata
programable está listo. El usuario recibe una respuesta si la escritura no fue exitosa.

VB Scripting
Ejemplo
Escritura asincrónica
'VBS104
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write
MsgBox objTag.Value
'VBS105
Dim objTag
objTag.Write 5
MsgBox objTag.Value
Escritura sincrónica
'VBS106
Dim objTag
objTag.Value = 5
objTag.Write ,1
MsgBox objTag.Value
'VBS107
Dim objTag
objTag.Write 5, 1
MsgBox objTag.Value

El objeto TagSet ofrece la posibilidad de escribir varias variables con una ejecución.
El modo de funcionamiento es igual al de un objeto Tag. A continuación se describirán
únicamente las diferencias.
Expresión
Obligatorio. Una expresión que devuelve un objeto de tipo "TagSet".

VB Scripting
Parámetros
Para escribir valores diferentes hay que definir la propiedad "Value" de cada uno de los objetos
Tag, y luego hay que ejecutar Write sin el parámetro "Value". La agrupación de órdenes de
escritura en una ejecución arroja un mejor rendimiento en comparación a las ejecuciones
individuales.
En un objeto TagSet no es posible asignar un valor con el método "Write". Cada uno de los
valores debe ser definido a través de la propiedad "Value" de cada objeto Tag.
Ejemplo
El siguiente ejemplo muestra cómo se agregan variables en la TagSet Collection, cómo se
definen los valores de variables, y cómo se escriben posteriormente.
'VBS173
Dim group
group.Add "Valor1"
group.Add "Valor2"
group("Valor1").Value = 3
group("Valor2").Value = 9
group.Write
Si el parámetro opcional "Writemode" se define en 1, las variables de proceso se escribirán

sincrónicamente (directamente en el PLC).
group.Write 1
WriteTags (RT Professional)
Descripción
Ejecuta la función del botón "Escribir variables" del visor de recetas.
Sintaxis
Expression.WriteTags()
Expression
Parámetro
--

VB Scripting
Consulte también
ZoomArea (RT Professional)
Descripción
Ejecuta la función del botón "Ampliar sección" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.ZoomArea()
Expression
Parámetro
--
Consulte también
ZoomInOut (RT Professional)
Descripción
Ejecuta la función del botón "Zoom +/-" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.ZoomInOut()
Expression
Parámetro
--

VB Scripting
Consulte también
ZoomInOutTime (RT Professional)
Descripción
Ejecuta la función del botón "Zoom eje de tiempos +/-" del visor de curvas f(t).
Sintaxis
Expression.ZoomInOutTime()
Expression
Parámetro
--
Consulte también
ZoomInOutValues (RT Professional)
Descripción
Ejecuta la función del botón "Zoom eje de valores +/-" del visor de curvas f(t).
Sintaxis
Expression.ZoomInOutValues()
Expression
Parámetro
--
Consulte también

VB Scripting
ZoomInOutX (RT Professional)
Descripción
Ejecuta la función del botón "Zoom eje X +/-" del visor de curvas f(x).
Sintaxis
Expression.ZoomInOutX()
Expression
Parámetro
--
Consulte también
ZoomInOutY (RT Professional)
Descripción
Ejecuta la función del botón "Zoom eje Y +/-" del visor de curvas f(x).
Sintaxis
Expression.ZoomInOutY()
Expression
Parámetro
--
Consulte también

VB Scripting
ZoomMove (RT Professional)
Descripción
Ejecuta la función del botón "Desplazar área de curva" de los visores de curvas f(t) y f(x).
Sintaxis
Expression.ZoomMove()
Expression
Parámetro
--
Consulte también

C-Scripting (RT Professional) 2
2.1.1 ActivateNextScreen (RT Professional)
Descripción
WinCC guarda los nombres de las imágenes que abrió el usuario durante el tiempo de
ejecución, así como el orden en el que se abrieron.
Utilizable sólo en C-Scripting.
El tamaño del búfer de imágenes se determina en el editor "Configuración de runtime >
Imágenes > Búfer de imágenes".
La función de sistema ActivateNextScreen abre la imagen que se abrió antes de la última
llamada de ActivatePreviousScreen.
Sintaxis
BOOL ActivateNextScreen();
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
se ha producido un error.
Ejemplo
El siguiente código de programa activa la imagen siguiente con la función ActivateNextScreen
y guarda el valor de retorno en la variable b_error.

C-Scripting (RT Professional)
{
BOOL b_error;
//Open next screen

b_error = ActivateNextScreen();
if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}
2.1.2 ActivatePreviousScreen (RT Professional)
Descripción
WinCC guarda los nombres de las imágenes que abrió el usuario durante el tiempo de
ejecución, así como el orden en el que se abrieron.
La función de sistema sólo puede utilizarse en C-Scripting.
El tamaño del búfer de imágenes se determina en el editor "Configuración de runtime >
Imágenes > Búfer de imágenes".
La función de sistema ActivatePreviousScreen abre la imagen que estaba abierta antes de la
imagen que se encuentra abierta en estos momentos.
Sintaxis
BOOL ActivatePreviousScreen();
Valor de retorno
TRUE
FALSE
Se ha producido un error.

Ejemplo
El siguiente código de programa activa la imagen anterior con la función
ActivatePreviousScreen y guarda el valor de retorno en la variable b_error.
{
BOOL b_error;
//Open previous screen

b_error = ActivatePreviousScreen();
if(b_error)
{
...
}
else
{
...
}
...
}
2.1.3 ActivateScreen (RT Professional)
Descripción



Parámetros
Nombre de imagen
Número del objeto

configuración.
Si indica "0":
enfocada.
Nota
cambio de imagen.
Ejemplo
'Userdefined code
2.1.4 ActivateScreenInScreenWindow (RT Professional)
Descripción
Efectúa un cambio de imagen en la ventana indicada para visualizar la imagen indicada.

ActivarImagenEnVentana (Nombre de imagen, Ventana de imagen, Nuevo nombre de imagen)


ActivateScreenInScreenWindow Screen_name, Screen_window, New_screen_name
Parámetros
Nombre de imagen
Nombre de la imagen que se muestra en la ventana de imagen.
Ventana de imagen
Nombre de la ventana de imagen en la que se muestra la nueva imagen.
Nuevo nombre de imagen

Nombre de la nueva imagen que se muestra en la ventana de imagen.
Ejemplo
El siguiente código del programa activa la imagen "Screen_2" con la función
ActivateScreenInScreenWindow al pulsar cualquier tecla.
{
// i.e. when pressing a button
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
2.1.5 ActivateStartScreen (RT Professional)
Descripción
Abre la imagen inicial configurada.
Sintaxis
BOOL ActivateStartScreen();

Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa activa la imagen inicial configurada con la función
ActivateStartScreen y guarda el valor de retorno en la variable b_error.
{
BOOL b_error;
//Open start screen

b_error = ActivateStartScreen();
if(b_error)
{
...
}
else
{
...
}
...
}
2.1.6 ActivateStoredScreen (RT Professional)
Descripción
Abre la imagen que se ha guardado con la función de sistema StoreScreen.
Sintaxis
BOOL ActivateStoredScreen();

Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa activa la imagen guardada con la función
ActivateStoredScreen y guarda el valor de retorno en la variable b_error.
{
BOOL b_error;
//Open stored screen

b_error = ActivateStoredScreen();
if(b_error)
{
...
}
else
{
...
}
...
}
Consulte también
StoreScreen (Página 1502)
2.1.7 DateToSystemTime (RT Professional)
Descripción
Convierte una indicación de fecha y hora dada en el formato DATE al formato de datos
SYSTEMTIME.


FechaAHoraDelSistema (valor, puntero hacia fecha/hora)
Sintaxis
DateToSystemTime(Value, PointerToTime);
Parámetros
Value
Valor en el formato de datos DATE
PointerToTime
Puntero hacia el resultado en el formato SYSTEMTIME
Valor de retorno
TRUE
FALSE

Ejemplo
BOOL BRet;
SYSTEMTIME st_1, st_2;
DATE d_1, d_2; // wtypes.h. DATE type. Visual Studio documnetation.
GetSystemTime( &st_1 );
printf( "st_1.wYear = %d \r\n", st_1.wYear );

printf( "st_1.wMonth = %d \r\n", st_1.wMonth );
printf( "st_1.wDayOfWeek = %d \r\n", st_1.wDayOfWeek );
printf( "st_1.wDay = %d \r\n", st_1.wDay );printf( "st_1.wHour = %d \r\n", st_1.wHour );
printf( "st_1.wMinute = %d \r\n", st_1.wMinute );
printf( "st_1.wSecond = %d \r\n", st_1.wSecond );
printf( "st_1.wMilliseconds = %d \r\n", st_1.wMilliseconds );
BRet = SystemTimeToDate( st_1, &d_1 );

printf( "DATE d = %ld \r\n \r\n", d_1 );
printf( "DATE d = %lf \r\n \r\n", d_1 );
printf( "DATE d = %f \r\n \r\n", d_1 );
BRet = DateToSystemTime( d_1, &st_2 );

printf( "st_2.wDay = %d \r\n", st_2.wDay );
printf( "st_2.wHour = %d \r\n", st_2.wHour );
printf( "st_2.wMilliseconds = %d \r\n \r\n \r\n", st_2.wMilliseconds );
2.1.8 DecreaseTag (RT Professional)
Descripción
X=X-a
Nota




Parámetros
Variable
Valor
Ejemplo
El siguiente código de programa reduce el valor de la variable varX la cantidad que indica la
variable value. El valor introducido se guarda en la variable old_value y se muestra junto con
el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
//Decrease tag
DecreaseTag(varX, value);

printf ("User input: %i\r\n, Result of function DecreaseTag: %i\r\n", old_value, varX);
...
}
2.1.9 GetLocalScreen (RT Professional)
Descripción
Proporciona un puntero hacia el nombre de la imagen.

Sintaxis
char* GetLocalScreen(ScreenName);
Parámetros
ScreenName
Puntero hacia el nombre de la imagen.
Valor de retorno
Nota
El parámetro de llamada transferido "ScreenName" debe tener la misma estructura que le
asigna el sistema gráfico para las rutas de imagen:
Principio
En una imagen "Imagen_A" hay una ventana de imagen "Ventana de imagen_B". En la
ventana de imagen se vuelve a activar una imagen y se representa como imagen reducida,
etc.
Activación de las imágenes desde las ventanas de imagen

1. En la "Ventana de imagen_B" se representa la "Imagen_C".
En la "Imagen_C" hay una ventana de imagen "Ventana de imagen_D".
2. En la "Ventana de imagen_D" se representa la "Imagen_E".
Puntero hacia el nombre de la imagen

Ofrece en el siguiente paso la función de sistema GetLocalScreen(ScreenName) con los
siguientes valores:
● "Imagen_E" cuando se llama la función de sistema en la "Imagen_E".
● "Imagen_C" cuando se llama la función de sistema en la "Imagen_C".
● "Imagen_A" cuando se llama la función de sistema en la "Imagen_A".

Ejemplo
El siguiente código de programa guarda el valor de retorno de la función GetLocalScreen en
la variable pszScrName. Si el valor de retorno es válido (diferente de CERO), se guardará con
un máximo de _MAX_PATH caracteres en la variable szScrName.
{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];
//Get the Local Screen

pszScrName = GetLocalScreen(lpszScreenName);
//Copy the string

if (pszScrName != NULL)
{
strncpy(szScrName,pszScrName,_MAX_PATH);
// print local screen name
printf ("Local screen name: %s\r\n", szScrName);
}
...
}
2.1.10 GetLinkedTag (RT Professional)
Descripción
Devuelve el nombre de la variable que está enlazada con la propiedad de objeto indicada.
Sintaxis
char* GetLinkedTag(ScreenName, Object, NameOfProperty);
Parámetros
ScreenName
Object
Puntero hacia el nombre del objeto.
NameOfProperty
Puntero hacia el nombre de la propiedad del objeto.

Valor de retorno
Puntero hacia el nombre de la variable que está enlazada con una propiedad de objeto
indicada.
Nota
Valor de retorno para los tipos de datos de usuario en el faceplate
Si un tipo de datos de usuario está interconectado directamente en el faceplate, no se devuelve
ningún nombre de variable. Solamente se devuelve un nombre de variable cuando los
elementos de la estructura del tipo de datos de usuario están interconectados individualmente
en el faceplate.
Ejemplo
El siguiente código de programa guarda el valor de retorno de la función "GetLinkedTag" en
la variable "pszVarName". Si el valor de retorno es válido, se guardará en la variable
"szVAarName" con la longitud de ruta máxima admisible. El valor de retorno guardado puede
procesarse más adelante en el código.
char CFunktion()
{
char* pszVarName = NULL;
char szVarName[_MAX_PATH+1]; //Get the TagName
pszVarName = GetLinkedVariable("gs_stand_graph_00","Textfield6","Visible"); //Copy the
string
if (strcmp (pszVarName,"")!= 0)
{
strncpy(szVarName,pszVarName,_MAX_PATH);
}
else printf("The property 'visible' is not dynamized\r\n");
//User defined code where the
//user can do something with the returnvalue
...
}
2.1.11 GetLanguageByLocaleID (RT Professional)
Descripción
Determina el idioma actual de runtime.
Sintaxis
DWORD GetLanguageByLocaleID ();

Valor de retorno
Código de idioma.
Rigen las asignaciones siguientes (código de idioma hexadecimal):
Denominación simbólica Valor(hexadecimal) Abreviatura

LANG_ARABIC 0x0401
LANG_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BYELORUSSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0804
LANG_CROATIAN 0x041A
LANG_CZECH 0x0405 CSY
LANG_DANISH 0x0406 DAN
LANG_DUTCH 0x0413 NLD
LANG_ENGLISH 0x0409 ENU
LANG_ESTONIAN 0x0425
LANG_FAEROESE 0x0438
LANG_FARSI 0x0429
LANG_FINNISH 0x040B FIN
LANG_FRENCH 0x040C FRA
LANG_GERMAN 0x0407 DEU
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E HUN
LANG_ICELANDIC 0x040F ISL
LANG_INDONESIAN 0x0421
LANG_ITALIAN 0x0410 ITA
LANG_JAPANESE 0x0411
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_LITHUANIAN 0x0427
LANG_NORWEGIAN 0x0414 NOR
LANG_POLISH 0x0415 PLK
LANG_PORTUGUESE 0x0416 PTB
LANG_ROMANIAN 0x0418
LANG_RUSSIAN 0x0419 RUS
LANG_SLOVAK 0x041B SKY
LANG_SLOVENIAN 0x0424
LANG_SORBIAN 0x042E
LANG_SPANISH 0x040A ESP


LANG_SWEDISH 0x041D SVE
LANG_THAI 0x041E
LANG_TURKISH 0x041F TRK
LANG_UKRAINIAN 0x0422
Ejemplo
El siguiente código de programa lee el idioma de runtime actual y guarda el valor de retorno
en la variable rt_language.
El valor de retorno guardado puede procesarse en el código subsiguiente (aquí, impresión
con printf).
{
DWORD rt_language;
//Get the current language

rt_language = GetLanguageByLocaleID ();
//print language code

printf ("Language code: %d\r\n", rt_language);
...
}
2.1.12 GetParentScreen (RT Professional)
Descripción
La función determina el nombre de la imagen superior a partir de una ruta dada.
Sintaxis
char* GetParentScreen(ScreenName);
Parámetros
ScreenName
Puntero hacia el nombre de la imagen. El parámetro de llamada transferido Screen name
debe tener la misma estructura que le da el sistema gráfico a las rutas de imagen:


Nota
El signo "." se utiliza para diferenciar el nombre de la imagen del del objeto de imagen. El
signo ":" se utiliza para la estructura jerárquica. Por tanto, para los nombres se deben utilizar
Valor de retorno
Nombre de la imagen superior
Principio

Ejemplo
El siguiente código de programa guarda el valor de retorno de la función GetParentScreen en
la variable pszScrName. Si el valor de retorno es válido (diferente de CERO), se guardará con
un máximo de _MAX_PATH caracteres en la variable szScrName.
{
//Get the Parent Screen

pszScrName = GetParentScreen(lpszScreenName);
//Copy the string

{
// print Screen name
printf ("Screen name: %s\r\n", szScrName);
}
...
}
2.1.13 GetParentScreenWindow (RT Professional)
Descripción
La función determina el nombre de la ventana de imagen superior a partir de una ruta dada.
Sintaxis
char* GetParentScreenWindow(ScreenName);
Parámetros
ScreenName
Puntero hacia el nombre de la imagen. El parámetro de llamada transferido Screen name
debe tener la misma estructura que le da el sistema gráfico a las rutas de imagen:
<nombre de imagen>.<nombre de la ventana de imagen>:<nombre de imagen>.<nombre de
la ventana de imagen>:<nombre de imagen>...El signo "." sirve para diferenciar el nombre de

la imagen del del objeto de imagen. El signo ":" se utiliza para la estructura jerárquica. Por
tanto, para los nombres se deben utilizar exclusivamente los separadores "-" y "_".
Nota
El signo "." se utiliza para diferenciar el nombre de la imagen del del objeto de imagen. El
signo ":" se utiliza para la estructura jerárquica. Por tanto, para los nombres se deben utilizar
Valor de retorno
Nombre de la ventana de imagen superior
Principio

Ejemplo
El siguiente código de programa guarda el valor de retorno de la función
GetParentScreenWindow en la variable pszScrName. Si el valor de retorno es válido (diferente
de CERO), se guardará con un máximo de _MAX_PATH caracteres en la variable szScrName.
{
//Get the Parent Screen Window

pszScrName = GetParentScreenWindow(lpszScreenName);
//Copy the string

{
// print name of the parent screen window
printf ("Parent screen window: %s\r\n", szScrName);
}
...
}
2.1.14 GetProp (RT Professional)
2.1.14.1 GetPropBOOL (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "BOOL".
Sintaxis
BOOL GetPropBOOL(ScreenName, Object, NameOfTheProperty)
Parámetros
ScreenName
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.

NameOfTheProperty
Nombre de la propiedad del objeto.
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa lee si el objeto es visible o no. El valor se guarda en la variable
b_error.
{
BOOL b_error;
//Get the property Visible

b_error = GetPropBOOL("gs_graph_iofield","IOField1","Visible");
if(b_error)
{
// User defined code if the
// object is visible
...
}
else
{
// object is not visible
...
}
}
En función del valor de retorno se procesa un código específico.
2.1.14.2 GetPropChar (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "Char".
Sintaxis
Char* GetPropChar(ScreenName, Object, NameOfTheProperty)

Parámetros
ScreenName
Object
NameOfTheProperty
Valor de retorno
Valor de la propiedad en el tipo de datos "Char".
Ejemplo
El siguiente código de programa lee el Tooltiptext del objeto con la función GetPropChar y lo
procesa del siguiente modo:
1. Guarda el valor de retorno en la variable pszProp
2. Comprobación de la validez del valor de retorno: Si el valor es válido (diferente de CERO),
sigue el paso 3.
3. Los primeros 13 caracteres de la secuencia de caracteres se guardan en la variable szProp.
{
char* pszProp = NULL;
char szProp[14];
//Get the property Tooltiptext

pszProp = GetPropChar("lpszScreenName","IOField1","Tooltiptext");
if(pszProp != NULL)
{
//Copy the string and trim
strncpy(szProp,pszProp,13);
// print trimmed string
printf ("Short description of tooltip: %s\r\n", szProp);
}
...
}

2.1.14.3 GetPropDouble (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "Double".
Sintaxis
double GetPropDouble(ScreenName, Object, NameOfTheProperty)
Parámetros
ScreenName
Object
NameOfTheProperty
Valor de retorno
Valor de la propiedad en el tipo de datos "Double".
Ejemplo
El siguiente código de programa lee la propiedad "BackColor" (color de fondo del objeto
"Button_1") con la función GetPropDouble y procesa el valor de retorno del siguiente modo:
1. Guarda el valor de retorno en la variable szprop
sigue el paso 3.
3. Impresión del color de fondo

{
double szProp = NULL;
//Get the property of the IO Field 1

szprop = GetPropDouble("Screen_1","Button_1","BackColor");
if(szProp != NULL)
{
// print output value
printf ("Background color: %s\r\n", szProp);}
}
...
}
2.1.14.4 GetPropLong (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "long".
Sintaxis
long GetPropLong(ScreenName, Object, NameOfTheProperty)
Parámetros
ScreenName
Object
NameOfTheProperty
Valor de retorno
Valor de la propiedad en el tipo de datos "long".

Ejemplo
El siguiente código de programa lee la propiedad "CaptionBackColor" (color de fondo del título)
del objeto "TemperatureField" con la función GetPropLong y procesa el valor del siguiente
modo:
1. Guarda el valor de retorno en la variable szProp
sigue el paso 3.
3. Impresión
{
long szProp = NULL;
//Get the property Tooltiptext

szProp = GetPropLong("Screen_1","TemperatureField","CaptionBackColor");
if(szProp != NULL)
{
// print caption
printf ("Caption of window: %d\r\n", szProp);
}
...
}
2.1.15 GetServerTagPrefix (RT Professional)
Descripción
Para poder acceder a variables del servidor correspondiente desde un cliente WinCC en un
sistema distribuido, los nombres de variables se complementan con el prefijo del servidor.
Nota
Esta función de sistema no se soporta actualmente.
Sólo se devuelve un puntero del tipo "char" en el prefijo del servidor, el prefijo Tag y el prefijo
Window.
La memoria no puede ser modificada (tampoco un strcat) ni liberada por el usuario.
Sintaxis
void GetServerTagPrefix(ppszServerPrefix, ppszTagPrefix, ppszWindowPrefix);

Valor de retorno
ppszServerPrefix
Puntero hacia un puntero que hace referencia al prefijo del servidor
ppszTagPrefix
Puntero hacia un puntero que hace referencia al prefijo Tag
ppszWindowPrefix
Puntero hacia un puntero que hace referencia al prefijo Window
Ejemplo
El siguiente código de programa lee el prefijo de servidor, el prefijo Tag y el prefijo Windows
y comprueba su validez. En caso de error se emite un texto y se abandona la función. Si no
hay error, se crea y se devuelve un nombre de variable. El procesamiento es como sigue:
1. Declaración de los punteros pszServerPrefix, pszTagPrefix y pszWindowPrefix para los
tres prefijos
2. Inicialización de las variables nServerPrefixLen, nTagPrefixLen y nTagLen
Se utilizan como caché para la longitud de string de los prefijos que deben leerse.
3. Inicialización de la variable myTagName
4. Leer prefijo de servidor, prefijo de variable y prefijo de Windows
5. Diferenciación de casos: Prefijo de servidor
– No se devuelve prefijo de servidor: se emite un texto y se abandona la función.
– Se devuelve prefijo de servidor: se determina su longitud y se guarda en la variable
nServerPrefixLen.
6. Si se ha devuelto un prefijo de variable, se determina su longitud y se guarda en la variable
nTagPrefixLen.
7. Determinar la longitud del nombre de la variable y guardar en la variable nTagLen.
8. Diferenciación de casos: Longitud permitida para el nombre de la variable
– Longitud permitida sobrepasada: se emite un texto y se abandona la función.
– Longitud permitida no sobrepasada: se compone el nombre de la variable que se
necesita para un entorno de cliente.

{
char* pszServerPrefix;
char* pszTagPrefix;
char* pszWindowPrefix;
int nServerPrefixLen = 0;
int nTagPrefixLen = 0;
int nTagLen = 0;
char myTagName[MAX_DM_VAR_NAME+1];
//Initialize the return value

memset(myTagName,0,MAX_DM_VAR_NAME + 1);
//Get the serverprefix the tagprefix and the windowprefix

GetServerTagPrefix(&pszServerPrefix, &pszTagPrefix, &pszWindowPrefix);
//If a serverprefix exists

if (pszServerPrefix)
{
//Get the length of the string
nServerPrefixLen = strlen(pszServerPrefix);
}
Else
{
printf("No server prefix was returned.");
return;
}
//If a tagprefix exists

if (pszTagPrefix)
{
//Get the length of the string
nTagPrefixLen = strlen(pszTagPrefix);
}
//Get the length of the tag

nTagLen = strlen("TagName");
//Check if the lenght of the

//ServerPrefix+TagPrefix+VarName + the double points < MAX_DM_VAR_NAME)
if (nServerPrefixLen + nTagPrefixLen + nTagLen+2 < MAX_DM_VAR_NAME)
{
sprintf(myTagName,"%s::%s%s",pszServerPrefix,pszTagPrefix,"TagName");
...
}
Else
{
printf("The resulting string is too long.");
return;
}
}

2.1.16 GetTag (RT Professional)
2.1.16.1 Funciones GetTag (RT Professional)
Descripción
La función GetTagXXX determina el valor de una variable del tipo de datos especificado.
Utilizable sólo en C-Scripting:
La siguiente tabla muestra las diferentes funciones GetTag para leer el valor de la variable:
Tipo Nombre de función Parámetro Tipo de datos PLC Tipo de da‐

tos HMI
BOOL GetTagBit Tag Tag_Name Variable binaria Bool
BYTE GetTagByte Tag Tag_Name 8 bits sin signo USInt
char* GetTagChar Tag Tag_Name Variable de texto de 8 bits String o
o WString
de 16 bits
SYSTEMTI‐ GetTagDateTime Tag Tag_Name DTL DateTime

ME
double GetTagDouble Tag Tag_Name Número en coma flotante LReal
de 64 bits
DWORD GetTagDWord Tag Tag_Name 32 bits sin signo UDInt
float GetTagFloat Tag Tag_Name Número en coma flotante Real
de 32 bits
BOOL GetTagRaw Tag Tag_Name, Tipo de datos sin formato Raw
BYTE* pValue,
DWORD size
signed char GetTagSByte Tag Tag_Name 8 bits con signo SInt
long int GetTagSDWord Tag Tag_Name 32 bits con signo DInt
short int GetTagSWord Tag Tag_Name 16 bits con signo Int
WORD GetTagWord Tag Tag_Name 16 bits sin signo UInt
Sintaxis
<Tipo><Nombre de función><(Parámetro)>;
Ejemplo: BYTE GetTagByte(Tag_Name);
Parámetros
Tag_Name

pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagChar" devuelve un puntero hacia la cadena de caracteres que
contiene el valor de la variable.
La función de sistema "GetTagRaw" devuelve TRUE o FALSE:
TRUE: La función de sistema se ha ejecutado sin errores.
FALSE: Se ha producido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagByte el valor de las variables
gs_tag_byte y lo guarda en la variable bvalue.
{
BYTE bvalue;
//Get the current value of the tag

bvalue = GetTagByte("gs_tag_byte");
// print value
printf ("Value of gs_tag_byte: %d\r\n", bvalue);
...
}
2.1.16.2 Función GetTagDateTime (RT Professional)
Función
Determina el valor de una variable del tipo de datos "Fecha/hora".
Sintaxis
SYSTEMTIME GetTagDateTime(Tag_Name);

Parámetro
Tag_Name
Valor de retorno
Valor de la variable en el tipo de datos "Fecha/hora".
2.1.16.3 Funciones GetTagMultiStateQCWait (RT Professional)
Descripción
Se determinan los valores, estados y Quality Codes de varias variables y se guardan en el
formato indicado en las correspondientes direcciones. Los valores se leen explícitamente del
PLC.
Se transfieren dos matrices DWORD en cuyo miembro se encuentren los estados y los Quality
Codes de las variables individuales después de llamar la función de sistema. El tamaño de
las matrices debe ser lo suficientemente grande como para que haya suficiente espacio de
memoria para los estados y los Quality Codes.
Sintaxis
BOOL GetTagMultiStateQCWait(pdwState, pdwQualityCode, pFormat);
Parámetros
pdwState
Campo en el que se guarda el estado de las variables individuales después de ejecutar la
función de sistema.
pdwQualityCode
Campo en el que se guarda el Quality Code de las variables individuales después de ejecutar
la función de sistema.
pFormat
Descripción de formato (tipo) para todas las variables solicitadas, posteriormente para cada
variable, nombre y dirección del valor.
Valor de retorno
TRUE

FALSE
Ejemplo
El siguiente código de programa lee con la función GetTagMultiStateQCWait el valor de las
variables "gs_tag_XXX" y guarda estos valores en las variables Ivalue1, Ivalue2 ... etc.
1. Definición de preprocesador para "DATA_SIZE" (aquí para 5 variables)
2. Crear los campos DWord
– dwState campo para el estado de la variable
– dwQc campo para Quality Codes
3. Definición de las variables para guardar en caché
4. Ejecución de la función GetTagMultiStateQCWait
En las direcciones de las variables se escribe el valor leído.
{
#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);

...
}
Consulte también
Quality Codes de variables HMI (Página 1568)
Constantes (Página 1573)

2.1.16.4 Funciones GetTagMultiStateWait (RT Professional)
Descripción
Se determinan los valores y estados de varias variables y se guardan en el formato indicado
en las correspondientes direcciones. Los valores se leen explícitamente del PLC.
Debe transferirse a la función de sistema una matriz DWORD en cuyo miembro se encuentren
los estados de las variables individuales después de llamar la función de sistema. El tamaño
de la matriz debe ser lo suficientemente grande como para que haya suficiente espacio de
memoria para los estados.
Sintaxis
BOOL GetTagMultiStateWait(pdwState, pFormat);
Parámetros
pdwState
Campo en el que se guardan los estados de variables
pFormat
Descripción de formato (tipo) para todas las variables solicitadas, y para cada variable, nombre
y dirección del valor.
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa lee con la función GetTagMultiStateWait el valor de la variable
"gs_tag_XXX" y guarda estos valores en las variables Ivalue1, Ivalue2, etc.
1. Definición de preprocesador para "DATA_SIZE" (aquí para 5 variables)
2. Crear el campo DWord dwState para el estado de la variable
3. Definición de las variables para guardar en caché
4. Ejecución de la función GetTagMultiStateWait
En las direcciones de las variables se escribe el valor leído.

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

...
}
Consulte también
2.1.16.5 Funciones GetTagMultiWait (RT Professional)
Descripción
Se determinan los valores de varias variables y se guardan en las correspondientes
direcciones con el formato indicado. El valor se lee explícitamente del PLC. La memoria para
el valor de variable se crea por medio de la función de sistema con SysMalloc.
Sintaxis
BOOL GetTagMultiWait(pFormat,...);

Parámetros
pFormat
Descripción de formato para todas las variables solicitadas y nombre y dirección del valor para
cada variable.
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa lee diversas variables de tipos distintos con la función
GetTagMultiWait.
1. Declaración de tres variables como memoria para tres tipos de variable distintos
2. Declaración de las variables booleanas ok para guardar en caché el valor de retorno (TRUE/
FALSE)
3. Lectura de las tres variables y almacenamiento de los valores en las direcciones
correspondientes.
El valor de retorno de la función se guarda en la variable ok.
4. Impresión de las tres variables con el tipo de variable antepuesto
DWORD dwVar1Value;
char* szVar2Value;
//memory for values allocated via SysMalloc
double dbVar3Value;
BOOL ok;
ok=GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,

"Ernie_char", &szVar2Value,
"Ernie_double", &dbVar3Value);
printf("Word %d, String %s, Double %f\r\n",

dwVar1Value, szVar2Value, dbVar3Value);

2.1.16.6 Funciones GetTagState (RT Professional)
Descripción
La función GetTagStateXXX determina el valor de una variable del tipo de datos especificado.
Además se devuelve el estado de las variables.
La tabla siguiente muestra las diferentes funciones GetTagStateXXX para leer el valor de la
variable:
Tipo Nombre de función Parámetro Tipo de datos PLC Tipo de

datos HMI
BOOL GetTagBitState Tag Tag_Name, Variable binaria Bool
PDWORD lp_dwstate
BYTE GetTagByteState Tag Tag_Name, 8 bits sin signo Byte
PDWORD lp_dwstate
char* GetTagCharState Tag Tag_Name, Variable de texto de 8 bits String
PDWORD lp_dwstate o de 16 bits
double GetTagDoubleSta‐ Tag Tag_Name, Número en coma flotante Double
te PDWORD lp_dwstate de 64 bits
DWORD GetTagDWordSta‐ Tag Tag_Name, 32 bits sin signo UInteger
te PDWORD lp_dwstate
float GetTagFloatState Tag Tag_Name, Número en coma flotante Float
PDWORD lp_dwstate de 32 bits
BOOL GetTagRawState Tag Tag_Name, BYTE* Tipo de datos sin formato Raw
pValue, DWORD size,
PDWORD lp_dwstate
signed GetTagSByteState Tag Tag_Name, 8 bits con signo Byte
char PDWORD lp_dwstate
long int GetTagSDWordSta‐ Tag Tag_Name, 32 bits con signo Integer
short int GetTagSWordSta‐ Tag Tag_Name, 16 bits con signo Short
WORD GetTagWordState Tag Tag_Name, 16 bits sin signo UShort
PDWORD lp_dwstate
Sintaxis
<Tipo><Nombre de la función><(Parámetro)>;
Ejemplo: BOOL GetTagBitState(Tag_Name, lp_dwstate);
Parámetros
Tag_Name

lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
pValue
size
Valor de retorno
La función de sistema "GetTagCharState" devuelve un puntero hacia el valor de la variable
del tipo de datos "char".
La función de sistema "GetTagRawState" devuelve TRUE o FALSE:
Ejemplo
El siguiente código de programa lee con la función GetTagBitState el valor de la variable
gs_tag_bit y lo guarda en la variable bValue.
El estado se guarda en la dirección de la variable dwState .

En función del valor de retorno en bValue (TRUE/FALSE) se ejecuta un código específico.
{
DWORD dwState;
BOOL bValue;
dwState = 0xFFFFFFFF;
//Get the tag value

//dwstate is the tag state
bValue = GetTagBitState("gs_tag_bit",&dwState);
//Create a string which includes the tag value

if (bValue)
{
// value of the tag is true
...
}
else
{
// value of the tag is false
...
}
}
Consulte también
2.1.16.7 Funciones GetTagStateQC (RT Professional)
Descripción
La función GetTagStateQC determina el valor de una variable del tipo de datos especificado.
Se devuelve también el estado y el Quality Code de las variables.

La tabla siguiente muestra las diferentes funciones GetTagStateQC para leer el valor de la
variable:
Tipo Nombre de función Parámetro Tipo de datos PLC Tipo de datos

HMI
BOOL GetTagBitStateQC Tag Tag_Name, Variable binaria Bool
PDWORD lp_dwstate,
PDWORD pdwQuality‐
Code
BYTE GetTagByteStateQC Tag Tag_Name, 8 bits sin signo UByte
PDWORD lp_dwstate,
Code
char* GetTagCharSta‐ Tag Tag_Name, Variable de texto de 8 bits String
teQC PDWORD lp_dwstate, o de 16 bits
Code
double GetTagDoubleSta‐ Tag Tag_Name, Número en coma flotante Double
teQC PDWORD lp_dwstate, de 64 bits
Code
DWOR GetTagDWordSta‐ Tag Tag_Name, 32 bits sin signo UInteger
D teQC PDWORD lp_dwstate,
Code
float GetTagFloatSta‐ Tag Tag_Name, Número en coma flotante Float
teQC PDWORD lp_dwstate, de 32 bits
Code
BOOL GetTagRawStateQC Tag Tag_Name, BYTE Tipo de datos sin formato Raw
pValue[], DWORD size,
PDWORD lp_dwstate,
Code
signed GetTagSByteSta‐ Tag Tag_Name, 8 bits con signo Byte
char teQC PDWORD lp_dwstate,
Code
teQC PDWORD lp_dwstate,
Code
short GetTagSWordSta‐ Tag Tag_Name, 16 bits con signo Short
int teQC PDWORD lp_dwstate,
Code
WORD GetTagWordSta‐ Tag Tag_Name, 16 bits sin signo UShort
teQC PDWORD lp_dwstate,
Code

Sintaxis
<Tipo><Nombre de la función><(Parámetro)>;
Ejemplo: BOOL GetTagBitStateQC(Tag_Name, lp_dwstate, pdwQualityCode);
Parámetros
Tag_Name
lp_dwstate
pdwQualityCode
Puntero hacia un DWORD en el que se guarda el Quality Code de la variable después de
ejecutar la función de sistema.
pValue
size
Valor de retorno
La función de sistema "GetTagCharStateQC" devuelve un puntero hacia el valor de la variable
del tipo de datos "char".
La función de sistema "GetTagRawStateQC" devuelve TRUE o FALSE:
Ejemplo
El siguiente código de programa lee con la función GetTagBitStateQC el valor de la variable
gs_tag_bit y lo guarda en la variable ok.
El estado y el Quality Code se guardan en las direcciones dwState y dwQC de la variable.

En función del valor de retorno en la variable ok. (TRUE/FALSE) se ejecuta un código

específico.
{
DWORD dwState;
DWORD dwQC;
BOOL ok;
//Get the tag value

ok = GetTagBitStateQC("gs_tag_bit",&dwState,&dwQC);

if (ok)
{
// succeeded, print tag value
printf ("Value at dwState: %x\r\n", dwState);
printf ("Value at dwQC: %x\r\n", dwQC);
...
}
else
{
// failed
}
}
Consulte también
2.1.16.8 Funciones GetTagStateQCWait (RT Professional)
Descripción
La función GetTagStateQCWait determina el valor de una variable del tipo de datos
especificado. El valor se lee explícitamente del PLC. Se devuelve también el estado y el Quality
Code de las variables.

La tabla siguiente muestra las diferentes funciones GetTagStateQCWait para leer el valor de
la variable:

datos
HMI
BOOL GetTagBitStateQCWait Tag Tag_Name, Variable binaria Bool
PDWORD lp_dwstate,
Code
BYTE GetTagByteStateQC‐ Tag Tag_Name, 8 bits sin signo UByte
Wait PDWORD lp_dwstate,
Code
char* GetTagCharStateQC‐ Tag Tag_Name, Variable de texto de 8 bits String
Wait PDWORD lp_dwstate, o de 16 bits
Code
double GetTagDoubleStateQC‐ Tag Tag_Name, Número en coma flotante Double
Wait PDWORD lp_dwstate, de 64 bits
Code
DWOR GetTagDWordStateQC‐ Tag Tag_Name, 32 bits sin signo UInteger
D Wait PDWORD lp_dwstate,
Code
float GetTagFloatStateQC‐ Tag Tag_Name, Número en coma flotante Float
Wait PDWORD lp_dwstate, de 32 bits
Code
BOOL GetTagRawStateQC‐ Tag Tag_Name, BYTE Tipo de datos sin formato Raw
Wait pValue[], DWORD size,
PDWORD lp_dwstate,
Code
signed GetTagSByteStateQC‐ Tag Tag_Name, 8 bits con signo Byte
char Wait PDWORD lp_dwstate,
Code
teQCWait PDWORD lp_dwstate,
Code
short GetTagSWordStateQC‐ Tag Tag_Name, 16 bits con signo Short
int Wait PDWORD lp_dwstate,
Code
WORD GetTagWordStateQC‐ Tag Tag_Name, 16 bits sin signo UShort
Wait PDWORD lp_dwstate,
Code

Sintaxis
Ejemplo: BOOL GetTagBitStateQC(Tag_Name, lp_dwstate, pdwQualityCode);
Parámetros
Tag_Name
lp_dwstate
pdwQualityCode
Puntero hacia un DWORD en el que se guarda el Quality Code de la variable después de
ejecutar la función de sistema.
pValue
size
Valor de retorno
La función de sistema "GetTagCharStateQCWait" devuelve un puntero hacia el valor de la
variable del tipo de datos "char".
La función de sistema "GetTagRawStateQCWait" devuelve TRUE o FALSE:
Ejemplo
El siguiente código de programa lee con la función GetTagBitStateQCWait el valor de la
variable gs_tag_bit y lo guarda en la variable bValue.
El estado y el Quality Code se guardan en las direcciones de dwState y dwQC .

{
DWORD dwState;
DWORD dwQC;
BOOL bValue;
//Get the tag value

bValue = GetTagBitStateQCWait("gs_tag_bit",&dwState,&dwQC);

if (bValue)
{
...
}
else
{
...
}
}
Consulte también
2.1.16.9 Funciones GetTagStateWait (RT Professional)
Descripción
La función GetTagStateWait determina el valor de una variable del tipo de datos especificado.
El valor se lee explícitamente del PLC. Además se devuelve el estado de las variables.
La tabla siguiente muestra las diferentes funciones GetTagStateWait para leer el valor de la
variable:

datos HMI
BOOL GetTagBitStateWait Tag Tag_Name, PDWORD Variable binaria Bool
lp_dwstate
BYTE GetTagByteState‐ Tag Tag_Name, PDWORD 8 bits sin signo UByte
Wait lp_dwstate


datos HMI
char* GetTagCharState‐ Tag Tag_Name, PDWORD Variable de texto String
Wait lp_dwstate de 8 bits o de 16
bits
double GetTagDoubleState‐ Tag Tag_Name, PDWORD Número en coma Double
Wait lp_dwstate flotante de 64 bits
DWORD GetTagDWordState‐ Tag Tag_Name, PDWORD 32 bits sin signo UInteger
Wait lp_dwstate
float GetTagFloatState‐ Tag Tag_Name, PDWORD Número en coma Float
Wait lp_dwstate flotante de 32 bits
BOOL GetTagRawState‐ Tag Tag_Name, BYTE* Tipo de datos sin Raw
Wait pValue, DWORD size, formato
PDWORD lp_dwstate
signed char GetTagSByteState‐ Tag Tag_Name, PDWORD 8 bits con signo Byte
Wait lp_dwstate
long int GetTagSDWordState‐ Tag Tag_Name, PDWORD 32 bits con signo Integer
Wait lp_dwstate
short int GetTagSWordState‐ Tag Tag_Name, PDWORD 16 bits con signo Short
Wait lp_dwstate
WORD GetTagWordState‐ Tag Tag_Name, PDWORD 16 bits sin signo UShort
Wait lp_dwstate
Sintaxis
<Tipo><Nombre de la función><(Parámetro)>
Ejemplo: BOOL GetTagBitStateWait(Tag_Name, lp_dwstate)
Parámetros
Tag_Name
lp_dwstate
pValue
size
Valor de retorno

La función de sistema "GetTagCharStateWait" devuelve un puntero hacia el valor de la

variable del tipo de datos "char".
La función de sistema "GetTagRawState" devuelve TRUE o FALSE.
Ejemplo
El siguiente código de programa lee con la función GetTagBitStateWait el valor de la variable
gs_tag_bit y lo guarda en la variable bValue.
El estado se guarda en la dirección de la variable dwState .
{
DWORD dwState;
BOOL bValue;
//Get the tag value

bValue = GetTagBitStateWait("gs_tag_bit",&dwState);

if (bValue)
{
...
}
else
{
...
}
}
Consulte también
2.1.16.10 Funciones GetTagValue (RT Professional)
Descripción
Permite la transferencia de un valor en forma de Variant. Determina el puntero hacia la
estructura de resultados que contiene el valor.

Sintaxis
BOOL GetTagValue(lpdmVarKey, lpdmresult, lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCT"
lpdmError
Puntero hacia la estructura que contiene la descripción del error
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa determina el valor de varKey con la función GetTagValue.

En función del valor de retorno en keyFound (TRUE/FALSE) se ejecuta un código específico.
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCT result;
CMN_ERROR error:
BOOL keyFound;
//Get the tag value

keyFound = GetTagValue(&varKey, &result, &error);
if (keyFound)
{
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
...
}
}
2.1.16.11 Funciones GetTagValueStateQC (RT Professional)
Descripción
estructura de resultados que contiene el valor. Se devuelve también el estado y el Quality
Code de las variables.
Sintaxis
BOOL GetTagValueStateQC(lpdmVarKey, lpdmresult, lpdmError);
Parámetros
lpdmVarKey
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCTEX"

lpdmError
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa determina el valor de varKey con la función
GetTagValueStateQC.
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// zu klären (DM_VAR_UPDATE_STRUCTEX enthält bereits QualityCode)
DWORD dwState;
DWORD dwQC;
BOOL keyFound;
//Get the tag value

keyFound = GetTagValueStateQC(&varKey, &result, &error,&dwState,&dwQC);
if (keyFound)
{
...
}
else
{
...
}
}

2.1.16.12 Funciones GetTagValueStateQCWait (RT Professional)
Descripción
estructura de resultados que contiene el valor. El valor se lee explícitamente del PLC. Se
devuelve también el estado y el Quality Code de las variables.
Sintaxis
BOOL GetTagValueStateQCWait(lpdmVarKey, lpdmresult, lpdmError);
Parámetros
lpdmVarKey
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCTEX"
lpdmError
Puntero hacia la estructura que contiene la descripción del error.
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa lee con la función GetTagValueStateQCWait

{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// zu klären (DM_VAR_UPDATE_STRUCTEX enthält bereits QualityCode)
DWORD dwState;
DWORD dwQC;
BOOL keyFound;
//Get the tag value

keyFound = GetTagValueStateQC(&varKey, &result, &error,&dwState,&dwQC);
if (keyFound)
{
...
}
else
{
...
}
}
2.1.16.13 Funciones GetTagValueWait (RT Professional)
Descripción
estructura de resultados que contiene el valor. El valor se lee directamente del PLC.
Sintaxis
BOOL GetTagValueWait(lpdmVarKey, lpdmresult, lpdmError);
Parámetros
lpdmVarKey
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCT"

lpdmError
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa determina el valor de varKey con la función GetTagValueWait.
{
DM_VARKEY varKey;
CMN_ERROR error:
BOOL keyFound;
//Get the tag value

keyFound = GetTagValueWait(&varKey, &result, &error);
if (keyFound)
{
// succeeded, key found
// print tag value
...
}
else
{
// failed
}
...
}
2.1.16.14 Funciones GetTagWait (RT Professional)
Descripción
La función GetTagWaitXXX determina el valor de una variable del tipo de datos especificado.
El valor se lee explícitamente del PLC.

La siguiente tabla muestra las diferentes funciones GetTagWait para leer el valor de la variable:
Tipo Nombre de función Parámetro Tipo de datos PLC Tipo de datos

HMI
BOOL GetTagBitWait Tag Tag_Name Variable binaria Bool
BYTE GetTagByteWait Tag Tag_Name 8 bits sin signo UByte
char* GetTagCharWait Tag Tag_Name Variable de texto de 8 bits String
o de 16 bits
double GetTagDoubleWait Tag Tag_Name Número en coma flotante Double
de 64 bits
DWORD GetTagDWordWait Tag Tag_Name 32 bits sin signo UInteger
float GetTagFloatWait Tag Tag_Name Número en coma flotante Float
de 32 bits
BOOL GetTagRawWait Tag Tag_Name, Tipo de datos sin formato Raw
BYTE* pValue,
DWORD size
char GetTagSByteWait Tag Tag_Name 8 bits con signo Byte
long int GetTagSDWord‐ Tag Tag_Name 32 bits con signo Integer
Wait
short int GetTagSWordWait Tag Tag_Name 16 bits con signo Short
WORD GetTagWordWait Tag Tag_Name 16 bits sin signo UShort
Sintaxis
Ejemplo: BYTE GetTagByteWait(Tag_Name);
Parámetros
Tag_Name
pValue
Valor de retorno
La función de sistema "GetTagCharWait" devuelve un puntero hacia la cadena de caracteres
que contiene el valor de la variable.
La función de sistema "GetTagRawWait" devuelve TRUE o FALSE:

Ejemplo
El siguiente código de programa lee con la función GetTagByteWait el valor de la variable
gs_tag_byte y lo guarda en la variable bvalue.
{
BYTE bvalue;
//Get the current value of the tag

bvalue = GetTagByteWait("gs_tag_byte");
// print value
printf ("Value of gs_tag_byte: %d\r\n", bvalue);
...
}
2.1.17 IncreaseTag (RT Professional)
Descripción
X=X+a
Nota




Parámetros
Variable
Valor
Valor que se suma.
Ejemplo
El siguiente código de programa aumenta el valor de la variable varX la cantidad que indica
la variable value. El valor introducido se guarda en la variable old_value y se muestra junto
con el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
//Increase tag
IncreaseTag(varX, value);

printf ("User input: %i\r\n, Result of function IncreaseTag: %i\r\n", old_value, varX);
...
}
2.1.18 InquireLanguage (RT Professional)
Descripción
Determina todos los idiomas configurados en la librería de textos para el tiempo de ejecución.
Con Pointer to a counter se indica dónde debe guardarse el número de códigos de idioma
determinados.
Sintaxis
DWORD* InquireLanguage(PointerToACounter);

Parámetros
PointerToACounter
Puntero hacia el número de códigos de idioma determinados.
Valor de retorno
Puntero hacia un campo que contiene los códigos de idioma determinados.
Rigen las asignaciones siguientes (código de idioma hexadecimal):

LANG_ARABIC 0x0401
LANG_BASQUE 0x042D
LANG_BYELORUSSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0404
LANG_CZECH 0x0405 CSY
LANG_DANISH 0x0406 DAN
LANG_DUTCH 0x0413 NLD
LANG_ENGLISH 0x0409 ENU
LANG_FARSI 0x0429
LANG_FINNISH 0x040B FIN
LANG_FRENCH 0x040C FRA
LANG_GERMAN 0x0407 DEU
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E HUN
LANG_ICELANDIC 0x040F ISL
LANG_ITALIAN 0x0410 ITA
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_NORWEGIAN 0x0414 NOR
LANG_POLISH 0x0415 PLK
LANG_PORTUGUESE 0x0416 PTB


LANG_RUSSIAN 0x0419 RUS
LANG_SLOVAK 0x041B SKY
LANG_SORBIAN 0x042E
LANG_SPANISH 0x040A ESP
LANG_SWEDISH 0x041D SVE
LANG_THAI 0x041E
LANG_TURKISH 0x041F TRK
Ejemplo
El siguiente código de programa determina con la función InquireLanguage los idiomas
configurados en el tiempo de ejecución y los procesa del siguiente modo:
1. Almacenamiento del código de idioma determinado en la variable language
2. Almacenamiento del número de idiomas en la variable count
3. Impresión formateada del número de idiomas y sus códigos
{
DWORD count;
DWORD* language;
int i;
//Count the installed languages

language = InquireLanguage(&count);
printf("##################### INQUIRE LANGUAGE ####################");

//Print out the count of languages
printf ( "\r\nCount Languages=%d\r\n", count );
//print out which languages are installed

for (i=1;i<=count; i++)
{
printf ("\r\n%d.language=%x", i,*language++);
}
}
2.1.19 InverseLinearScaling (RT Professional)
Descripción

"EscalaLineal".
Nota


Parámetros
X
Y
b
a

Ejemplo
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;


...
}
2.1.20 InvertBit (RT Professional)
Descripción


InvertBit Tag
Parámetros
Variable

Ejemplo
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

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

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

...
}
2.1.21 InvertBitInTag (RT Professional)
Descripción

Nota


Parámetros
Variable
Bit

Ejemplo
Dim myTag
Dim myOutputField

'Get current value

bValue=myTag.Value
'Save current value

bSaved=bValue

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

{
BYTE bStatusWord;

...
}
2.1.22 IsUserAuthorized (RT Professional)
Descripción
Comprueba si un operador posee la autorización indicada.

Sintaxis
BOOL IsUserAuthorized(AuthorizationNumber);
Parámetros
AuthorizationNumber
La autorización (numérica) que debe comprobarse.
Valor de retorno
TRUE
El operador posee la autorización indicada.
FALSE
El operador no posee la autorización indicada.
Ejemplo
El siguiente código de programa comprueba la autorización del usuario con la función
IsUserAuthorized y escribe el valor en la variable booleana 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." );
}
...
}
Se imprime el valor de retorno.

2.1.23 LinearScaling (RT Professional)
Descripción
Nota


Parámetros
Y
a
X
b
Valor que se suma.

Ejemplo
Yvar.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling

...
}
2.1.24 ReportJob (RT Professional)
Descripción
Según el valor del parámetro NameOfMethod se inicia un trabajo de impresión o bien la vista
preliminar de un trabajo de impresión.
Sintaxis
void ReportJob(PrintJobName, NameOfMethod)
Parámetros
PrintJobName
Puntero hacia el nombre del trabajo de impresión.
NameOfMethod
Determina si se inicia el trabajo de impresión o la vista preliminar de un trabajo de impresión:
● PRINTJOB: Se inicia el trabajo de impresión.
● PREVIEW: Se inicia la vista preliminar del trabajo de impresión.

Ejemplo
El siguiente código de programa ejecuta una vista preliminar o una impresión por cada
contenido de la variable printmethod. La variable printmethod se lee mediante un campo ES
asociado a la variable strPrintJobMethod.
{
char* pszPrintjobName;
char* printmethod;
//Get the print method

printf("Input PRINTJOB for printing or PREVIEW for a quick view");
printmethod = GetTagChar("strPrintJobMethod")
//Print job or show preview

ReportJob(&PrintjobName, printmethod);
//error handling
if(printmethod=="PRINTJOB")
{
// message for printing completed
printf("printing done");
...
}
else
{
// job is a preview or failed
...
}
}
2.1.25 ResetBit (RT Professional)
Descripción


ResetBit Tag

Parámetros
Variable
Ejemplo
Dim myTag
Dim myOutputField

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

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

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

...
}

2.1.26 ResetBitInTag (RT Professional)
Descripción
Nota


Parámetros
Variable
Bit

Ejemplo
Dim myTag
Dim myOutputField

'Save current value

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

{
BYTE bSaved;

ResetBitInTag ("bStatusWord", bitposition);

...
}
2.1.27 Set_Focus (RT Professional)
Función
Coloca el foco en torno al objeto indicado.

Sintaxis
BOOL Set_Focus(lpszPictureName, lpszObjectName)
Parámetros
lpszPictureName
Nombre de la imagen
lpszObjectName
Nombre del objeto.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
2.1.28 SetBit (RT Professional)
Descripción


SetBit Tag
Parámetros
Variable

Ejemplo
Dim myTag
Dim myOutputField

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

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

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

...
}
2.1.29 SetBitInTag (RT Professional)
Descripción

Nota


Parámetros
Variable
Bit
Nota

Ejemplo
Dim myTag
Dim myOutputField

'Save current value

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

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

strResult="Old Value: "& bSaved & "New Value: " & bValue
{
BYTE bSaved;

SetBitInTag ("bStatusWord", bitposition);

2.1.30 SetLanguageByLocaleID (RT Professional)
Descripción
Modifica la configuración de idioma en runtime.
Puede utilizarse sólo en C-Scripting.

Sintaxis
BOOL SetLanguageByLocaleID(dwLocaleID);
Parámetros
dwLocaleID
Código del idioma que debe ajustarse.
Valor de retorno
TRUE
FALSE

Ejemplo
El siguiente código de programa ajusta el idioma de runtime actual a alemán con la función
SetLanguage y guarda el valor de retorno en la variable ok.
{
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);
}
Consulte también
GetLanguageByLocaleID (Página 1399)
2.1.31 SetLanguageByName (RT Professional)
Descripción
Modifica la configuración de idioma en runtime con el nombre de país del idioma que se va a
ajustar.


AjustarLenguajePorNombre (idioma)
Sintaxis
Bool SetLanguageByName(lpszLanguage);
Parámetros
lpszLanguage
Puntero hacia la abreviatura de idioma según el formato "RFC 1766".
Valor de retorno
TRUE
FALSE
2.1.32 SetProp (RT Professional)
2.1.32.1 SetPropBOOL (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "BOOL".
Sintaxis
BOOL SetPropBOOL(ScreenName, Object, NameOfTheProperty, Value)
Parámetros
ScreenName
Object

NameOfTheProperty
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "BOOL".
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa ajusta la propiedad del objeto gs_graph_iofield a "Visible"
con la función SetPropBool. El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//Set the visibility TRUE

ok = SetPropBOOL("gs_graph_iofield","IOField1","Visible",TRUE);
//error handling
if(ok)
{
// succeeded
printf ( "IO field is visible." );
}
else
{
// failed
printf ( "Error - visibility not set" );
}
...
}
2.1.32.2 SetPropChar (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "char".
Utilizable solo en C-Scripting.

Sintaxis
BOOL SetPropChar(ScreenName, Object, NameOfTheProperty, Value)
Parámetros
ScreenName
Object
NameOfTheProperty
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "char".
Valor de retorno
TRUE
FALSE

Ejemplo
El siguiente código de programa ajusta la propiedad Tooltiptext del objeto gs_graph_iofield al
valor "Tooltiptext 1" con la función SetPropChar. El valor de retorno se guarda en la variable
ok.
{
BOOL ok;
//Set the property Tooltiptext

ok = SetPropChar("Screen_1","gs_graph_iofield","ToolTipText","Tooltiptext 1");
//error handling
if(ok)
{
// succeeded
printf ( "Property of Tooltiptext is now Tooltiptext 1." );
}
else
{
// failed
printf ( "Error - property not set" );
}
...
}
2.1.32.3 SetPropDouble (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "Double".
Sintaxis
BOOL SetPropDouble(ScreenName, Object, NameOfTheProperty, Value)
Parámetros
ScreenName
Object

NameOfTheProperty
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "double".
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa accede a una propiedad del objeto en la imagen screenName.
En este ejemplo, la función SetPropDouble ajusta la propiedad (Radio) del círculo "Circle_1"
al valor 10. El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//Set the property of circle

ok = SetPropDouble(screenName,"Circle_1","Radius",10);
//error handling
if(ok)
{
// succeeded
printf ( "Radius was set." );
}
else
{
// failed
printf ( "Error - radius not set" );
}
...
}
2.1.32.4 SetPropLong (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "long".

Sintaxis
BOOL SetPropLong(ScreenName, Object, NameOfTheProperty, Value)
Parámetros
ScreenName
Object
NameOfTheProperty
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "long".
Valor de retorno
TRUE
FALSE

Ejemplo
El siguiente código de programa modifica el color de primer plano de un objeto con la función
SetPropLong: en la imagen "Screen_1" se ajusta la propiedad "ForeColor" del objeto incluido
"Button1" al valor 65333 (rojo). El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//Set the property Tooltiptext

ok = SetPropLong("Screen_1","Button1","ForeColor",65333);
//error handling
if(ok)
{
// succeeded
printf ( "Color was set." );
}
else
{
// failed
printf ( "Error - color not set" );
}
...
}
2.1.33 SetPropertyByConstant (RT Professional)
Descripción
Define el valor de una propiedad de objeto como cadena de caracteres.

DefinirPropiedadVíaConstante (nombre de imagen, objeto de imagen, nombre de la
propiedad, valor)

SetPropertyByConstant Screen_name, Screen_object, Property_name, Value
Si desea modificar la propiedad de una imagen, el parámetro "Objeto" debe estar vacío. Utilice
para ello, p. ej., la sintaxis siguiente:
SetPropertyByConstant Screen_name, Property_name, Value

Parámetros
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad se modifica.
Valor
Valor que se asigna a la propiedad.
Ejemplo
SetPropertyByConstant: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick"
del objeto incluido "Control_1" al valor 26.

'User defined code

...
{

...
}

Ejemplo: modificar una propiedad de imagen

El siguiente código de programa modifica una propiedad de una imagen con la función
SetPropertyByConstant: en la imagen "Trends" se ajusta la propiedad "Backcolor" al valor 255.

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

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

...
}
Como alternativa, puede utilizar en lugar del segundo parámetro (Objeto) la contraseña NULL
o bien un string de espacios en blanco.
2.1.34 SetPropertyByProperty (RT Professional)
Descripción
Define el valor de una propiedad de objeto por medio de otra propiedad de objeto.

DefinirPropiedadVíaPropiedad (Nombre de imagen, Objeto, Nombre de la propiedad, Destino-
Nombre de imagen, Destino-Objeto de imagen, Destino Nombre de propiedad)

SetPropertyByProperty Screen_name, Screen_object, Property_name,
Source_screen_name, Source_screen_object, Source_property_name
Si desea definir una propiedad de una imagen mediante otra propiedad de imagen, los
parámetros "Objeto" y "Objeto de destino" deben estar vacíos. Utilice para ello, p. ej., la sintaxis
siguiente:

SetPropertyByProperty Screen_name, Property_name, Source_screen_name,

Source_property_name
Parámetros
Nombre de imagen
Objeto
Nombre del objeto del que se transfiere una propiedad al objeto de destino.
Nombre de la propiedad cuyo valor se transfiere al objeto de destino.
Nombre de imagen de destino

Nombre de la imagen en el que está contenido el objeto de destino.
Destino-Objeto de imagen
Nombre del objeto de destino del que se modifica una propiedad.
Nombre de la propiedad de destino

Ejemplo
El siguiente código de programa transfiere con la función SetPropertyByProperty la propiedad
"ToolbarButtonClick" del objeto "Control_1" en la imagen de salida "Trend_1" a la propiedad
correspondiente de la imagen de destino"Trend_2".

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

"Control_2", "ToolbarButtonClick"
'User defined code

...

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

"Control_2", "ToolbarButtonClick");

...
}
2.1.35 SetPropertyByTag (RT Professional)
Descripción
Define el valor de una propiedad de objeto por medio de un valor de variable.

DefinirPropiedadVíaVariable (nombre de imagen, objeto de imagen, nombre de la propiedad,
nombre de la variable)

SetPropertyByTag Screen_name, Screen_object, Property_name, Tag_name
Si desea definir la propiedad de una imagen mediante un valor de variable, el parámetro
"Objeto" debe estar vacío. Utilice para ello, p. ej., la sintaxis siguiente:
SetPropertyByTag Screen_name, Property_name, Tag_name
Parámetros
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad se activa por medio del valor de variable.

Nombre de la propiedad que se activa por medio del valor de variable.
Nombre de variable
Nombre de la variable que contiene el valor de la propiedad.
Ejemplo
SetPropertyByTag: Al hacer clic sobre el objeto se transfieren el nombre del objeto y la imagen
en la que se encuentra el objeto. El título CaptionText de la ventana de imagen contiene el
valor de la variable HMI_value_1.

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

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

...
}
Ejemplo
SetPropertyByTag: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick" del
objeto incluido "Control_1" al valor 26.

'User defined code

...

{

...
}
2.1.36 SetPropertyByTagIndirect (RT Professional)
Descripción
Escribe el nombre de una variable direccionada indirectamente en una propiedad de objeto.
La variable transferida como parámetro contiene el nombre de una segunda variable, cuyo
valor se lee.

DefinirPropiedadVíaVariableIndirectamente (nombre de imagen, objeto de imagen, nombre
de la propiedad, nombre de la variable)

SetPropertyByTagIndirect Screen_name, Screen_object, Property_name, Tag_name
Si desea definir la propiedad de una imagen indirectamente mediante una variable, el
parámetro "Objeto" debe estar vacío. Utilice para ello, p. ej., la sintaxis siguiente:
SetPropertyByTagIndirect Screen_name, Property_name, Tag_name
Parámetros
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad se debe modificar.
Nombre de la propiedad que se debe modificar.

Nombre de variable
Nombre de la variable que, a su vez, contiene el nombre de la variable cuyo valor se lee.
Ejemplo
SetPropertyByTagIndirect:

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

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

...
}
2.1.37 SetTag (RT Professional)
2.1.37.1 Funciones SetTag (RT Professional)
Descripción
La función SetTagXXX establece el valor de una variable del tipo de datos especificado.
La tabla siguiente muestra las diferentes funciones SetTag para activar el valor de la
variable:
Nombre de función Parámetro Tipo de datos PLC Tipo de datos HMI

SetTagBit Tag Tag_Name, Variable binaria Bool
short int value
SetTagByte Tag Tag_Name, 8 bits sin signo USInt
BYTE value
SetTagDateTime Tag Tag_Name, DTL DateTime
SYSTEMTIME va‐
lue


SetTagChar Tag Tag_Name, Variable de texto de 8 bits o de String o WString
LPSTR value 16 bits
SetTagDouble Tag Tag_Name, Número en coma flotante de 64 LReal
double value bits
SetTagDWord Tag Tag_Name, 32 bits sin signo UDInt
DWORD value
SetTagFloat Tag Tag_Name, Número en coma flotante de 32 Real
float value bits
SetTagRaw Tag Tag_Name, Tipo de datos sin formato Raw
BYTE* pValue,
DWORD size
SetTagSByte Tag Tag_Name, 8 bits con signo SInt
char value
SetTagSDWord Tag Tag_Name, 32 bits con signo DInt
long int value
SetTagSWord Tag Tag_Name, 16 bits con signo Int
short int value
SetTagWord Tag Tag_Name, 16 bits sin signo UInt
WORD value
Nota
Mensaje de error al utilizar una variable del tipo WString
Si se utiliza una variable del tipo WString en una función de sistema SetTag que ha sido
convertida a un script en C, al ejecutar la función se emitirá un mensaje de error en la ventana
de diagnóstico del Global Script. Pese al mensaje de error, la función se ejecuta
correctamente.
Se ven afectadas las siguientes funciones SetTag:
● SetTagWithOperatorEvent
● SetTagIndirect
● SetTagByTagIndirect
● SetTagIndirectByTagIndirect
● SetTagByProperty
● SetTagIndirectByProperty
Sintaxis
BOOL<Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBit(Tag_Name, value);
Parámetros
Tag_Name

value
Valor de la variable en el tipo de datos indicado.
pValue
size
Valor de retorno
TRUE
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Ejemplo
El siguiente código de programa ajusta con la función SetTagBit el valor de las variables
{
BOOL ok;
BOOL bvalue;

ok = SetTagBit("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}

Consulte también
Propiedad VariableStateType (Página 1572)
2.1.37.2 SetTagDateTime (RT Professional)
Función
Establece el valor de una variable del tipo de datos "Fecha/hora".
Sintaxis
BOOL SetTagDateTime(Tag_Name, value);
Parámetros
Tag_Name
value
Valor de la variable en el tipo de datos "Fecha/hora".
Valor de retorno
TRUE
La función en sí se ha ejecutado sin errores.
FALSE
2.1.37.3 Funciones SetTagMultiStateWait (RT Professional)
Descripción
Establece los valores de varias variables. La función de sistema no finaliza hasta que el PLC
ha comunicado la aceptación del valor.
Debe transferirse a la función de sistema una matriz DWORD en cuyo miembro se encuentren
los estados de las variables individuales después de llamar la función de sistema. El tamaño
de la matriz debe ser lo suficientemente grande como para que haya suficiente espacio de
memoria para estos estados.

Sintaxis
BOOL SetTagMultiStateWait(pdwState, pFormat,...);
Parámetros
pdwState
Campo en el que se guardan los estados de variables
pFormat
Descripción de formato para todas las variables solicitadas y nombre y valor para cada
variable.
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa establece el valor de diversas variables con la función
SetTagMultiStateWait.
1. Creación de una matriz DWord con el tamaño necesario (número de variables)
2. Creación de las variables cuyos valores se transferirán a las variables de WinCC con la
función SetTagMultiStateWait
3. Descripción de las variables de WinCC con los valores de las variables que acaban de
declararse:
– gs_tag_bit con el valor de la variable "lValue1"
– gs_tag_SByte con el valor de la variable en la dirección "&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);
...
}
Consulte también
2.1.37.4 Funciones SetTagMultiWait (RT Professional)
Descripción
Los valores de varias variables se establecen en el formato indicado. La función de sistema
no finaliza hasta que el PLC ha comunicado la aceptación del valor.
Sintaxis
BOOL SetTagMultiWait(pFormat,...);
Parámetros
pFormat
variable.

Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa modifica el valor de diversas variables con la función
SetTagMultiWait. El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//memory for values allocated via SysMalloc
DWORD dwVar1Value;
char* szVar2Value;
double dbVar3Value;
//settings
ok=SetTagMultiWait("%d%s%f", "Ernie_word", 16,
"Ernie_char", "Hallo Welt",
"Ernie_double", 55.4711);
//error handling
if(ok)
{
// succeeded
// Get values and print

GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,

}
else
{
// failed
}
...
}

Ejemplo
El siguiente código de programa lee diversas variables de tipos distintos con la función
GetTagMultiWait.
1. Declaración de tres variables como memoria para tres tipos de variable distintos
2. Declaración de las variables booleanas ok para guardar en caché el valor de retorno (TRUE/
FALSE)
3. Lectura de las tres variables y almacenamiento de los valores en las direcciones
correspondientes.
El valor de retorno de la función se guarda en la variable ok.
4. Impresión de las tres variables con el tipo de variable antepuesto
DWORD dwVar1Value;
char* szVar2Value;
//Memory for the tag value is allocated by the function SysMalloc
double dbVar3Value;
BOOL ok;
ok=GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,


2.1.37.5 Funciones SetTagState (RT Professional)
Descripción
Establece el valor de una variable del tipo de datos indicado. Además se devuelve el estado
de las variables.
La siguiente tabla muestra las diferentes funciones SetTagStateXXX para establecer el valor
de la variable:
Nombre de fun‐ Parámetro Tipo de datos PLC Tipo de datos HMI

ción
SetTagBitState Tag Tag_Name, short Variable binaria Bool
int value, PDWORD
lp_dwstate
SetTagByteSta‐ Tag Tag_Name, BYTE 8 bits sin signo UByte
te value, PDWORD
lp_dwstate
SetTagCharSta‐ Tag Tag_Name, LPSTR Variable de texto de 8 bits String
te value, PDWORD o de 16 bits
lp_dwstate


ción
SetTagDou‐ Tag Tag_Name, double Número en coma flotante Double
bleState value, PDWORD de 64 bits
lp_dwstate
SetTagDWordS‐ Tag Tag_Name, 32 bits sin signo UInteger
tate DWORD value,
PDWORD lp_dwstate
SetTagFloatSta‐ Tag Tag_Name, float va‐ Número en coma flotante Float
te lue, PDWORD lp_dwsta‐ de 32 bits
te
SetTagRawSta‐ Tag Tag_Name, BYTE* Tipo de datos sin formato Raw
te pValue, DWORD size,
PDWORD lp_dwstate
SetTagSByteS‐ Tag Tag_Name, signed 8 bits con signo Byte
tate char value, PDWORD
lp_dwstate
SetTagSD‐ Tag Tag_Name, long int 32 bits con signo Integer
WordState value, PDWORD
lp_dwstate
SetTagSWordS‐ Tag Tag_Name, short 16 bits con signo Short
tate int value, PDWORD
lp_dwstate
SetTagWordS‐ Tag Tag_Name, WORD 16 bits sin signo UShort
tate value, PDWORD
lp_dwstate
Sintaxis
BOOL <Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBitState(Tag_Name, value, lp_dwstate);
Parámetros
Tag_Name
value
lp_dwstate
pFormat
variable.

pValue
size
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa ajusta con la función SetTagBitState el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok. "&dwstate" es la dirección
de las variables en la que se guarda el estado de las variables.
{
DWORD dwstate;
BOOL ok;
//Load dwState with default values

dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
ok = SetTagBitState("gs_tag_bit",TRUE,&dwstate);
//error handling
if(ok)
{
// succeeded
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
}
...
}

Consulte también
2.1.37.6 Funciones SetTagStateWait (RT Professional)
Descripción
Establece el valor de una variable del tipo de datos indicado. La función de sistema no finaliza
hasta que el PLC ha comunicado la aceptación del valor. Además se devuelve el estado de
las variables.
La siguiente tabla muestra las diferentes funciones SetTagStateWait para establecer el valor
de la variable:

SetTagBitState‐ Tag Tag_Name, short Variable binaria Bool
Wait int value, PDWORD
lp_dwstate
SetTagByteState‐ Tag Tag_Name, BYTE 8 bits sin signo UByte
Wait value, PDWORD
lp_dwstate
SetTagCharState‐ Tag Tag_Name, Variable de texto de 8 bits String
Wait LPSTR value, o de 16 bits
PDWORD lp_dwstate
SetTagDoubleSta‐ Tag Tag_Name, double Número en coma flotante Double
teWait value, PDWORD de 64 bits
lp_dwstate
SetTagDWordSta‐ Tag Tag_Name, 32 bits sin signo UInteger
teWait DWORD value,
PDWORD lp_dwstate
SetTagFloatState‐ Tag Tag_Name, float Número en coma flotante Float
Wait value, PDWORD de 32 bits
lp_dwstate
SetTagRawState‐ Tag Tag_Name, BYTE* Tipo de datos sin formato Raw
Wait pValue, DWORD size,
PDWORD lp_dwstate
SetTagSByteSta‐ Tag Tag_Name, char 8 bits con signo Byte
teWait value, PDWORD
lp_dwstate
SetTagSDWordS‐ Tag Tag_Name, long 32 bits con signo Integer
tateWait int value, PDWORD
lp_dwstate
SetTagSWordSta‐ Tag Tag_Name, short 16 bits con signo Short
teWait int value, PDWORD
lp_dwstate
SetTagWordState‐ Tag Tag_Name, 16 bits sin signo UShort
Wait WORD value,
PDWORD lp_dwstate

Sintaxis
BOOL<Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBitStateWait(Tag_Name, value, lp_dwstate);
Parámetros
Tag_Name
value
lp_dwstate
pValue
size
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa ajusta con la función SetTagBitStateWait el valor de las
variables gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok. "&dwstate" es la
dirección de las variables en la que se guarda el estado de las variables.

{
DWORD dwstate;
BOOL ok;
//Load dwState with default values

dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
ok = SetTagBitStateWait("gs_tag_bit",TRUE,&dwstate);
//error handling
if(ok)
{
// succeeded
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
}
...
}
Consulte también
2.1.37.7 Funciones SetTagValue (RT Professional)
Descripción
Permite la transferencia de un valor en forma de Variant y pone el puntero hacia el valor del
tipo de datos "Variant".
Sintaxis
BOOL SetTagValue(lpdmVarKey, lpdmValue, dwState, lpdmError);
Parámetros
lpdmVarKey

lpdmValue
Puntero hacia el valor del tipo de datos "Variant". Encontrará la descripción del tipo de datos
VARIANT en la correspondiente documentación técnica.
lpdmError
Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa transfiere el valor de varKey con la función SetTagValue.
{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:
// tags for getting the value

CMN_ERROR error:
BOOL keyFound;
ok = SetTagValue(&varKey, &value, &error1);
if (keyFound)
{
// succeeded, get the new value
GetTagValue(&varKey, &result, &error);
// print tag value
...
}
else
{
// failed
...
}
}

2.1.37.8 Funciones SetTagValueWait (RT Professional)
Descripción
Permite la transferencia de un valor en forma de Variant y pone el puntero hacia el valor del
tipo de datos "Variant". La función de sistema no finaliza hasta que el PLC ha comunicado la
aceptación del valor.
Sintaxis
BOOL SetTagValueWait(lpdmVarKey, lpdmValue, dwState, lpdmError);
Parámetros
lpdmVarKey
lpdmValue
Puntero hacia el valor del tipo de datos "Variant". Encontrará la descripción del tipo de datos
VARIANT en la correspondiente documentación técnica.
dwState
Estado de la variable que se devuelve después de la ejecución de la función de sistema
lpdmError
Valor de retorno
TRUE
No obstante, no se comprueba si también pudo escribirse la variable sin errores.
FALSE
Ejemplo
El siguiente código de programa transfiere el valor de varKey con la función SetTagValueWait.

{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:
// tags for getting the value

CMN_ERROR error:
BOOL keyFound;
ok = SetTagValueWait(&varKey, &value, &error1);
if (keyFound)
{
// succeeded, get the new value
GetTagValueWait(&varKey, &result, &error);
// print tag value
...
}
else
{
// failed
...
}
}
2.1.37.9 Funciones SetTagWait (RT Professional)
Descripción
Establece el valor de una variable del tipo de datos indicado. La función de sistema no finaliza
hasta que el PLC ha comunicado la aceptación del valor.
La siguiente tabla muestra las diferentes funciones SetTagWait para establecer el valor de la
variable:

ción
SetTagBitWait Tag Tag_Name, short Variable binaria Bool
int value
SetTagByte‐ Tag Tag_Name, BYTE 8 bits sin signo UByte
Wait value
SetTagChar‐ Tag Tag_Name, char* Variable de texto de 8 bits String
Wait value o de 16 bits


ción
SetTagDouble‐ Tag Tag_Name, double Número en coma flotante Double
Wait value de 64 bits
SetTagDWord‐ Tag Tag_Name, 32 bits sin signo UInteger
Wait DWORD value
SetTagFloat‐ Tag Tag_Name, float va‐ Número en coma flotante Float
Wait lue de 32 bits
SetTagRaw‐ Tag Tag_Name, BYTE* Tipo de datos sin formato Raw
Wait pValue, DWORD size
SetTagSByte‐ Tag Tag_Name, char va‐ 8 bits con signo Byte
Wait lue
SetTagSDWord‐ Tag Tag_Name, long int 32 bits con signo Integer
Wait value
SetTagSWord‐ Tag Tag_Name, short 16 bits con signo Short
Wait int value
SetTagWord‐ Tag Tag_Name, WORD 16 bits sin signo UShort
Wait value
Sintaxis
BOOL <Nombre de función><(Parámetro)>;
Ejemplo: BOOL SetTagBitWait(Tag_Name, value);
Parámetros
Tag_Name
value
pValue
size
Valor de retorno
TRUE
FALSE

Ejemplo
El siguiente código de programa ajusta con la función SetTagBitWait el valor de las variables
{
BOOL ok;
BOOL bvalue;

ok = SetTagBitWait("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
bvalue = GetTagBitWait("gs_tag_bit");
}
else
{
// failed
}
...
}
2.1.37.10 SetTag (RT Professional)
Descripción
Nota


SetTag Tag, Value

Parámetros
Variable
Valor
Nota
Ejemplo
{
BOOL ok;
BOOL bvalue;

//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}
2.1.37.11 SetTagByProperty (RT Professional)
Descripción
Define un valor de variable por medio del valor de una propiedad de objeto. La modificación
se registra adicionalmente en el sistema de avisos.


DefinirVariableVíaPropiedad (nombre de variable, nombre de imagen, objeto de imagen,
nombre de la propiedad, con o sin aviso de operador)

SetTagByProperty Tag_name, Screen_name, Screen_object, Property_name,
Parámetros
Nombre de variable
Nombre de la variable cuyo valor se define por medio de la propiedad de objeto.
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad proporciona el valor de variable.
Nombre de la propiedad que proporciona el valor de variable.

Ejemplo
El siguiente código de programa devuelve el valor del texto seleccionado al hacer clic en un
cuadro combinado.
{
char* rt_value;
SetTagByProperty (rt_value, screenName, objectName, "SelectedText",

...
}

2.1.37.12 SetTagByTagIndirect (RT Professional)
Descripción
Escribe el valor de una variable direccionada indirectamente en una variable. La variable
transferida como parámetro contiene el nombre de una segunda variable, cuyo valor se lee.
Mediante un aviso de operador se puede documentar la modificación en el sistema de avisos.

DefinirVariableVíaVariableIndirecta (nombre de variable, nombre de variable, con o sin aviso
de operador)

SetTagByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parámetros
Nombre de la variable cuyo valor debe modificarse.
Nombre de variable
Nombre de una variable de string que contiene el nombre de una variable que devuelve el
valor de la variable.

Ejemplo
El siguiente código de programa escribe el valor de la variable Tag4 en la variable Tag1.
{
SetTagByTagIndirect ("Tag1", "IndirectRead", hmiWithoutOperatorEvent);
...
}

2.1.37.13 SetTagIndirect (RT Professional)
Descripción
Escribe un valor en una variable direccionada indirectamente. La variable transferida como
parámetro de salida contiene el nombre de una segunda variable, cuyo valor es modificado
por la función. Mediante un aviso de operador se puede documentar la modificación en el
sistema de avisos.

DefinirVariableIndirectamente (variable, valor, con o sin aviso de operador)

SetTagIndirect Tag_name, Value, With_or_without_operator_event
Parámetros
Nombre de variable
modificarse.
Valor
Valor que se debe escribir.

Ejemplo
El siguiente código de programa escribe el valor "value" en la variable Tag3.
{
int value;

SetTagIndirect ("IndirectWrite", "value", hmiWithoutOperatorEvent);
...
}

2.1.37.14 SetTagIndirectByProperty (RT Professional)
Descripción
Escribe el valor de una propiedad de objeto en una variable direccionada indirectamente. La
variable transferida como parámetro de salida contiene el nombre de una segunda variable,
cuyo valor es modificado por la función. Mediante un aviso de operador se puede documentar
la modificación en el sistema de avisos.

DefinirVariableIndirectamenteVíaPropiedad (Nombre de variable, Nombre de imagen, Objeto
de imagen, Nombre de la propiedad, Con o sin aviso de operador)

SetTagIndirectByProperty Tag_name, Screen_name, Screen_object, Property_name,
Parámetros
Nombre de variable
modificarse.
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad devuelve el valor.
Nombre de la propiedad que devuelve el valor.


Ejemplo
El siguiente código de programa escribe el valor de la propiedad de objeto "Color de fondo"
en la variable Tag2.
{
SetTagIndirectByProperty ("IndirectWrite", screenName, objectName, "BackColor",
...
}
2.1.37.15 SetTagIndirectByTagIndirect (RT Professional)
Descripción
Escribe el valor de una variable direccionada indirectamente en una variable direccionada
indirectamente. La variable transferida como parámetro de salida contiene el nombre de una
segunda variable, cuyo valor es modificado por la función. La variable transferida como
parámetro contiene el nombre de una segunda variable, cuyo valor se lee. Mediante un aviso
de operador se puede documentar la modificación en el sistema de avisos.

DefinirVariableIndirectaVíaVariableIndirecta (Nombre de variable, Nombre de variable, Con
o sin aviso de operador)

SetTagIndirectByTagIndirect Tag_name, Source_tag_name, With_or_without_operator_event
Parámetros
Nombre de variable
modificarse.
Nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.


Ejemplo
El siguiente código de programa escribe el valor de la variable "Tag4" en la variable "Tag2".
{
SetTagIndirectByTagIndirect ("IndirectWrite", "IndirectRead");
...
}
2.1.37.16 SetTagIndirectWithOperatorEvent (RT Professional)
Descripción
Define el nombre indirecto para una variable. La modificación se registra adicionalmente en
el sistema de avisos.

DefinirVariableIndirectamenteConAvisoDeOperador (Nombre de variable (salida), LpValue)

SetTagIndirectWithOperatorEvent
Parámetros
Nombre de variable (salida)

Nombre de la variable en la que se escribe el nombre de variable.
LpValue
Nombre de la variable en la que se escribe la variable.
2.1.37.17 SetTagWithOperatorEvent (RT Professional)
Descripción
Define el valor de una variable. La modificación se registra adicionalmente en el sistema de
avisos.


DefinirVariableConAvisoDeOperador (nombre de la variable, valor)

SetTagWithOperatorEvent Tag_name, Value
Parámetros
Nombre de la variable cuyo valor se define.
Valor
El valor que se escribe la variable.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.

SetTagWithOperatorEvent result, value
...
{
SetTagWithOperatorEvent ("result", "value");
...
}
2.1.38 StartProgram (RT Professional)
Descripción
Inicia el programa indicado con los parámetros especificados.

Sintaxis
void StartProgram(Program_name, Program_parameters, Display_mode,
Wait_for_program_end);
Parámetros
Program_name
Ruta y nombre del programa que se debe iniciar.
Program_parameters
Parámetros que deben utilizarse al iniciar el programa. En la descripción del programa que
se va a iniciar encontrará información sobre los parámetros posibles.
Display_mode
Define en qué modo de visualización debe iniciarse el programa:
0 (hmiShowNormal) = Visualización en ventana
1 (hmiShowMinimized) = Visualización en ventana minimizada
2 (hmiShowMaximized) = Visualización en ventana maximizada
3 (hmiShowMinimizedAndInactive) = visualización en ventana inactiva minimizada
Wait_for_program_end
WinCC Runtime Professional no evalúa el parámetro.
Ejemplo
El siguiente código de programa inicia el programa calc.exe en la ventana minimizada.
{
BOOL Wait_for_program_end;
float number;
//start the program calc.exe

StartProgram("C:\\Winnt\\system32\\calc.exe",number,hmiShowMinimized,
Wait_for_program_end);
...
}
2.1.39 StopRuntime (RT Professional)
Descripción
operador.


PararRuntime (Modo)

StopRuntime Mode
Parámetros
Modo
Ejemplo

2.1.40 StoreScreen (RT Professional)
Descripción
Guarda la imagen actual. Esta imagen puede abrirse con la función de sistema
ActivateStoredScreen.
Sintaxis
BOOL StoreScreen();

Valor de retorno
TRUE
FALSE
Ejemplo
El siguiente código de programa escribe el valor de retorno de la función StoreScreen en la
variable screen_stored y abre la imagen guardada siempre que se haya guardado sin errores.
{
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." );
}
...
}
Consulte también
ActivateStoredScreen (Página 1392)
2.1.41 SystemTimeToDate (RT Professional)
Descripción
Convierte una indicación de fecha y hora dada en el formato SYSTEMTIME al formato de
datos DATE.


HoraDelSistemaAFecha (valor, puntero hacia hora)
Sintaxis
SystemTimeToDate(Value, PointerToTime);
Parámetros
Valor
Valor en el formato de datos SYSTEMTIME
Puntero hacia hora

Puntero hacia el resultado en el formato DATE
Valor de retorno
TRUE
FALSE

Ejemplo
BOOL BRet;
SYSTEMTIME st_1, st_2;
DATE d_1, d_2; // wtypes.h. DATE type. Visual Studio documnetation.
GetSystemTime( &st_1 );

printf( "st_1.wDay = %d \r\n", st_1.wDay );printf( "st_1.wHour = %d \r\n", st_1.wHour );
printf( "st_1.wMilliseconds = %d \r\n", st_1.wMilliseconds );
BRet = SystemTimeToDate( st_1, &d_1 );

printf( "DATE d = %ld \r\n \r\n", d_1 );
printf( "DATE d = %lf \r\n \r\n", d_1 );
printf( "DATE d = %f \r\n \r\n", d_1 );
BRet = DateToSystemTime( d_1, &st_2 );

printf( "st_2.wDay = %d \r\n", st_2.wDay );
printf( "st_2.wHour = %d \r\n", st_2.wHour );
printf( "st_2.wMilliseconds = %d \r\n \r\n \r\n", st_2.wMilliseconds );
2.1.42 TriggerOperatorEvent (RT Professional)
Descripción
La función de sistema TriggerOperatorEvent lanza un aviso de operador.
Sintaxis
int TriggerOperatorEvent(dwFlags, dwMsgNum, lpszObjectName, dwMyTextID, doValueOld,
doValueNew, pszComment);
Parámetros
dwFlags
FLAG_COMMENT_PARAMETER (0x001): Determina que la entrada del comentario tenga

lugar a través del parámetro.

FLAG_COMMENT_DIALOG (0x003): Determina que la entrada del comentario tenga lugar a

través de un diálogo.
FLAG_TEXTID_PARAMETER (0x100): Determina que el comentario se defina a través de la
ID del texto
dwMsgNum
Número del aviso de operador lanzado.
lpszObjectName
Puntero hacia el nombre de las variables con el valor antiguo y el valor nuevo.
dwMyTextID
ID del texto que debe utilizarse como comentario.
doValueOld
Valor antiguo.
doValueNew
Valor nuevo.
pszComment
Puntero hacia el texto que debe utilizarse como comentario.
Valor de retorno
TRUE
FALSE
2.1.43 UA (Recipe) (RT Professional)
2.1.43.1 uaArchiveClose (RT Professional)
Descripción
Se suprime la conexión con la receta actual.
Sintaxis
BOOL uaArchiveClose (

UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Cierre correcto de la receta
FALSE
error
2.1.43.2 uaArchiveDelete (RT Professional)
Descripción
Borra los datos de una receta, aunque la receta configurada se conserva.
Sintaxis
BOOL uaArchiveDelete (
UAHARCHIVE hArchive,
LPCSTR pszWhere )
Parámetros
UAHARCHIVE hArchive
LPCSTR pszWhere
En este string está la expresión de selección SQL. Este determina los registros que hay que
borrar. La expresión es la misma que en la instrucción SQL "DELETE FROM <archive>
WHERE pszWhere".
¡Atención! Si este string está vacío, se borra toda la receta.
Valor de retorno
TRUE

borrado correcto de la receta

FALSE
Error
2.1.43.3 uaArchiveExport (RT Professional)
Descripción:
Exporta la receta actual a un fichero en formato CSV.
Sintaxis
BOOL uaArchiveExport (
LPCSTR pszDestination,
LONG lType,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con UaQueryArchive o UaQueryArchiveByName.
LPCSTR pszDestination
Nombre de archivo del fichero de destino
LONG lType
Formato de datos del fichero de destino. Los dos formatos disponibles son:
● UA_FILETYPE_DEFAULT = 0: Formato de archivo predeterminado = CSV
● UA_FILETYPE_CSV = 1: Formato de archivo CSV
LONG lOptions
Reservado para extensiones posteriores. Debe ser 0.
Valor de retorno
TRUE
exportación correcta de la receta
FALSE

Error
2.1.43.4 uaArchiveGetCount (RT Professional)
Descripción
Lee la cantidad de registros.
Sintaxis
LONG uaArchiveGetCount(
LONG * plCount )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName .
LONG plCount
Puntero sobre una variable, en el cual se debe depositar los registros.
Valor de retorno
Cantidad de registros.
0 = Fichero vacío o se ha producido un error. Es necesario realizar una consulta mediante
uaGetLastError() .
2.1.43.5 uaArchiveGetFieldLength (RT Professional)
Descripción
Lee la longitud de un campo en el registro actual.
Sintaxis
LONG uaArchiveGetFieldLength(
LONG lField )

Parámetros
UAHARCHIVE hArchive
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
Valor de retorno
Longitud del campo actual
2.1.43.6 uaArchiveGetFieldName (RT Professional)
Descripción
Lee el nombre de un campo en el registro actual.
Sintaxis
VOID uaArchiveGetFieldName (
LONG lField,
LPCSTR pszName,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
LONG lField
LPCSTR pszName
Nombre de campo
LONG cMaxLen
Longitud máxima

2.1.43.7 uaArchiveGetFields (RT Professional)
Descripción
Lee la cantidad de los campos de datos configurados, donde los campos "ID", "Último usuario"
y "Último acceso" no se cuentan. En los accesos de Runtime se indican los índices de los
campos configurados con 1 a N. El campo ID tiene el índice 0. Los campos "Último usuario"
y "Último acceso" añaden al final de los campos configurados.
Sintaxis
LONG uaArchiveGetFields (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
Cantidad de campos configurados.
2.1.43.8 uaArchiveGetFieldType (RT Professional)
Descripción
Lee el tipo de un campo en el registro actual.
Sintaxis
LONG uaArchiveGetFieldType (
LONG lField )
Parámetros
UAHARCHIVE hArchive

LONG lField
Valor de retorno
Tipo del campo actual
Las denominaciones simbólicas para los tipos de campo son:
UA_FIELDTYPE_INTEGER
UA_FIELDTYPE_DOUBLE
UA_FIELDTYPE_STRING
UA_FIELDTYPE_DATETIME
2.1.43.9 uaArchiveGetFieldValueDate (RT Professional)
Descripción
Lee la fecha y la hora de un campo en el registro actual.
Sintaxis
BOOL uaArchiveGetFieldValueDate (
LONG lField,
LPSYSTEMTIME pstDateTime )
Parámetros
UAHARCHIVE hArchive
LONG lField
LPSYSTEMTIME pstDateTime
Puntero sobre la variable del tipo SYSTEMTIME
Valor de retorno
TRUE
Lectura correcta de fecha y hora

FALSE
Error
2.1.43.10 uaArchiveGetFieldValueDouble (RT Professional)
Descripción
Lee valor double de un campo en el registro actual.
BOOL uaArchiveGetFieldValueDouble (
LONG lField,
double* pdValue )
Parámetros
UAHARCHIVE hArchive
LONG lField
double* pdValue
Puntero sobre la variable para el contenido de campo actual
Valor de retorno
TRUE
lectura correcta del valor del campo
FALSE
Error
2.1.43.11 uaArchiveGetFieldValueFloat (RT Professional)
Descripción
Lee valor Float de un campo en el registro actual.

Sintaxis
BOOL uaArchiveGetFieldValueFloat (
LONG lField,
FLOAT* pfValue )
Parámetros
UAHARCHIVE hArchive
LONG lField
FLOAT* pfValue
Puntero sobre la variable Float para el contenido de campo actual
Valor de retorno
TRUE
Lectura correcta del valor del campo
FALSE
Error
2.1.43.12 uaArchiveGetFieldValueLong (RT Professional)
Descripción
Lee valor número entero Long de un campo en el registro actual.
Sintaxis
BOOL uaArchiveGetFieldValueLong (
LONG lField,
LONG* pdValue )

Parámetros
UAHARCHIVE hArchive
LONG lField
LONG* pdValue
Puntero sobre la variable Long para el contenido de campo actual
Valor de retorno
TRUE
FALSE
Error
2.1.43.13 uaArchiveGetFieldValueString (RT Professional)
Descripción
Lee string de un campo en el registro actual.
Sintaxis
BOOL uaArchiveGetFieldValueString (
LONG lField,
LPSTR pszString,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
LONG lField
LPCSTR pszString
Valor de campo como String

LONG cMaxLen
Longitud máxima del string
Valor de retorno
TRUE
FALSE
Error
2.1.43.14 uaArchiveGetFilter (RT Professional)
Descripción
Lee el filtro del registro actual de datos. En el anexo, capítulo "Instrucciones de SQL"
encontrará más información.
Sintaxis
VOID uaArchiveGetFilter (
LPSTR pszFilter,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
LPSTR pszFilter
Filtro leído
LONG cMaxLen
Longitud máxima
2.1.43.15 uaArchiveGetID (RT Professional)
Descripción
uaArchiveGetID lee la identificación (ID) de la receta.

La ID de la receta sirve para fines internos y puede ser distinta al número indicado en la receta.
Sintaxis
LONG uaArchiveGetID (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
ID de la receta.
2.1.43.16 uaArchiveGetName (RT Professional)
Descripción
Lee el nombre de la receta.
Syntax
VOID uaArchiveGetName (
LPSTR pszName,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
LPSTR pszName
Puntero hacia el búfer para el nombre de la receta
LONG cMaxLen
Longitud máxima

Ejemplo
char Relleno[40];
uaArchiveGetName( hArchive, relleno, 39 );
2.1.43.17 uaArchiveGetSor (RT Professional)
Descripción
uaArchiveGetSort lee la clasificación de la receta.
Sintaxis
VOID uaArchiveGetSort (
LPSTR pszSort,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
LPCSTR pszSort
Clasificación
LONG cMaxLen
Longitud máxima
2.1.43.18 uaArchiveImport (RT Professional)
Descripción
uaArchivImport importa una receta con formato de datos CSV. La estructura de la receta de
destino debe ser idéntica a la de la receta importada.
Sintaxis
BOOL uaArchiveImport (
LPCSTR pszSource,

LONG lType,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
LPCSTR pszSource
Nombre de archivo del fichero de origen
LONG lType
Formato de datos del fichero de origen. Los dos formatos disponibles son:
UA_FILETYPE_DEFAULT = 0: Formato de archivo predeterminado = CSV
UA_FILETYPE_CSV = 1: Formato de archivo CSV
LONG lOptions
Reservado para extensiones posteriores. Debe ser 0.
Valor de retorno
TRUE
importación correcta de la receta
FALSE
Error
2.1.43.19 uaArchiveInsert (RT Professional)
Descripción
Añade el búfer de registro a la base de datos actual. Para que haya datos apropiados en el
nuevo registro, los campos del búfer local de registros tienen que escribirse antes de llamar
uaArchiveInsert con las funciones de sistema "uaArchiveSetFieldValue...".
La "ID" de columna interna tiene que escribirse con la función de sistema
"uaArchiveSetFieldValueLong" en el registro de datos actual. Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveInsert (

Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
Inserción correcta del registro.
2.1.43.20 uaArchiveMoveFirst (RT Professional)
Descripción
Ir al primer registro.
Sintaxis
BOOL uaArchiveMoveFirst (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
salto correcto en la receta
FALSE
Error
2.1.43.21 uaArchiveMoveLast (RT Professional)
Descripción
Ir al último registro.

Sintaxis
BOOL uaArchiveMoveLast (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
Salto correcto en la receta
FALSE
Error
2.1.43.22 uaArchiveMoveNext (RT Professional)
Descripción
Ir al siguiente registro.
Sintaxis
BOOL uaArchiveMoveNext (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
FALSE
Error

2.1.43.23 uaArchiveMovePrevious (RT Professional)
Descripción
Ir al registro anterior.
Sintaxis
BOOL uaArchiveMovePrevious (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
FALSE
Error
2.1.43.24 uaArchiveOpen (RT Professional)
Descripción
uaArchiveOpen debe llamarse antes que todas las funciones RT (p. ej., uaArchiveMoveFirst,
uaArchiveMoveLast, uaArchiveMoveNext, uaArchiveMovePrevious, uaArchiveDelete,
uaArchiveUpdate, uaArchiveInsert, uaArchiveGetID, uaArchiveGetFields,
uaArchiveGetFieldType, uaArchiveGetFieldValueDate, uaArchiveGetFieldValueDouble,
uaArchiveGetFieldValueFloat, uaArchiveGetFieldValueLong, uaArchiveGetFieldValueString,
uaArchiveSetFieldValueDate, uaArchiveSetFieldValueDouble, uaArchiveSetFieldValueFloat,
uaArchiveSetFieldValueLong y uaArchiveSetFieldValueString).
Nota
Clasificar y filtrar recetas
Las funciones de sistema "uaArchiveSetSort" y "uaArchiveSetFilter" pueden utilizarse en una
receta sin abrir la receta con "uaArchiveOpen".

Sintaxis
BOOL uaArchiveOpen (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
apertura correcta de la receta
FALSE
Error
2.1.43.25 uaArchiveReadTagValues (RT Professional)
Descripción
Lee los valores actuales de las variables de campos.
Sintaxis
BOOL uaArchiveReadTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
LONG* pnFields
Reservado para aplicaciones futuras (0)
LONG cFields
Cantidad de los índices de campo transmitidos (Tamaño del Arrays pnFields).

LONG lOptions
Para el resto de los valores de IOptions se insertan los datos en la posición del puntero.
Valor de retorno
TRUE
lectura correcta en la receta
FALSE
Error
2.1.43.26 uaArchiveReadTagValuesByName (RT Professional)
Descripción
Lee los valores de variables en los datos actuales
Sintaxis
BOOL uaArchiveReadTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
LPCSTR pszFields
LONG lOptions
Valor de retorno
TRUE
Lectura correcta en la receta

FALSE
Error
2.1.43.27 uaArchiveRequery (RT Professional)
Descripción
Tras llamar uaArchiveSetFilter y uaArchiveSetSort se debe volver a cargar la receta con
uaArchiveRequery.
Nota
Clasificar y filtrar recetas
Las funciones de sistema "uaArchiveSetSort" y "uaArchiveSetFilter" pueden utilizarse en una
receta sin abrir la receta con "uaArchiveOpen". En este caso no se debe llamar la función de
sistema "uaArchiveRequery".
Llame uaArchiveRequery también en los siguientes casos:

● Si ha realizado entradas a través del visor de recetas.
● Si ha realizado entradas en el editor "Recetas" que deben adoptarse en la celda de la tabla.
Sintaxis
BOOL uaArchiveRequery(
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
Requery correcto
FALSE
Error

2.1.43.28 uaArchiveSetFieldValueDate (RT Professional)
Descripción
Escribe la fecha y la hora en un campo en el registro actual.
Sintaxis
BOOL uaArchiveSetFieldValueDate (
LONG lField,
LPSYSTEMTIME pstDateTime )
Parámetros
UAHARCHIVE hArchive
LONG lField
El número de campo, de modo que el primer campo configurado se direcciona con lField = 1.
Con lField = 0 se direcciona el campo ID.
LPSYSTEMTIME pstDateTime
Fecha y hora
Valor de retorno
TRUE
Escritura correcta de fecha y hora
FALSE
Error
2.1.43.29 uaArchiveSetFieldValueDouble (RT Professional)
Descripción
Escribe un valor double en un campo en el registro actual.

Sintaxis
BOOL uaArchiveSetFieldValueDouble (
LONG lField,
double dValue )
Parámetros
UAHARCHIVE hArchive
LONG lField
El número de campo, donde lField = 1 direcciona el primer campo configurado. Con lField =
0 se direcciona el campo ID.
double dValue
Valor de campo
Valor de retorno
TRUE
escritura correcta del valor del campo
FALSE
Error
2.1.43.30 uaArchiveSetFieldValueFloat (RT Professional)
Descripción:
Escribe un valor Float en un campo en el registro actual.
Sintaxis
BOOL uaArchiveSetFieldValueFloat (
LONG lField,
float fValue )

Parámetros:
UAHARCHIVE hArchive
LONG lField
float fValue
Valor de campo
Valor de retorno:
TRUE
Escritura correcta del valor del campo
FALSE
Error
2.1.43.31 uaArchiveSetFieldValueLong (RT Professional)
Descripción
Escribe un valor de número entero Long en un campo en el registro actual.
Syntax
BOOL uaArchiveSetFieldValueLong (
LONG lField,
LONG dValue )
Parámetros
UAHARCHIVE hArchive
LONG lField

LONG dValue
Valor de campo
Valor de retorno
TRUE
FALSE
Error
2.1.43.32 uaArchiveSetFieldValueString (RT Professional)
Descripción
Escribe un string en un campo en el registro actual.
Sintaxis
BOOL uaArchiveSetFieldValueString (
LONG lField,
LPCSTR pszString )
Parámetros
UAHARCHIVE hArchive
LONG lField
LPCSTR pszString
Valor de campo
Valor de retorno
TRUE
FALSE
Error

2.1.43.33 uaArchiveSetFilter (RT Professional)
Descripción
Pone un filtro. Puede llamar la función de sistema sin abrir la receta con "uaArchiveOpen".
Nota
Si abre la receta con "uaArchiveOpen", esta vuelve a cargarse tras filtrar con
"uaArchiveRequery".
Sintaxis
VOID uaArchiveSetFilter (
LPSTR pszFilter )
Parámetros
UAHARCHIVE hArchive
LPSTR pszFilter
Filtro que se debe poner
2.1.43.34 uaArchiveSetSort (RT Professional)
Descripción
Establece la clasificación de la receta. Puede llamar la función de sistema sin abrir la receta
con "uaArchiveOpen".
Nota
Si abre la receta con "uaArchiveOpen", esta vuelve a cargarse tras clasificar con
"uaArchiveRequery".
Sintaxis
BOOL uaArchiveSetSort (

LPSTR pszSort )
Parámetros
UAHARCHIVE hArchive
LPCSTR pszSort
Clasificación
Valor de retorno
TRUE
Se ha activado correctamente la clasificación
FALSE
Error
2.1.43.35 uaArchiveUpdate (RT Professional)
Descripción
Actualiza la receta abierta. Se aplican todas las modificaciones de datos de una receta en la
base de datos. La configuración de la receta permanece inalterada.
Sintaxis
BOOL uaArchiveUpdate (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
actualización correcta de la receta
FALSE
Error "Update_failed" = 106

Este error se produce si se viola la coherencia. Ejemplo: en un campo está fijada la marca "El
campo debe poseer un valor", pero en el campo no existe ningún valor.
2.1.43.36 uaArchiveWriteTagValues (RT Professional)
Descripción
Escribe los valores del registro actual en las variables.
Sintaxis
BOOL uaArchiveWriteTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
LONG* pnFields
LONG cFields
LONG lOptions
Valor de retorno
TRUE
FALSE
Error

2.1.43.37 uaArchiveWriteTagValuesByName (RT Professional)
Descripción
Escribe los valores del registro actual en las variables. El acceso se produce sobre la base
del nombre de la receta y del campo.
Sintaxis
BOOL uaArchiveWriteTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
LPCSTR pszFields
LONG lOptions
Valor de retorno
TRUE
FALSE
Error
2.1.43.38 uaConnect (RT Professional)
Descripción
Establecer conexión con recetas (runtime).

Sintaxis
BOOL uaConnect (
UAHCONNECT* phConnect )
Parámetros
UAHCONNECT* phConnect
Puntero hacia el handle para la receta recién conectada.
Valor de retorno
TRUE
conexión correcta de una receta
FALSE
Error
2.1.43.39 uaDisconnect (RT Professional)
Descripción
En el caso de que haya una conexión con recetas (runtime), ésta se suprime.
Sintaxis
BOOL uaDisconnect (
UAHCONNECT hConnect )
Parámetros
UAHCONNECT hConnect
Handle para la receta conectada (runtime). El handle se crea con uaConnect.
Valor de retorno
TRUE
desacoplamiento correcto de una receta
FALSE
Error

2.1.43.40 uaGetArchive (RT Professional)
Descripción
Lee la configuración de la receta.
Sintaxis
BOOL uaGetArchive (
UAHCONFIG hConfig,
long lArchive,
UACONFIGARCHIVE* pArchive )
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
UACONFIGARCHIVE* pArchive
Puntero hacia el búfer para recibir la configuración de la receta
Valor de retorno
TRUE
acceso correcto a la receta
FALSE
Error
2.1.43.41 uaGetField (RT Professional)
Descripción:
Lee la configuración del campo.
Sintaxis
BOOL uaGetField (

UAHCONFIG hConfig,
long lArchive,
long lField,
UACONFIGFIELD* pField )
Parámetros:
UAHCONFIG hConfig,
long lArchive,
long lField,
El número de campo, donde lField = 0 el primer campo direccionado.
UACONFIGFIELD* pArchive
Puntero sobre el búfer para recibir la configuración del campo
Valor de retorno:
TRUE
Acceso correcto a la receta
FALSE
Error
2.1.43.42 uaGetLastError (RT Professional)
Descripción
Las funciones de sistema del lenguaje Script WinCC devuelven un valor BOOL, donde TRUE
corresponde a una edición sin errores. Si se devuelve FALSE, el error de la última función de
sistema se puede leer con "uaGetLastError()" y "uaGetLastHResult()".
Si no se llama uaGetLastError() hasta después de procesar varias funciones de sistema,
uaGetLastError() devuelve el último error que se haya producido. Para saber con seguridad
la función de sistema en que se ha producido el error, se recomienda llamar "uaGetLastError()"
y "uaGetLastHResult()" cada vez que se devuelva FALSE en una función de sistema.
Ejemplo:
if ( uaArchiveGetFieldValueLong ( hArchive, Index, &IntValue ) ==
TRUE )
printf( "Field Value = %u\n", IntValue );

else
printf("Error calling uaArchiveGetFieldValueLong: %d / %08lx\n",
uaGetLastError(), uaGetLastHResult());
En el caso de funciones de sistema que no devuelven ningún valor de retorno (VOID), se debe
realizar siempre una consulta con uaGetLastError() .
Ejemplo:
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()
Valor de retorno
Estado de fallo de la última función de sistema que se ha ejecutado. uaGetLastError() puede
devolver los siguientes errores:
UA_ERROR_SUCCESS
UA_ERROR_GENERIC
UA_ERROR_CONNECT_FAILED
UA_ERROR_OPEN_FAILED
UA_ERROR_CLOSE_FAILED
UA_ERROR_REQUERY_FAILED
UA_ERROR_MOVE_FAILED
UA_ERROR_INSERT_FAILED
UA_ERROR_UPDATE_FAILED
UA_ERROR_DELETE_FAILED
UA_ERROR_IMPORT_FAILED
UA_ERROR_EXPORT_FAILED
UA_ERROR_READ_FAILED

UA_ERROR_WRITE_FAILED
UA_ERROR_GET_FAILED
UA_ERROR_SET_FAILED
UA_ERROR_INVALID_NAME
UA_ERROR_INVALID_TYPE
UA_ERROR_INVALID_NUMRECS
UA_ERROR_INVALID_COMMTYPE
UA_ERROR_INVALID_LENGTH
UA_ERROR_INVALID_PRECISION
UA_ERROR_NULL_POINTER
UA_ERROR_INVALID_POINTER
UA_ERROR_INVALID_HANDLE
UA_ERROR_INVALID_INDEX
UA_ERROR_SERVER_UNKNOWN
Estas constantes de error y los Predefines de las rutinas de los User Archives están en
CCUACAPI.H.
2.1.43.43 uaGetLastHResult (RT Professional)
Descripción
Lee el último error COM que ha ocurrido. Esta función de sistema sirve sobre todo para
diagnosticar incompatibilidades en la implementación COM utilizada o para encontrar errores
de registro y problemas de comunicación.
En principio, esta función de sistema se debe utilizar adicionalmente a UAGetLastError cuando
una función de sistema del User Archive (p. ej. uaConnect) señaliza un error con "FALSE".
Sintaxis
LONG uaGetLastHResult()
Valor de retorno
Último error COM ocurrido

2.1.43.44 uaGetNumArchives (RT Professional)
Descripción
Lee el número de recetas actualmente configuradas.
Sintaxis
LONG uaGetNumArchives (
UAHCONFIG hConfig )
Parámetros
UAHCONFIG hConfig
Valor de retorno
Número de recetas actualmente configuradas. En caso de error se retorna -1.
2.1.43.45 uaGetNumFields (RT Professional)
Descripción
Lista del número de campos configurados. Los campos "ID", "Último usuario" y "Último acceso"
no se cuentan. En los accesos de configuración se indican los índices con 0 a
uaGetNumFields()-1.
Sintaxis
LONG uaGetNumFields (
UAHCONFIG hConfig,
long lArchive )
Parámetros
UAHCONFIG hConfig,
long lArchive,

Valor de retorno
Cantidad de campos configurados. En caso de error se retorna -1.
2.1.43.46 uaQueryArchive (RT Professional)
Descripción
Establecer conexión con la receta para el modo runtime. UaQueryArchive crea el handle
UAHARCHIVE.
Sintaxis
BOOL uaQueryArchive (
UAHCONNECT hConnect,
LONG lArchive,
UAHARCHIVE* phArchive )
Parámetros
UAHCONNECT hConnect
Handle de la receta conectada (runtime). El handle se crea con uaConnect.
LONG lArchive
ID del fichero que debe conectarse.
UAHARCHIVE* phArchive
Puntero hacia el handle de la receta
Valor de retorno
TRUE
Creación correcta del handle para la receta.
FALSE
Error

Observación
Si se utilizan las funciones de User Archives en un proyecto de cliente que mira a pares de
servidores redundantes, en caso de cambiar de maestro la conexión de User Archives no se
puede conmutar automáticamente al nuevo maestro. En este caso, todas las llamadas de
User Archives envían el LastError UA_ERROR_SERVER_UNKNOWN = 1004, de modo que
los programas de usuario deben ejecutar un nuevo uaQueryArchive() o
uaQueryArchiveByName() y uaArchiveOpen().
2.1.43.47 uaQueryArchiveByName (RT Professional)
Descripción
Establecer conexión con una receta a través del nombre de receta para el modo runtime.
UaQueryArchiveByName crea el handle UAHARCHIVE para la receta.
Sintaxis
BOOL uaQueryArchiveByName (
UAHCONNECT hConnect,
LPCSTR pszName,
UAHARCHIVE* phArchive )
Parámetros
UAHCONNECT hConnect
Handle de la receta conectada (runtime). El handle se crea con uaConnect.
LPCSTR pszName
Nombre de la receta. En el caso de un proyecto de cliente, aquí puede preceder al nombre
de la receta un prefijo de servidor con "::" como separador, en caso de que se utilice un servidor
que no sea el predeterminado.
UAHARCHIVE* phArchive
Puntero hacia el handle de la receta
Valor de retorno
TRUE
creación correcta del handle para la receta
FALSE
Error

Observación
Si se utilizan las funciones de User Archives en un proyecto de cliente que mira a pares de
servidores redundantes, en caso de cambiar de maestro la conexión de User Archives no se
puede conmutar automáticamente al nuevo maestro. En este caso, todas las llamadas de
User Archives envían el LastError UA_ERROR_SERVER_UNKNOWN = 1004, de modo que
los programas de usuario deben ejecutar un nuevo uaQueryArchive() o
uaQueryArchiveByName() y uaArchiveOpen().
2.1.43.48 uaQueryConfiguration (RT Professional)
Descripción
Crea una conexión con la receta para la configuración.
Sintaxis
BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )
Parámetros
UAHCONFIG* phConfig,
Puntero hacia el handle de la receta.
Valor de retorno
TRUE
acceso correcto a la receta
FALSE
Error
2.1.43.49 uaReleaseArchive (RT Professional)
Descripción
Interrumpe la conexión con la receta actual.
Sintaxis
BOOL uaReleaseArchive (

Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
interrupción correcta de la conexión con la receta.
FALSE
Error
Observación
Si el acoplamiento se realiza con éxito, el handle "hArchive" debe ajustarse a "CERO" para
que, si vuelve a utilizarse el handle que ha dejado de ser válido, el error
"UA_ERROR_INVALID_HANDLE" aparezca de inmediato sin que la función en cuestión esté
en vacío en las interfaces COM durante un tiempo prolongado.
2.1.43.50 uaReleaseConfiguration (RT Professional)
Descripción
Interrumpe la conexión con recetas (configuración).
Sintaxis
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )
Parámetros
UAHCONFIG hConfig
BOOL bSave
Modificaciones de configuración seguras antes de interrumpir la conexión con recetas para
la configuración.
TRUE = Guardar modificaciones, FALSE = rechazar modificaciones

2.2 C-bib (RT Professional)
Atención: ¡Guardar modificaciones (bSave = TRUE) sólo puede

realizarse cuando el Runtime no está activo!Accediendo a uaIsActive() puede
comprobar si Runtime está activo.
Valor de retorno
TRUE
interrupción correcta de la conexión
FALSE
Error
2.2.1 Funciones ctype (RT Professional)
Resumen de funciones
Están disponibles las siguientes funciones ctype:
● 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);
En la documentación técnica sobre el lenguaje de programación C existe una descripción de
las funciones ctype.
Las funciones sólo pueden utilizarse en C Scripts.

2.2.2 Grupo de funciones c_bib (RT Professional)
Introducción
El grupo de funciones c_bib contiene funciones C de la biblioteca C y está dividido en:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio está dividido a su vez en:
● char_io
● directio
● error
● file
● file_pos
● output
Encontrará la descripción de estas funciones en la correspondiente documentación técnica.
Particularidades de funciones en WinCC

La función localtime tiene el siguiente comportamiento para la visualización de la fecha:
● El recuento de los meses comienza a partir de "0".
● Los años se cuentan a partir del año 1900, comenzando por 0.
Las funciones de la librería C printf(), sprintf(), fprintf() sólo pueden procesar 360 caracteres
en WinCC.
2.2.3 Funciones math (RT Professional)
Están disponibles las siguientes funciones math:
● double acos (double x);
● double asin (double x);
● double atan (double x);

● double atan2 (double x, double y);

● double ceil (double x);
● double cos (double x);
● double cosh (double x);
● double exp (double x);
● double fabs (double x);
● double floor (double x);
● double fmod (double x, double y);
● double frexp (double x, long int* y);
● double ldexp (double x, long int y);
● double log (double x);
● double log10 (double x);
● double modf (double x, double* y);
● double pow (double x, double y);
● double sin (double x);
● double sinh (double x);
● double sqrt (double x);
● double tan (double x);
● double tanh (double x);
las funciones math.
2.2.4 Funciones memory (RT Professional)
Están disponibles las siguientes funciones memory:
● 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);
las funciones memory.

2.2.5 Funciones multibyte (RT Professional)
Están disponibles las siguientes funciones multibyte:
● 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 )


las funciones multibyte.
2.2.6 Funciones stdio (RT Professional)
Están disponibles las siguientes funciones stdio:
● 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);
las funciones stdio.
2.2.7 Funciones stdlib (RT Professional)
Están disponibles las siguientes funciones stdlib:
● 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);
las funciones stdlib.
2.2.8 Funciones string (RT Professional)
Están disponibles las siguientes funciones string:
● 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);
las funciones string.

2.3 Definición de estructura (RT Professional)
2.2.9 Funciones time (RT Professional)
Están disponibles las siguientes funciones time:
● 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);
● time_t mktime (struct tm* tp);
● time_t time (time_t* tp);
las funciones time.
2.3.1 Definición de estructura CCAPErrorExecute (RT Professional)
typedef struct {
DWORD dwCurrentThreadID; Thread ID of the current thread
DWORD dwErrorCode1; Error code 1
DWORD dwErrorCode2; Error code 2
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the application
char* szFunctionName; Name of the function
char* szTagName; Name of the tag
LPVOID lpParam; Pointer to the action stack
DWORD dwParamSize; Size of the action stack
DWORD dwCycle; Cycle of the variable
CMN_ERROR* pError; Pointer to CMN_ERROR
} CCAPErrorExecute;

Members
El significado de los diferentes identificadores de error y los elementos de estructura
transferidos en función del significado se indican en la siguiente tabla:
100700 0 x x x x x Excepción en la acción

1
100700 1 x x x x x Excepción al acceder al
1 resultado de retorno
100700 4097 x x x x x Desbordamiento de pila
1 al ejecutar la acción
100700 4098 x x x x x División entre 0 en la ac‐
1 ción
100700 4099 x x x x x Acceso a un símbolo no
1 existente en la acción
100700 4100 x x x x x Violación de acceso en la
1 acción
100700 0 x x x Función desconocida
4
100700 1 x x La acción no contiene có‐
5 digo P
100700 2 x x Nombre de función erró‐
5 neo
100700 4 x x x x x El tipo de valor de retorno
5 no es válido
100700 32768f x x x x x Error en Ciss Compiler al
5 f cargar la acción
100700 0 x x x x x x x La variable no está defini‐
6 da
100700 1 x x x x x x x Timeout variable
6
100700 2 x x x x x x x x La variable no puede pro‐
6 porcionarse en el formato
deseado
100700 3 x x x x x x x x La variable notifica viola‐
6 ción de estado, en
CMN_ERROR.dwError1
está el estado
100700 1 x x x x x x Error en PDLRTGetProp
7
100700 2 x x x x x x Error en PDLRTSetProp
7
100700 3 x x x x x x Error en la llamada de DM
7
Estructura de error
La función OnErrorExecute utiliza la estructura de error para la evaluación o la salida de
mensajes de error si así está identificado en la columna pError con una "x".

2.3.2 Definición de estructura CCAPTime (RT Professional)
typedef struct {
DWORD dwCurrentThreadID; ThreadID of the current Thread
DWORD dwCode; Code
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the Application
char* szFunctionName; Name of the Function
LPVOID lpParam; Pointer to the Action-Stack
DWORD dwParamSize; size of the Action-Stack
double dblTime;
DWORD dwFlags; flags
} CCAPTime;
Members
dwCode
El elemento de estructura dwCode proporciona información sobre la llamada de OnTime:
dwCode = 113 Llamada con definición de tiempo para cada acción

dwCode = 114 Llamada con vigilancia de tiempo para cada acción
dwFlags
El elemento de estructura dwFlags proporciona información sobre el tipo de salida:
dwFlags = TRUE La salida de los resultados se realiza en un archivo.

dwFlags = FALSE La salida de los resultados se realiza en la ventana de diálogo.
2.3.3 Definición de estructura CMN_ERROR (RT Professional)
struct CMNERRORSTRUCT {
DWORD dwError1,
DWORD dwError2,
DWORD dwError3,
DWORD dwError4,
DWORD dwError5;
TCHAR szErrorText[MAX_ERROR_LEN];
}
CMN_ERROR

Descripción
En la estructura de error ampliada hay un código de error y un texto de error para el error
ocurrido. Cada aplicación puede utilizar la estructura de error para la evaluación o para la
emisión de avisos de error.
Members
dwError1 .. dwError5
Las funciones API pueden utilizar estas entradas de forma ilimitada.
En las descripciones API se describe en cada caso qué valores contienen las entradas en
caso de error. Si no se indica otra cosa, los códigos de error están en dwError1.
szErrorText
Búfer para la descripción textual de la causa del error
El contenido se determina a partir de los recursos, por lo que varía para cada idioma.
2.3.4 Definición de estructura DM_TYPEREF (RT Professional)
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;
Members
dwType
Especifica el tipo de variable
dwType Tipo de datos PLC Tipo de datos HMI

DM_VARTYPE_BIT Variable binaria Bool
DM_VARTYPE_SBYTE Valor de 8 bits con signo Byte
DM_VARTYPE_BYTE Valor de 8 bits sin signo UByte
DM_VARTYPE_SWORD Valor de 16 bits con signo Short
DM_VARTYPE_WORD Valor de 16 bits sin signo UShort
DM_VARTYPE_SDWORD Valor de 32 bits con signo Integer
DM_VARTYPE_DWORD Valor de 32 bits sin signo UInteger
DM_VARTYPE_FLOAT Número de coma flotante 32 bits IEEE Float
754

dwType Tipo de datos PLC Tipo de datos HMI

DM_VARTYPE_DOUBLE Número de coma flotante 64 bits IEEE Double
754
DM_VARTYPE_TEXT_8 Variable de texto de juego de caracteres Char
de 8 bits
DM_VARTYPE_TEXT_16 Variable de texto de juego de caracteres String
de 16 bits
DM_VARTYPE_RAW Tipo de datos sin formato Raw
DM_VARTYPE_STRUCT Variable de estructura Struct
DM_VARTYPE_TEXTREF Variable de referencia de texto String
dwSize
Indica la longitud del tipo de datos en bytes.
szTypeName
En variables de estructura, contiene el nombre del tipo de estructura
2.3.5 Definición de estructura DM_VAR_UPDATE_STRUCT (RT Professional)
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Members
dmTypeRef
Contiene información sobre el tipo de datos. En solicitudes cíclicas, por motivos de rendimiento
en esta estructura no se registra nada.
dmVarKey
Especifica la variable a editar.
dmValue
Valor de la variable.
En caso de acceso al valor del VARIANT, entre el nombre del VARIANT y el nombre del
miembro debe insertarse una ".u.".
Ejemplo

// Suministrar Variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
Encontrará la descripción del tipo de datos VARIANT en la correspondiente literatura
especializada. VARIANT dmValue debe inicializarse con VariantInit() ante del primer uso y
volver a habilitarse con VariantClear(&dmValue) después del uso. Por eso, la estructura
DM_VAR_UPDATE_STRUCT no puede borrarse con ZeroMemory() o memset().
dwState
Identifica el tipo de la variable.
2.3.6 Definición de estructura DM_VAR_UPDATE_STRUCTEX (RT Professional)
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
Contiene información sobre el tipo de datos. En solicitudes cíclicas, por motivos de rendimiento
en esta estructura no se registra nada.
dmVarKey
Especifica la variable que debe editarse.
dmValue
En caso de accesos al valor del VARIANT, entre el nombre del VARIANT y el nombre del
miembro debe insertarse una ".u.".
Ejemplo
// Suministrar Variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
Encontrará la descripción del tipo de datos VARIANT en la correspondiente documentación
técnica. VARIANT dmValue debe inicializarse con VariantInit() ante del primer uso y volver a

habilitarse con VariantClear(&dmValue) después del uso. Por eso, la estructura

DM_VAR_UPDATE_STRUCTEX no puede borrarse con ZeroMemory() o memset().
dwState
Identifica el estado de la variable.
dwQualityCode
Identifica el QualityCode de la variable.
2.3.7 Definición de estructura DM_VARKEY (RT Professional)
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;
Members
dwKeyType
Indica si debe accederse a la variable a través de un ID clave o de su nombre:
DM_VARKEY_ID especificación a través de ID clave
DM_VARKEY_NAME especificación a través de nombre de variable
dwID
Contiene la ID clave de la variable si dwKeyType está activado en correspondencia
szName
Contiene el nombre de la variable si dwKeyType está activado en correspondencia.
lpvUserData
Puntero en datos específicos de aplicación

2.3.8 Definición de estructura LINKINFO (RT Professional)
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Members
LinkType
LinkType son constantes de enumeración definidas en el archivo "Trigger.h". Deben integrarse
en el script con el comando #include "Trigger.h" y la correspondiente constante de
enumeración.
BUBRT_LT_NOLINK 0 Sin conexión

BUBRT_LT_VARIABLE_DIRECT 1 Variable directa
BUBRT_LT_VARIABLE_INDIRECT 2 Variable indirecta
BUBRT_LT_ACTION 3 Acción C
BUBRT_LT_ACTION_WIZARD 4 Dynamic Dialog
BUB_LT_DIRECT_CONNECTION 5 Conexión directa
BUBRT_LT_ACTION_WIZARD_INPROC 6 Dynamic Dialog
Con la función SetLink sólo pueden utilizarse las constantes de enumeración

BUBRT_LT_VARIABLE_DIREKT y BUBRT_LT_VARIABLE_INDIRECT . Con la función
GetLink pueden obtenerse todas las constantes de enumeración indicadas.
dwCycle
Tiempo de ciclo de la actualización
255 Ciclo de imagen

235 Ciclo de ventana
0 Al cambiar
1 250ms
2 500ms
3 1s
4 2s
5 5s
6 10s
7 1min
8 5min
9 10min

10 1h
11-1 Ciclo de usuario 1-5
5
szLinkName
Nombre de variable
2.3.9 Definición de estructura MSG_FILTER_STRUCT (RT Professional)
typedef struct {
CHAR szFilterName[MSG_MAX_TEXTLEN+1];
WORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNr[2];
DWORD dwMsgClass;
DWORD dwMsgType[MSG_MAX_CLASS];
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
char szTB[MSG_MAX_TB][
MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
Double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
DWORD dwMsgCounter[2];
DWORD dwQuickSelect;
}
MSG_FILTER_STRUCT;
Descripción
Es esta estructura se indican los criterios.
Members
dwFilter
Las condiciones de filtrado se definen a partir del archivo "m_global.h" por medio de las
siguientes constantes:
MSG_FILTER_DATE_FROM Fecha desde

MSG_FILTER_DATE_TO Fecha hasta
MSG_FILTER_TIME_FROM Hora desde
MSG_FILTER_TIME_TO Hora hasta
MSG_FILTER_NR_FROM Número de aviso desde

MSG_FILTER_NR_TO Número de aviso hasta

MSG_FILTER_CLASS Clases de aviso
MSG_FILTER_STATE Estado del aviso
MSG_FILTER_AG_FROM Número PLC desde
MSG_FILTER_AG_TO Número PLC hasta
MSG_FILTER_AGSUB_FROM Subnúmero PLC desde
MSG_FILTER_AGSUB_TO Subnúmero PLC hasta
MSG_FILTER_TEXT Textos de aviso
MSG_FILTER_PVALUE Valores de proceso
MSG_FILTER_COUNTER_FROM Contador de avisos interno desde

MSG_FILTER_COUNTER_TO Contador de avisos interno hasta
MSG_FILTER_PROCESSMSG Avisos de proceso
MSG_FILTER_SYSMSG Avisos de sistema
MSG_FILTER_BEDMSG Avisos de operación
MSG_FILTER_DATE Fecha desde hasta
MSG_FILTER_TIME Hora desde hasta
MSG_FILTER_NR Número de aviso desde hasta
MSG_FILTER_VISIBLEONLY Visualizar avisos visibles
MSG_FILTER_HIDDENONLY Mostrar los avisos ocultados
st
Fecha / hora desde - hasta
st[0] es el instante de inicio (desde), st[1] el instante final (hasta)
Rellene estos campos para los criterios: MSG_FILTER_DATE, MSG_FILTER_DATE_FROM,
MSG_FILTER_DATE_TO, MSG_FILTER_TIME, MSG_FILTER_TIME_FROM, bzw.
MSG_FILTER_TIME_TO
Si se necesita un tiempo actual para la transferencia de un parámetro SYSTEMTIME-, debe
utilizarse la función GetLocalTime y no GetSystemTime. Por lo general, existe una diferencia
de tiempo considerable entre estas dos funciones.
dwMsgNr
Número de aviso desde - hasta
dwMsgNr[0] es el número de inicio (desde), dwMsgNr[1] el número final. (hasta)
Rellene estos campos para los criterios: MSG_FILTER_NR, MSG_FILTER_NR_FROM bzw.
MSG_FILTER_NR_TO
dwMsgClass
Clases de aviso codificadas al bit
Rellene este campo para el criterio: MSG_FILTER_CLASS
dwMsgType
Tipo de aviso por cada clase de aviso, codificado al bit

Rellene este campo para el criterio: MSG_FILTER_CLASS
dwMsgState
Estado de aviso codificado al bit
Rellene este campo para el criterio: MSG_FILTER_STATE
wAGNr
N.º de PLC desde - hasta
Rellene estos campos para los criterios: MSG_FILTER_AG_FROM o bien
MSG_FILTER_AG_TO
wAGSubNr
Sub n.º de PLC desde - hasta
Rellene este campo para los criterios: MSG_FILTER_AGSUB_FROM o bien
MSG_FILTER_AGSUB_TO
dwArchivMode
Archivamiento/Generación de informes
Debe rellenarse con 0.
szTB
Textos de los bloques de texto
Rellene estos campos para el criterio: MSG_FILTER_TEXT
dwTB
Bloques de texto activos (desde - hasta, codificados al bit)
Rellene este campo para el criterio: MSG_FILTER_TEXT
dPValue
Valores de proceso desde - hasta
Rellene estos campos para el criterio: MSG_FILTER_PVALUE
dwPValue
Valores de proceso activos (desde - hasta, codificados al bit)
Rellene este campo para el criterio: MSG_FILTER_PVALUE
dwMsgCounter
Contador de avisos interno desde - hasta
Rellene estos campos para los criterios: MSG_FILTER_COUNTER_FROM,
MSG_FILTER_COUNTER_TO
dwQuickSelect
Selección rápida para hora, día, mes

El parámetro está separado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
Rellene este campo para el criterio: MSG_FILTER_QUICKSELECT
LOWORD tipo:
MSG_FILTER_QUICK_MONTH Selección rápida últimos n meses

MSG_FILTER_QUICK_DAYS Selección rápida últimos n días
MSG_FILTER_QUICK_HOUR Selección rápida últimas n horas
HIWORD número: 1...n

El momento final de la selección rápida se refiere a la hora actual del sistema del ordenador
local. El momento de inicio es n * ( meses, días, horas de retroceso ).
2.3.10 Definición de estructura MSG_RTDATA_STRUCT (RT Professional)
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNr;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL_STRUCT mtTextValue[MSG_MAX_PVALUE];
}
MSG_RTDATA_STRUCT;
Members
dwMsgState
Estado de un aviso
MSG_STATE_COME 0x00000001 El aviso ha aparecido

MSG_STATE_GO 0x00000002 El aviso ha desaparecido
MSG_STATE_QUIT 0x00000003 El aviso ha sido acusado
MSG_STATE_LOCK 0x00000004 Aviso bloqueado
MSG_STATE_UNLOCK 0x00000005 Aviso desbloqueado
MSG_STATE_QUIT_SYSTEM 0x00000010 Aviso acusado por el sistema
MSG_STATE_QUIT_EMERGENCY 0x00000011 Acuse de emergencia
MSG_STATE_QUIT_HORN 0x00000012 Acuse de avisador central
MSG_STATE_COMEGO 0x00000013 Aviso aparecido y desaparecido, sólo en el visor "Avisos ac‐
tuales"
MSG_STATE_UPDATE 0x00010000 Bit para actualización de aviso

MSG_STATE_RESET 0x00020000 Bit para reinicio de aviso

MSG_STATE_SUMTIME 0x00040000 Bit para horario de verano activado
MSG_STATE_INSTANCE 0x00080000 Bit para aviso de instancia (n avisos de un n.º)
dwMsgNr
Número de aviso
stMsgTime
Fecha / hora: Hora de telegrama en función de la función que llama
dwTimeDiff
Duración entrante / tiempo de telegrama en segundos
dwCounter
Contador de avisos interno
dwFlags
Flags de avisos en la base de datos
MSG_FLAG_SUMTIME 0x00000001 Horario de verano activado

MSG_FLAG_COMMENT 0x00000002 El aviso tiene un comentario
MSG_FLAG_ARCHIV 0x00000004 Archivar
MSG_FLAG_PROTOCOL 0x00000008 Generar informe
MSG_FLAG_TEXTVALUES 0x00000010 El aviso tiene valores de consigna de texto
MSG_FLAG_TIMEINVALID 0x00000020 Bit para sello de fecha/hora no válido
MSG_FLAG_INSTANCE 0x00000040 Identificador de avisos de instancia (185269)
wPValueUsed
Valores de proceso utilizados, codificados al bit. Cada bit sólo puede activarse en uno de los
elementos de estructura "wPValueUsed" o "wTextValueUsed". Un valor de consigna puede
ser un número o un texto.
wTextValueUsed
Valores de texto utilizados, codificados al bit. Cada bit sólo puede activarse en uno de los
elementos de estructura "wPValueUsed" o "wTextValueUsed". Un valor asociado puede ser
un número o un texto.


API de runtime (RT Professional) 3
3.1 Runtime API (RT Professional)
Introducción
Runtime API describe la interfaz de programación abierta de WinCC. Las funciones API
permiten utilizar las funciones internas de WinCC en aplicaciones propias y acceder a datos
de variables HMI o a los datos de fichero.
Nota
Siemens no acepta responsabilidad o garantía alguna sobre la compatibilidad de los datos y
la información transferida a través de las interfaces API con software de otros fabricantes.
Hacemos referencia expresa al hecho de que el uso indebido de la interfaz API puede provocar
pérdida de datos o paradas de producción.
Ejemplos:
● MSRTCreateMsgPlus(): Crear aviso
● DMGetValue(): Determinar valor de variable
Requisitos
● Hay un entorno de programación instalado, p. ej. MS Visual Studio
● Está instalado WinCC Runtime Professional.
Utilización
Las funciones API se aplican en los siguientes casos:
● En WinCC: En funciones C definidas por el usuario y C scripts locales.
● Fuera de WinCC: En aplicaciones Windows generadas en el lenguaje de programación C/
C++. Para utilizar Runtime API en los lenguajes de programación C# o VB.net hay que
programar la conversión correspondiente.
Archivos Include y Lib

Para generar código ejecutable se requieren los archivos Include y Lib. Encontrará dichos
archivos en el directorio:
● %ProgramFiles%\SIEMENS\Automation\SCADA-RT_V11\WinCC\include
● %ProgramFiles%\SIEMENS\Automation\SCADA-RT_V11\WinCC\lib

API de runtime (RT Professional)
3.2 Funciones de la gestión de datos (RT Professional)
3.2.1 Principios básicos (RT Professional)
3.2.1.1 Sinopsis de las estructuras (RT Professional)
Sinopsis
DM_CONNECTION_DATA (Página 1586) Datos de conexión

DM_CONNKEY (Página 1587) Listar datos de conexión (estructura de filtro)
DM_CYCLE_INFO (Página 1588) Ciclos de actualización
DM_DATA_SERVICE (Página 1589) Canal de transporte de datos
DM_DIRECTORY_INFO (Página 1590) Nombres de ruta y archivo de los datos de confi‐
guración
DM_DLGOPTIONS (Página 1591) Especificaciones de los cuadros de diálogo
DM_MACHINE_TABLE (Página 1593) Conversión de formato
DM_PROJECT_INFO (Página 1594) Información del proyecto
DM_SD_TARGET_APP (Página 1598) Especificación de aplicaciones
DM_SD_TARGET_MACHINE (Página 1597) Información del equipo
DM_SEND_DATA_STRUCT (Página 1595) Especificación de interlocutores en el intercambio
de datos
DM_TYPEREF (Página 1598) Referencia del tipo de variable
DM_VAR_UPDATE_STRUCTEX (Página 1602) Determinar valores de variables
DM_VAR_UPDATE_STRUCT (Página 1600) Determinar valores de variables
DM_VARFILTER (Página 1605) Selección de variables
DM_VARGRP_DATA (Página 1607) Información sobre un grupo de variables
DM_VARGRPKEY (Página 1608) Especificación de un grupo de variables
DM_VARIABLE_DATA4 (Página 1611) Con información sobre una variable
DM_VARIABLE_DATA (Página 1609) Con información sobre una variable
DM_FORMAT_INFO (Página 1592) Conversión de formato
DM_VARKEY (Página 1614) Especificación de una variable
DM_VARLIMIT (Página 1616) Valores límite de una variable
MCP_NEWVARIABLE_DATA_4 (Página 1620) Definición de una variable
MCP_NEWVARIABLE_DATA_5 (Página 1622) Definición de una variable
MCP_NEWVARIABLE_DATA_EX4 (Pági‐ Definición de una variable
na 1626)
MCP_NEWVARIABLE_DATA_EX (Página 1624) Definición de una variable
MCP_NEWVARIABLE_DATA (Página 1617) Definición de una variable
MCP_VARIABLE_COMMON_EX (Página 1630) Descripción de una variable
MCP_VARIABLE_COMMON (Página 1629) Descripción de una variable
MCP_VARIABLE_LIMITS_EX (Página 1637) Valores límite de una variable
MCP_VARIABLE_LIMITS5 (Página 1635) Valores límite de una variable

MCP_VARIABLE_LIMITS (Página 1633) Valores límite de una variable

MCP_VARIABLE_PROTOCOL_EX (Pági‐ Tratamiento de valores límite de una variable
na 1640)
MCP_VARIABLE_PROTOCOL (Página 1638) Tratamiento de valores límite de una variable
MCP_VARIABLE_SCALES (Página 1641) Escalamiento de una variable
Consulte también
Sinopsis de las funciones (Página 1567)
3.2.1.2 Sinopsis de las funciones (RT Professional)
Sinopsis
DM_ENUM_CYCLES_PROC (Página 1664) Listar ciclos de actualización (Callback)

DM_ENUM_FORMATS_PROC (Página 1661) Listar conversiones de formato (Callback)
DM_NOTIFY_PROC (Página 1654) Función de notificación
DMActivateRTProject (Página 1642) Activar el proyecto
DMChangeDataLocale (Página 1650) Cambio de idioma (informar a aplicaciones)
DMConnect (Página 1651) Establecer conexión con el administrador de datos
DMDeactivateRTProject (Página 1657) Desactivar un proyecto runtime
DMDisconnect (Página 1658) Deshacer conexión con el administrador de datos
DMEnumNumberFormats (Página 1659) Listar conversiones de formato
DMEnumUpdateCycles (Página 1662) Listar ciclos de actualización
DMExitWinCCEx (Página 1666) Finalizar WinCC con valores predeterminados
DMExitWinCC (Página 1665) Finalizar WinCC
DMGetConnectionState (Página 1670) Consultar conexión con el administrador de datos
DMGetHotkey (Página 1672) Determinar ID de tecla de acceso directo
DMGetMachineInfo (Página 1673) Consultar los parámetros de arranque de una apli‐
cación
DMGetMachineTable (Página 1674) Consultar lista de equipos
Consulte también
DMGetDataLocale (Página 1671)
Sinopsis de las estructuras (Página 1564)
Rutinas de conversión (Control Center) (Página 1579)

3.2.1.3 Quality Codes de variables HMI (RT Professional)
Introducción
El Quality Code se necesita para comprobar el estado y la calidad de una variable. En el
Quality Code visualizado se recoge la calidad de toda la transferencia y procesamiento de
valores de la variable HMI correspondiente. De este modo, en el Quality Code se reconoce,
entre otras cosas, si el valor actual es un valor inicial o sustitutivo.
Los Quality Codes están sujetos a prioridades. Si aparecen varios códigos a la vez, se muestra
el peor Quality Code.
Evaluación de los Quality Codes

Existen distintos modos de evaluar el Quality Code:
● Evaluación con funciones VB
● Evaluación con funciones C
● Evaluación con el evento "Quality Code modificado" de un campo E/S
Nota
Para que en las variables de proceso se incluya la transmisión y el procesamiento
completos de los valores en el Quality Code, el Quality Code tiene que ser soportado por
el sistema de automatización conectado. A la hora de configurar las variables PLC en el
AS hay que tener en cuenta el espacio de memoria necesario para el Quality Code. En un
AS de la familia S7, por ejemplo, el Quality Code necesita un byte adicional añadido al
valor de proceso. Para evitar fallos se debe de tener en cuenta en la configuración de una
variable p. ej. al final de un componente de datos.
Estructura
El Quality Code tiene la siguiente estructura binaria:
QQSSSSLL
Q: Calidad
S: Estado Sub de la calidad
L: Límites. Este valor es opcional.
Nota
Los Quality Code representados en la tabla "Calidad" son valores básicos de los niveles de
calidad. Por el uso del estado Sub y Limit se crean valores intermedios por encima del nivel
de calidad correspondiente.

Calidad
Los primeros dos dígitos indican la calidad de las variables.
Q Q S S S S L L
2 2 2 2 2 2 2 2
7 6 5 4 3 2 1 0
Bad - The value is not useful 0 0 - - - - - -

Uncertain - The quality of the value is less than normal, but the value may still 0 1 - - - - - -
be useful.
Good (Non-Cascade) - The quality of the value is good. Possible alarm condi‐ 1 0 - - - - - -
tions may be indicated by the sub-status.
Good (Cascade) - The value may be used in control. 1 1 - - - - - -
Estado Sub
La calidad sola no llega. Sub Stati dividen cada una de las calidades. El Quality Code está
codificado en binario. Para analizar el Quality Code, el valor debe convertirse a su
representación hexadecimal.
Quality Code de variables

En la siguiente tabla se indican los Quality Code realizados. La tabla empieza por el peor
Quality Code y termina por el mejor Quality Code. El mejor Quality Code es el que tiene la
menor prioridad, y el peor Quality Code es el de mayor prioridad. Si en una variable de la
cadena de procesamiento se presentan varios estados al mismo tiempo, se transmite el peor
Code.
Códi‐ Calidad Q Q SSSSL L

go
(Hex)
0x23 Bad Device passivated - Diagnostic alerts inhibited 0 0 1 0 0 0 1 1
0x3F Bad Function check - Local override 0 0 1 1 1 1 1 1
0x1C Bad Out of Service - The value is not reliable because the block is 0 0 0 1 1 1 - -
not being evaluated, and may be under construction by a con‐
figurer. Set if the block mode is O/S.
0x73 Uncertain Simulated value - Start 0 1 1 1 0 0 1 1
0x74 Uncertain Simulated value - End 0 1 1 1 0 1 - -
0x84 Good Active Update event - Set if the value is good and the block 1 0 0 0 0 1 - -
(Non- has an active Update event.
Cascade)
0x24 Bad Maintenance alarm - More diagnostics available. 0 0 1 0 0 1 - -
0x18 Bad No Communication, with no usable value - Set if there has 0 0 0 1 1 0 - -
never been any communication with this value since it was
last "Out of Service".
0x14 Bad No Communication, with last usable value - Set if this value 0 0 0 1 0 1 - -
had been set by communication, which has now failed.
0x0C Bad Device Failure - Set if the source of the value is affected by a 0 0 0 0 1 1 - -
device failure.


go
(Hex)
0x10 Bad Sensor failure 0 0 0 1 0 0 - -
0x08 Bad Not Connected - Set if this input is required to be connected 0 0 0 0 1 0 - -
and is not connected.
0x04 Bad Configuration Error - Set if the value is not useful because 0 0 0 0 0 1 - -
there is some inconsistency regarding the parameterization
or configuration, depending on what a specific manufacturer
can detect.
0x00 Bad non-specific - There is no specific reason why the value is bad. 0 0 0 0 0 0 - -
Used for propagation.
0x28 Bad Process related - Substitute value 0 0 1 0 1 0 - -
0x2B Bad Process related - No maintenance 0 0 1 0 1 0 1 1
0x68 Uncertain Maintenance demanded 0 1 1 0 1 0 - -
0x60 Uncertain Simulated value - Set when the process value is written by the 0 1 1 0 0 0 - -
operator while the block is in manual mode.
0x64 Uncertain Sensor calibration 0 1 1 0 0 1 - -
0x5C Uncertain Configuration error 0 1 0 1 1 1 - -
0x58 Uncertain Sub-normal 0 1 0 1 1 0 - -
0x54 Uncertain Engineering Unit Range Violation - Set if the value lies outside 0 1 0 1 0 1 - -
of the set of values defined for this parameter. The Limits de‐
fine which direction has been exceeded.
0x50 Uncertain Sensor conversion not accurate 0 1 0 1 0 0 - -
0x4B Uncertain Substitute (constant) 0 1 0 0 1 0 1 1
0x78 Uncertain Process related - No maintenance 0 1 1 1 1 0 - -
0x4C Uncertain Initial Value - Value of volatile parameters during and after 0 1 0 0 1 1 - -
reset of the device or of a parameter.
0x48 Uncertain Substitute value - Predefined value is used instead of the cal‐ 0 1 0 0 1 0 - -
culated one. This is used for fail safe handling.
0x44 Uncertain Last Usable Value - Whatever was writing this value has stop‐ 0 1 0 0 0 1 - -
ped doing so. This is used for fail safe handling.
0x40 Uncertain Non-specific - There is no specific reason why the value is 0 1 0 0 0 0 - -
uncertain. Used for propagation.
0xE0 Good Initiate Fail Safe (IFS) - The value is from a block that wants 1 1 1 0 0 0 - -
(Casca‐ its downstream output block (e.g. AO) to go to Fail Safe.
de)
0xD8 Good Local Override (LO) - The value is from a block that has been 1 1 0 1 1 0 - -
(Casca‐ locked out by a local key switch or is a Complex AO/DO with
de) 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 - -
(Casca‐ not be selected, due to conditions in or above the block.
de)
0xCC Good Not Invited (NI) - The value is from a block which does not 1 1 0 0 1 1 - -
(Casca‐ have a target mode that would use this input.
de)


go
(Hex)
0xC8 Good Initialization Request (IR) - The value is an initialization value 1 1 0 0 1 0 - -
(Casca‐ for a source (back calculation input parameter), because the
de) lower loop is broken or the mode is wrong.
0xC4 Good Initialization Acknowledge (IA) - The value is an initialized va‐ 1 1 0 0 0 1 - -
(Casca‐ lue from a source (cascade input, remote-cascade in, and re‐
de) mote-output in parameters).
0xC0 Good OK - No error or special condition is associated with this value. 1 1 0 0 0 0 - -
(Casca‐
de)
0xA0 Good Initiate fail safe 1 0 1 0 0 0 - -
(Non-
Cascade)
0x98 Good Unacknowledged Critical Alarm - Set if the value is good and 1 0 0 1 1 0 - -
(Non- the block has an unacknowledged Alarm with a priority greater
Cascade) than or equal to 8.
0x94 Good Unacknowledged Advisory Alarm - Set if the value is good and 1 0 0 1 0 1 - -
(Non- the block has an unacknowledged Alarm with a priority less
Cascade) than 8.
0x90 Good Unacknowledged Update event - Set if the value is good and 1 0 0 1 0 0 - -
(Non- the block has an unacknowledged Update event.
Cascade)
0x8C Good Active Critical Alarm - Set if the value is good and the block 1 0 0 0 1 1 - -
(Non- has an active Alarm with a priority greater than or equal to 8.
Cascade)
0x88 Good Active Advisory Alarm - Set if the value is good and the block 1 0 0 0 1 0 - -
(Non- has an active Alarm with a priority less than 8.
Cascade)
0xA8 Good Maintenance demanded 1 0 1 0 1 0 - -
(Non-
Cascade)
0xA4 Good Maintenance required 1 0 1 0 0 1 - -
(Non-
Cascade)
0xBC Good Function check - Local override 1 0 1 1 1 1 - -
(Non-
Cascade)
0x80 Good OK - No error or special condition is associated with this value. 1 0 0 0 0 0 - -
(Non-
Cascade)
Límite
Los límites pueden subdividir aún más los Quality Codes. Limits son opcional.
Q Q S S S S L L
O.K. - The value is free to move. - - - - - - 0 0
Low limited - The value has acceded its low limits. - - - - - - 0 1

High limited - The value has acceded its high limits. - - - - - - 1 0

Constant (high and low limited) - The value cannot move, no matter what the - - - - - - 1 1
process does.
Quality Codes en la comunicación con OPC

En una comunicación a través de "OPC" se convierten los Quality Codes no soportados por
OPC.
Quality Codes en WinCC Quality Code según OPC

0x48 0x40
0x4C 0x40
0x5C 0x40
0x60 0x40
0x80...0xD4 0xC0
0xD8 0xC0
Consulte también
SetTag (Página 1473)
GetTag (Página 1413)
3.2.1.4 Propiedad VariableStateType (RT Professional)
Descripción
Devuelve el tipo de supervisión de variables con el que se ha dinamizado una propiedad o un
evento: sin supervisión, Quality Code o estado de variable. Acceso de lectura.
Índice VariableStateType
0 hmiNoVariableState
1 hmiVariableQCState
2 hmiVariableState

Ejemplo
El procedimiento "GetVariableStateType()" lee el tipo de supervisión en el documento actual.
En este ejemplo se indica el tipo de supervisión en un aviso:
Sub GetVariableStateType()
'VBA819
Dim objDyn As HMIDynamicDialog
Set objDyn =
ActiveDocument.Properties("Width").CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'TestVal'")
MsgBox objDyn.VariableStateType
objDyn.Delete
End Sub
Consulte también
Sinopsis de las estructuras (Página 1564)
Rutinas de conversión (Control Center) (Página 1579)
SetTag (Página 1473)
GetTag (Página 1413)
3.2.1.5 Constantes (RT Professional)
Definiciones generales
MAX_DM_OHIO_MACHINES 64 Número máximo de PCs en un proyecto

MAX_DM_OHIO_APPLICATIONS 32 Número máximo de aplicaciones cliente locales
MAX_DM_UPDATE_CYCLES 15 Número máximo de ciclos de actualización
MAX_DM_SYSTEM_CYCLES 10 De ellos, 10 ciclos de sistema
MAX_DM_USER_CYCLES 5 y 5 ciclos de usuario
MAX_DM_VAR_NAME 128 Longitud máxima de un nombre de variable
MAX_DM_TYPE_NAME 128 Longitud máxima del nombre de un tipo de datos
MAX_DM_GROUP_NAME 64 Longitud máxima del nombre de un grupo de variables
MAX_DM_CYCLE_NAME 64 Longitud máxima del texto de un tiempo de ciclo
MAX_DM_FORMAT_NAME 64 Longitud máxima de un requerimiento de formato
MAX_DM_SCALE_NAME 64 Longitud máxima de un requerimiento de escalamien‐
to
MAX_DM_SCALE_PARAM_NAME 64 Longitud máxima de una descripción de parámetros
de escalamiento
MAX_DM_MEMBER_NAME 32 Longitud máxima para miembros de tipos compuestos
MAX_DM_INFOTEXT_LEN 255 Longitud máxima de un texto informativo

MAX_DM_SHIFT_NAME_LEN 32 Longitud máxima de un nombre de turno

MAX_DM_SHIFTS 16 Número máximo de turnos por día
MAX_DM_SHIFT_HOLYDAYS 30 Número máximo de festivos en el horario de turnos
MAX_DM_SHIFT_HOLYNAME 64 Longitud máxima del nombre de un festivo
MAX_DM_SERVICE_NAME 32 Longitud máxima de un nombre de servicio
MAX_DM_APP_NAME 32 Longitud máxima de un nombre de aplicación lóg.
MAX_DM_DSN_NAME 32 Longitud máxima de Data Source Name de la base
de datos
MAX_DM_UNIT_NAME 65 Longitud máxima de una unidad
MAX_DM_CONNECTION_NAME 32 Longitud máxima de una conexión
MAX_DM_VAR_SPECIFIC 25 Longitud máxima de la parte específica de una varia‐
ble en GAPI
MAX_DM_CON_SPECIFIC 128 Longitud máxima de la parte específica de una cone‐
xión en GAPI
MAX_DM_CON_COMMON 128 Longitud máxima de la parte específica de una cone‐
xión en GAPI
MAX_DM_VARTYPE_TEXT_LEN 255 Longitud máxima de una variable de texto
Tipos de variables
DM_VARTYPE_BIT 1 Variable binaria

DM_VARTYPE_SBYTE 2 Valor de 8 bits con signo
DM_VARTYPE_BYTE 3 Valor de 8 bits sin signo
DM_VARTYPE_SWORD 4 Valor de 16 bits con signo
DM_VARTYPE_WORD 5 Valor de 16 bits sin signo
DM_VARTYPE_SDWORD 6 Valor de 32 bits con signo
DM_VARTYPE_DWORD 7 Valor de 32 bits sin signo
DM_VARTYPE_FLOAT 8 Número en coma flotante de 32 bits IEEE 754
DM_VARTYPE_DOUBLE 9 Número en coma flotante de 64 bits IEEE 754
DM_VARTYPE_TEXT_8 10 Variable de texto de juego de caracteres 8 bits
DM_VARTYPE_TEXT_16 11 Variable de texto de juego de caracteres 16 bits
DM_VARTYPE_RAW 12 Tipo de datos sin formato
DM_VARTYPE_STRUCT 14 Variable de estructura
DM_VARTYPE_TEXTREF 18 Referencia de texto de la librería de textos
Flags de propiedad
DM_SIMULATION_MODE 0x00000001 La variable se simula (no hay accesos en

escritura al proceso)
DM_INTERNAL_VAR 0x00000002 Variable interna
DM_EXTERNAL_VAR 0x00000004 Variable externa
DM_HAS_MIN_LIMIT 0x00000008 La variable tiene un límite inferior fijo
DM_HAS_MAX_LIMIT 0x00000010 La variable tiene un límite superior fijo
DM_HAS_DEFAULT_VALUE 0x00000020 La variable tiene valor sustitutivo

DM_HAS_STARTUP_VALUE 0x00000040 La variable tiene valor de inicialización

DM_USE_DEFAULT_ON_STARTUP 0x00000080 Introducir valor sustitutivo al iniciar el siste‐
ma
DM_USE_DEFAULT_ON_MAX 0x00000100 Introducir valor sustitutivo al exceder el lími‐
te superior
DM_USE_DEFAULT_ON_MIN 0x00000200 Introducir valor sustitutivo al exceder el lími‐
te inferior
DM_USE_DE‐ 0x00000400 Valor sustitutivo en caso de error de cone‐
FAULT_ON_COMM_ERROR xión
DM_WRITE_ACCESS_APPLICATION 0x00000800 Las aplicaciones pueden escribir las varia‐
bles
DM_WRITE_ACCESS_PROCESS 0x00001000 La variable puede ser escrita por el proceso
DM_INTERNAL_VAR_LOKAL 0x00002000 Variable interna, actualización 1 = local en
equipo / 0 = en todo el proyecto
DM_INVISIBLE 0x00004000 No mostrar variables del ControlCenter en
la interfaz
DM_EXTERNAL_LOCK 0x00008000 Variable creada externamente y solo borra‐
ble externamente
Flags para generación de informes
DM_NOTIFY_MAX_LIMIT 0x00000001 Entrada en informe al alcanzar el límite su‐

perior
DM_NOTIFY_MIN_LIMIT 0x00000002 Entrada en informe al alcanzar el límite in‐
ferior
DM_NOTIFY_FORMAT_ERROR 0x00000004 Entrada en informe en caso de error de con‐
versión
DM_NOTIFY_ACCESS_FAULT 0x00000008 Entrada en informe en caso de acceso de
escritura no permitido
DM_NOTIFY_APPLICATION_WRITE 0x00000010 Entrada en informe en caso de acceso en
escritura a aplicación
DM_NOTIFY_PROCESS_WRITE 0x00000020 Entrada en informe en caso de acceso en
escritura a proceso
Flags de estado
En runtime puede monitorizarse el estado de distintas variables de WinCC. El estado de la
variable incluye también las violaciones de los límites configurados del rango de medida, así
como el estado de acoplamiento entre WinCC y el sistema de automatización.
El Quality Code indica la calidad de una variable, con independencia de dónde se haya creado
el código. A estos efectos se tiene en cuenta siempre el estado de la transferencia de valores
y el procesamiento de valores completo.
Si, p. ej., se produce una infracción del límite inferior del rango de medida, se emite siempre
el Quality Code "0x55". Esta infracción del rango de medida puede haberse producido en el
administrador de datos de WinCC o en el aparato de campo. El estado de la variable permite
conocer si esta infracción del rango de medida se ha producido en WinCC o antes de la
transferencia del valor a WinCC.

Si, p. ej., el estado de la variable indica una infracción de rango de medida con el código
0x0010, se ha rebasado por defecto el límite de rango configurado en WinCC. Si el estado de
la variable no indica ninguna violación de límite, entonces el Quality Code transferido a WinCC
ya contenía la infracción de límite.
0x0000 Sin errores

DM_VARSTATE_NOT_ESTABLISHED 0x0001 Conexión con el interlocutor no establecida
DM_VARSTATE_HANDSHAKE_ERROR 0x0002 Error de informe
DM_VARSTATE_HARDWARE_ERROR 0x0004 Defecto del módulo/tarjeta de red
DM_VARSTATE_MAX_LIMIT 0x0008 Límite superior configurado rebasado por
exceso
DM_VARSTATE_MIN_LIMIT 0x0010 Límite inferior configurado rebasado por de‐
fecto
DM_VARSTATE_MAX_RANGE 0x0020 Límite de formato rebasado por exceso
DM_VARSTATE_MIN_RANGE 0x0040 Límite de formato rebasado por defecto
DM_VARSTATE_CONVERSION_ERROR 0x0080 Visualización de errores de conversión (en
combinación con DM_VARSTATE_..._RAN‐
GE)
DM_VARSTATE_STARTUP_VALUE 0x0100 Valor de inicialización de la variable
DM_VARSTATE_DEFAULT_VALUE 0x0200 Valor sustitutivo de la variable
DM_VARSTATE_ADDRESS_ERROR 0x0400 Error de direccionamiento en el canal
DM_VARSTATE_INVALID_KEY 0x0800 Variable no encontrada / no existente
DM_VARSTATE_ACCESS_FAULT 0x1000 Acceso a variable no permitido
DM_VARSTATE_TIMEOUT 0x2000 Timeout / ninguna respuesta del canal
DM_VARSTATE_SERVERDOWN 0x4000 El servidor está apagado
Clases de notificación
DM_NOTIFY_CLASS_ERROR 0x00000001 El código de notificación contiene identificador

de error
DM_NOTIFY_CLASS_WARNING 0x00000002 El código de notificación contiene advertencia
DM_NOTIFY_CLASS_DATA 0x00000003 El código de notificación contiene Tipo de datos
Códigos de notificación
DM_NOTIFY_SHUTDOWN 0x00000001 Clase Error: Se finaliza el administrador

de datos
DM_NOTIFY_PROCESSNET_ERROR 0x00000002 Clase Error: Error en bus de procesos
DM_NOTIFY_SYSNET_ERROR 0x00000003 Clase Error: Error en bus de sistema
DM_NOTIFY_QUEUE_50_PERCENT 0x00000001 Clase Warning: Nivel de llenado de la co‐
la de aplicación 50%


DM_NOTIFY_QUEUE_OVERFLOW 0x00000006 Clase Warning: Desbordamiento de la co‐
la de aplicación
DM_NOTIFY_CYCLES_CHANGED 0x00000010 Clase Warning => volver a leer ciclos
DM_NOTIFY_MACHINES_CHANGED 0x00000011 Clase Warning, lista de equipos
DM_NOTIFY_PROJECT_OPENED 0x00000012 Clase Warning, el proyecto se está car‐
gando
DM_NOTIFY_PROJECT_CLOSED 0x00000013 Clase Warning, el proyecto se está ce‐
rrando
DM_NOTIFY_SYSTEM_LOCALE 0x00000014 Realizar un cambio de idioma (recursos)
DM_NOTIFY_DATA_LOCALE 0x00000015 Realizar un cambio de idioma (datos de
configuración)
DM_NOTIFY_PROJECT_RUNTIME 0x00000016 Proyecto activado en modo runtime
DM_NOTIFY_PROJECT_EDIT 0x00000017 Modo runtime desactivado para el proyec‐
to
DM_NOTIFY_HOTKEY_CHANGE 0x00000018 The Hotkeys have changed
DM_NOTIFY_APPLICATION_DATA 0x00000001 Clase Data: Datos enviados por la aplica‐
ción
DM_NOTIFY_VARIABLE_DATA 0x00000002 Clase Data: Datos de variables
DM_NOTIFY_SERVERDOWN 0x00000022 El servidor está apagado
DM_NOTIFY_SERVERUP 0x00000023 El servidor está operativo
Tipo de equipo
Tipo de equipo 0 Servidor

1 Cliente
Mensajes registrados
DM_OHIOLANGUAGE "WM_OHIOLANGUAGE"
Variables de sistema internas

DM_VAR_CURRENT_LANGUAGE "OHIOCurrentLanguage"
Consulte también

3.2.1.6 Mensajes de error (RT Professional)
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
DM_E_SYS_ERROR 0x10000000 Si en dwError1 de la estructura de

error CMN_ERROR está activado
este bit, dwError2 contiene el código
de error de sistema.
DM_E_OK 0x00000000 Ningún error
DM_E_CANCEL 0x00000001 El usuario ha seleccionado "Cance‐
lar" en un cuadro de diálogo
DM_E_FILE 0x00000002 Error en la operación con archivos
DM_E_UPDATE 0x00000003 El proyecto se está actualizando
DM_E_NO_RT_PRJ 0x00000004 Ningún proyecto en modo runtime
DM_E_NOT_SUPPORTED 0x00000005 Servicio solicitado no disponible
DM_E_ALREADY_CONNECTED 0x00000006 La conexión con el administrador de
datos ya existe
DM_E_NOT_CONNECTED 0x00000007 Sin conexión con el administrador de
datos
DM_E_INVALID_TAID 0x00000008 ID de transacción no válida
DM_E_INVALID_KEY 0x00000009 Variable no encontrada
DM_E_INVALID_TYPE 0x0000000A Tipo de variable no válido
DM_E_MAX_LIMIT 0x0000000B Límite superior de la variable reba‐
sado por exceso
DM_E_MIN_LIMIT 0x0000000C Límite inferior de la variable rebasa‐
do por defecto
DM_E_MAX_RANGE 0x0000000D Límite superior de la conversión de
formato rebasado por exceso
DM_E_MIN_RANGE 0x0000000E Límite inferior de la conversión de
formato rebasado por defecto
DM_E_ACCESS_FAULT 0x0000000F Acceso en escritura a una variable
no permitido
DM_E_TIMEOUT 0x00000010 Error de timeout
DM_E_ALREADY_EXIST 0x00000011 El objeto que hay que crear ya existe
DM_E_PARAM 0x00000012 Parámetro no válido
DM_E_INV_PRJ 0x00000013 El proyecto indicado no se ha encon‐
trado/cargado
DM_E_UNKNOWN 0x00000014 Error desconocido
DM_E_OOM 0x00000015 No hay más memoria libre disponible
DM_E_NOT_CREATED 0x00000016 No se ha podido generar el proyecto
DM_E_MACHINE_NOT_FOUND 0x00000017 Equipo no encontrado
DM_E_NO_INFO_FOUND 0x00000018 No se ha encontrado información de
arranque
DM_E_INTERNAL 0x00000019 Error de procesamiento interno

DM_E_INVALID_LOCALE 0x0000001A ID local errónea

DM_E_COMMUNICATION 0x0000001B ID local errónea
DM_E_DONT_EXIST 0x0000001C El objeto no existe
p. ej.: Se ha intentado crear una va‐
riable pero la conexión indicada no
existe
DM_E_ALREADY_ACTIVATED 0x0000001D El proyecto se encuentra en modo
runtime
p. ej.: Si se intenta activar un proyec‐
to que ya se encuentra en modo run‐
time.
DM_E_NO_OPEN_PROJECT 0x0000001E No hay ningún proyecto abierto
DM_E_ALREADY_DEACTIVATED 0x0000001F El proyecto no se encuentra en mo‐
do runtime
DM_E_NO_RIGHTS 0x00000020 Transferida CreatorID errónea
DM_E_NOT_DELETED 0x00000021 No se ha podido borrar el objeto
DM_E_LICENSE 0x00000022 Protección de software: ninguna li‐
cencia
DM_E_LICENSE_LIMIT 0x00000023 Protección de software: Límite alcan‐
zado/rebasado
DM_E_INVALID_OBJECTTYPE 0x00000024 Tipo de objeto no válido
DM_E_OP_REQUIERES_PRJEDITMODE 0x00000025 El proyecto se encuentra en modo
runtime
p. ej.: La operación requiere que el
proyecto no esté activado.
DM_E_INTERFACE 0x00000026 Error interno al acceder a interfaces
DM_E_UNIT_NOT_FOUND 0x00000027 Unit no encontrada
DM_E_CONNECTION_NOT_FOUND 0x00000028 Connection no encontrada
Consulte también
CMN_ERROR (Página 2535)
3.2.1.7 Rutinas de conversión (Control Center) (RT Professional)
Sinopsis
N.° Rutinas de conversión para el tipo de datos "Valor de 8 bits con signo"
0 CharToSignedByte
1 CharToUnsignedByte
2 CharToUnsignedWord
3 CharToUnsignedDword
4 CharToSignedWord
5 CharToSignedDword
6 CharToMSBByte
7 CharToMSBWord

8 CharToMSBDword
9 CharToBCDByte
10 CharToBCDWord
11 CharToBCDDword
12 CharToSignedBCDByte
13 CharToSignedBCDWord
14 CharToSignedBCDDword
15 CharToExtSignedBCDByte
16 CharToExtSignedBCDWord
17 CharToExtSignedBCDDword
18 CharToAikenByte
19 CharToAikenWord
20 CharToAikenDword
21 CharToSignedAikenByte
22 CharToSignedAikenWord
23 CharToSignedAikenDword
24 CharToExcessByte
25 CharToExcessWord
26 CharToExcessDword
27 CharToSignedExcessByte
28 CharToSignedExcessWord
29 CharToSignedExcessDword
> 29 (CharToSignedByte)
N.° Rutinas de conversión para el tipo de datos "Valor de 8 bits sin signo"
0 ByteToUnsignedByte
1 ByteToUnsignedWord
2 ByteToUnsignedDword
3 ByteToSignedByte
4 ByteToSignedWord
5 ByteToSignedDword
6 ByteToBCDByte
7 ByteToBCDWord
8 ByteToBCDDword
9 ByteToAikenByte
10 ByteToAikenWord
11 ByteToAikenDword
12 ByteToExcessByte
13 ByteToExcessWord
14 ByteToExcessDword
> 14 (ByteToUnsignedByte)

N.° Rutinas de conversión para el tipo de datos "Valor

de 16 bits con signo"
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)

de 16 bits sin signo"
0 WordToUnsignedWord
1 WordToUnsignedByte
2 WordToUnsignedDword
3 WordToSignedByte
4 WordToSignedWord
5 WordToSignedDword
6 WordToBCDByte

7 WordToBCDWord
8 WordToBCDDword
9 WordToAikenByte
10 WordToAikenWord
11 WordToAikenDword
12 WordToExcessByte
13 WordToExcessWord
14 WordToExcessDword
15 WordToSimaticBCDCounter
16 WordToSimaticCounter
> 16 (WordToUnsignedWord)

de 32 bits con signo"
0 LongToSignedDword
1 LongToUnsignedByte
2 LongToUnsignedWord
3 LongToUnsignedDword
4 LongToSignedByte
5 LongToSignedWord
6 LongToMSBByte
7 LongToMSBWord
8 LongToMSBDword
9 LongToBCDByte
10 LongToBCDWord
11 LongToBCDDword
12 LongToSignedBCDByte
13 LongToSignedBCDWord
14 LongToSignedBCDDword
15 LongToExtSignedBCDByte
16 LongToExtSignedBCDWord
17 LongToExtSignedBCDDword
18 LongToAikenByte
19 LongToAikenWord
20 LongToAikenDword
21 LongToSignedAikenByte
22 LongToSignedAikenWord
23 LongToSignedAikenDword
24 LongToExcessByte
25 LongToExcessWord
26 LongToExcessDword
27 LongToSignedExcessByte
28 LongToSignedExcessWord

29 LongToSignedExcessDword
30 LongToSimaticBCDTimer
31 (LongToSignedDword)
34 LongToSimaticTimer
> 34 (LongToSignedDword)

de 32 bits sin signo"
0 DwordToUnsignedDword
1 DwordToUnsignedByte
2 DwordToUnsignedWord
3 DwordToSignedByte
4 DwordToSignedWord
5 DwordToSignedDword
6 DwordToBCDByte
7 DwordToBCDWord
8 DwordToBCDDword
9 DwordToAikenByte
10 DwordToAikenWord
11 DwordToAikenDword
12 DwordToExcessByte
13 DwordToExcessWord
14 DwordToExcessDword
15 DwordToSimaticBCDTimer
16 (DwordToUnsignedDword)
19 DwordToSimaticTimer
> 19 (DwordToUnsignedDword)
N.° Rutinas de conversión para el tipo de datos "Nú‐

mero en coma flotante de 32 bits IEEE 754"
0 FloatToFloat
1 FloatToUnsignedByte
2 FloatToUnsignedWord
3 FloatToUnsignedDword
4 FloatToSignedByte
5 FloatToSignedWord
6 FloatToSignedDword
7 FloatToDouble

8 FloatToMSBByte
9 FloatToMSBWord
10 FloatToMSBDword
11 FloatToBCDByte
12 FloatToBCDWord
13 FloatToBCDDword
14 FloatToSignedBCDByte
15 FloatToSignedBCDWord
16 FloatToSignedBCDDword
17 FloatToExtSignedBCDByte
18 FloatToExtSignedBCDWord
19 FloatToExtSignedBCDDword
20 FloatToAikenByte
21 FloatToAikenWord
22 FloatToAikenDword
23 FloatToSignedAikenByte
24 FloatToSignedAikenWord
25 FloatToSignedAikenDword
26 FloatToExcessByte
27 FloatToExcessWord
28 FloatToExcessDword
29 FloatToSignedExcessByte
30 FloatToSignedExcessWord
31 FloatToSignedExcessDword
32 FloatToSimaticBCDTimer
33 (FloatToFloat)
34 (FloatToFloat)
35 (FloatToFloat)
36 FloatToS5Float
37 FloatToSimaticTimer
> 37 (FloatToFloat)
N.° Rutinas de conversión para el tipo de datos "Nú‐

mero en coma flotante de 64 bits IEEE 754"
0 DoubleToDouble
1 DoubleToUnsignedByte
2 DoubleToUnsignedWord
3 DoubleToUnsignedDword
4 DoubleToSignedByte
5 DoubleToSignedWord
6 DoubleToSignedDword
7 DoubleToFloat
8 DoubleToMSBByte

9 DoubleToMSBWord
10 DoubleToMSBDword
11 DoubleToBCDByte
12 DoubleToBCDWord
13 DoubleToBCDDword
14 DoubleToSignedBCDByte
15 DoubleToSignedBCDWord
16 DoubleToSignedBCDDword
17 DoubleToExtSignedBCDByte
18 DoubleToExtSignedBCDWord
19 DoubleToExtSignedBCDDword
20 DoubleToAikenByte
21 DoubleToAikenWord
22 DoubleToAikenDword
23 DoubleToSignedAikenByte
24 DoubleToSignedAikenWord
25 DoubleToSignedAikenDword
26 DoubleToExcessByte
27 DoubleToExcessWord
28 DoubleToExcessDword
29 DoubleToSignedExcessByte
30 DoubleToSignedExcessWord
31 DoubleToSignedExcessDword
32 DoubleToSimaticBCDTimer
33 (DoubleToDouble)
34 (DoubleToDouble)
35 (DoubleToDouble)
36 DoubleToS5Float
37 DoubleToSimaticTimer
> 37 (DoubleToDouble)
Consulte también

3.2.2 Estructuras (RT Professional)
3.2.2.1 DM_CONNECTION_DATA (RT Professional)
Declaración
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
Nombre de la conexión lógica
szUnitName
Nombre de la unidad de canal
szCommon
El parámetro está reservado para ampliaciones posteriores.
szSpecific
szSpecific contiene el parámetro de dirección de la conexión, p. ej., dirección Ethernet, número
de slot.... Consulte la información específica del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
dwVarNum
Número de variables asignadas
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_CONNECTION_PROC (Pági‐ Listar datos de conexión (Callback)

na 1820)

Consulte también
DM_ENUM_CONNECTION_PROC (Página 1820)
3.2.2.2 DM_CONNKEY (RT Professional)
Declaración
typedef struct {
CHAR szName[ MAX_DM_CONNECTION_NAME + 1 ];
LPVOID lpvUserData;
}
DM_CONNKEY;
Members
szName
Nombre de la conexión lógica
lpvUserData
Puntero a datos específicos de aplicación
Archivos necesarios
dmclient.h
Funciones API
DMEnumConnectionData (Página 1817) Listar datos de conexión
Consulte también
DMEnumConnectionData (Página 1817)

3.2.2.3 DM_CYCLE_INFO (RT Professional)
Declaración
typedef struct {
DWORD dwCycleTime;
DWORD dwCycleIndex;
char szDescription[ MAX_DM_CYCLE_NAME + 1 ];
}
DM_CYCLE_INFO;
Members
dwCycleTime
Base de tiempo del ciclo de actualización
dwCycleIndex
Identifica el orden dentro de la lista del ciclo de actualización.
"Al cambiar" Índice: 0

"250 ms" Índice: 1
: :
"Ciclo de usuario 5" Índice: 15
szDescription
Nombre del ciclo de actualización.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_ENUM_CYCLES_PROC (Página 1664)

3.2.2.4 DM_DATA_SERVICE (RT Professional)
Declaración
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
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
szService
Nombre del canal de transporte de datos. Este nombre corresponde al asignado durante la
instalación del servicio (DMInstallDataService).
szSendingApp
Nombre lógico del remitente. Este nombre corresponde al nombre de aplicación asignado en
DMConnect
dwSendingMachine
Índice del equipo desde el que se ha enviado el paquete (0 - .63). Para las funciones API se
puede acceder a todos los equipos registrados en la lista de equipos a través de su índice.
La primera entrada de la lista de equipos tiene el índice "0".
dwDataSize
Tamaño en bytes del paquete de datos: Data[0] ... byData[dwDataSize - 1]
byData
Puntero a los datos
Archivos necesarios
dmclient.h

Funciones API
DM_DATA_SERVICE_PROC (Página 1692) Listar canales de transporte de datos (Callback),

instalar canal de transporte de datos (Callback)
Consulte también
DM_DATA_SERVICE_PROC (Página 1692)
3.2.2.5 DM_DIRECTORY_INFO (RT Professional)
Declaración
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
Indicación completa de la ruta del directorio del proyecto, p. ej., D:\WinCC\Projekt1
szProjectAppDir
Indicación completa de la ruta del subdirectorio de la aplicación en el directorio del proyecto,
p. ej.: D:\WinCC\Projekt1\GraCS
szGlobalLibDir
Indicación completa de la ruta del directorio de librerías de todo el proyecto, p. ej.: D:\WinCC
\aplib
szProjectLibDir
Indicación completa de la ruta del directorio de la librería relacionada con el proyecto, p. ej.,
D:\WinCC\Projekt1\Library
szLokalProjectAppDir
Indicación completa de la ruta del subdirectorio de la aplicación en el directorio del proyecto
del equipo local.
Archivos necesarios
dmclient.h

Funciones API
DMGetProjectDirectory (Página 1681) Determinar los nombres de ruta y archivo de los

datos de configuración
Consulte también
DMGetProjectDirectory (Página 1681)
3.2.2.6 DM_DLGOPTIONS (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
LPRECT lprcPreference;
DM_TEST_DROP_TARGET_PROC lpfnTestDropTarget;
DM_DROP_TARGET_PROC lpfnDropTarget;
LPVOID lpvUser;
}
DM_DLGOPTIONS;
Members
dwFlags
dwFlags define el comportamiento del diálogo o del cuadro de diálogo:
DM_DLG_NOT_MODAL El cuadro de diálogo de variables no es modal.

DM_DLG_NOT_MOVEABLE El cuadro de diálogo no se puede desplazar.
DM_DLG_DRAGDROP Los objetos del cuadro de diálogo se pueden edi‐
tar con la función de arrastrar y soltar.
lprcPreference
Puntero a una estructura del tipo RECT con información relativa al tamaño del cuadro de
diálogo. Si lprcPreference == NULL, el cuadro de diálogo aparece centrado y con un tamaño
predefinido.
lpfnTestDropTarget
El parámetro está reservado para posteriores ampliaciones y se debe inicializar con NULL.
lpfnDropTarget
lpvUser
Puntero a datos específicos de la aplicación.

Archivos necesarios
dmclient.h
Funciones API
DMShowVarDatabase (Página 1783) Abrir cuadro de diálogo de selección de variables

DMShowVarDatabaseMulti (Página 1788) Abrir cuadro de diálogo de selección de variables
Consulte también
DMShowVarDatabase (Página 1783)
DMShowVarDatabaseMulti (Página 1788)
3.2.2.7 DM_FORMAT_INFO (RT Professional)
Declaración
typedef struct {
DWORD dwID;
char szName[MAX_DM_FORMAT_NAME + 1];
}
DM_FORMAT_INFO;
Members
dwID
Número de rutinas de conversión que hay que utilizar. Encontrará más información en el
apartado "Rutinas de conversión".
szName
Nombre de las rutinas de conversión que hay que utilizar. Encontrará más información en el
Archivos necesarios
dmclient.h
Funciones API

Consulte también
DM_ENUM_FORMATS_PROC (Página 1661)
3.2.2.8 DM_MACHINE_TABLE (RT Professional)
Declaración
typedef struct {
LONG nNumMachines;
LONG nLocalMachine;
DM_SD_TARGET_MACHINE tm[MAX_DM_OHIO_MACHINES];
}
DM_MACHINE_TABLE;
Members
nNumMachines
Número de equipos en el proyecto (no debe exceder la cantidad máxima
MAX_DM_OHIO_MACHINES).
nLocalMachine
Índice de la entrada del equipo local en la lista de equipos.
Para las funciones API se puede acceder a todos los equipos registrados en la lista de equipos
a través de su índice. La primera entrada de la lista de equipos tiene el índice "0".
tm
Matriz completa de tipo DM_SD_TARGET_MACHINE (Página 1597) con información de los
equipos implicados en el proyecto. No obstante, sólo se transfieren nNumMachines de estas
estructuras (para lo que, como máximo se puede utilizar un índice = (nMumMachines - 1) ).
Archivos necesarios
dmclient.h
Funciones API
DMGetMachineTable (Página 1674) Consultar lista de equipos
Consulte también
DM_SD_TARGET_MACHINE (Página 1597)
DMGetMachineTable (Página 1674)

3.2.2.9 DM_PROJECT_INFO (RT Professional)
Declaración
typedef struct {
char szProjectFile[ _MAX_PATH + 1 ];
char szDSNName[ MAX_DM_DSN_NAME + 1 ];
DWORD dwDataLocale;
}
DM_PROJECT_INFO;
Members
szProjectFile
Nombre de archivo del proyecto, ruta y extensión incluidas.
szDSNName
Data Source Name de la base de datos
dwDataLocale
Código del idioma que se utiliza en la configuración.
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_OPENED_PROJECTS_PROC (Pági‐ Listar proyectos (abiertos) (Callback)

na 1679)
DMEnumOpenedProjects (Página 1678) Determinar información del proyecto
Consulte también
DM_ENUM_OPENED_PROJECTS_PROC (Página 1679)
DMEnumOpenedProjects (Página 1678)
DMGetProjectInformation (Página 1682)

3.2.2.10 DM_SEND_DATA_STRUCT (RT Professional)
Declaración
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 indica la prioridad con la que debe efectuarse el intercambio de datos:
1 Prioridad alta
0 Prioridad normal
szService
Nombre del servicio que se debe utilizar. Para que una aplicación pueda recibir datos, no
basta con que tenga la condición dwTargetMachineFlags, sino que también debe tener
instalado el correspondiente servicio con DMInstallDataService.
dwTargetMachineFlags
dwTargetMachineFlags indica las aplicaciones a las que deben enviarse datos con la función
DMSendApplicationData.
DM_SD_LOCAL Sólo a aplicaciones locales (excluye todos los demás indica‐

dores)
Actualmente no se admite ninguno de los demás indicadores
y quedan reservados para futuras ampliaciones.
DM_SD_ALL_MACHINES A todos los equipos del proyecto.
(El parámetro está reservado para ampliaciones posteriores)
DM_SD_ALL_SERVERS A todos los servidores del proyecto.
DM_SD_ALL_CLIENTS A todos los clientes del proyecto.

DM_SD_RELATED_MACHINES A todos los clientes que pertenecen al mismo servidor que el

equipo local
DM_SD_FIRST_SERVER (El parámetro está reservado para ampliaciones posteriores)
DM_SD_PRIMARY_SERVER (El parámetro está reservado para ampliaciones posteriores)
DM_SD_EXCEPT_LOCAL A todos los equipos, excepto los locales, que satisfacen la des‐
cripción de la dirección.
dwTargetMachines
Número de estructuras ocupadas en dmTargetMachine.
Reservado para futura ampliación y debe estar ocupado por 0.
dmTargetMachine
Puntero a la estructura DM_SD_TARGET_MACHINE (Página 1597) para especificar el equipo
al que deben enviarse los datos. Sólo tiene importancia el parámetro szMachineName.
Reservado para futura ampliación y debe inicializarse totalmente con 0L.
dwTargetApps
Número de estructuras ocupadas en dmTargetApp.
dmTargetApp
Las estructuras de tipo DM_SD_TARGET_APP (Página 1598) contienen el nombre de las
aplicaciones a las que deben enviarse los datos.
dwDataSize
Tamaño en bytes de los datos que hay que transmitir
byData
Matriz que contiene los datos que hay que transmitir
Observaciones
La función DMSendApplicationData sólo se implementa localmente.
Los miembros existentes en esta estructura para acceso remoto están reservados para futura
ampliación.
dwTargetMachineFlags sólo puede ocuparse con DM_SD_LOCAL; cualquier otra información
produce errores y dwTargetMachines debe ser 0L.
Archivos necesarios
dmclient.h
Funciones API
DMSendApplicationData (Página 1696) Intercambio de datos con aplicaciones

Consulte también
DMSendApplicationData (Página 1696)
DM_SD_TARGET_MACHINE (Página 1597)
DM_SD_TARGET_APP (Página 1598)
3.2.2.11 DM_SD_TARGET_MACHINE (RT Professional)
Declaración
typedef struct {
BOOL fServer;
BOOL fLocal;
char szMachineName[
MAX_COMPUTERNAME_LENGTH + 1];
}
DM_SD_TARGET_MACHINE;
Members
fServer
Indica si el equipo es servidor o cliente.
El parámetro es irrelevante para el intercambio de datos (DM_SEND_DATA_STRUCT).
fLocal
Indica si la aplicación que realiza la consulta utiliza el equipo local u otro equipo configurado
en la red.
El parámetro es irrelevante para el intercambio de datos (DM_SEND_DATA_STRUCT).
szMachineName
Nombre del equipo
Observaciones
DM_SD_TARGET_MACHINE forma parte de las estructuras DM_MACHINE_TABLE
(Página 1591) y DM_SEND_DATA_STRUCT (Página 1593).
Archivos necesarios
dmclient.h

Consulte también
DM_MACHINE_TABLE (Página 1591)
DM_SEND_DATA_STRUCT (Página 1593)
3.2.2.12 DM_SD_TARGET_APP (RT Professional)
Declaración
typedef struct {
char szAppName[MAX_DM_APP_NAME + 1];
}
DM_SD_TARGET_APP;
Members
szAppName
Utilice para szAppName el nombre de la aplicación utilizado en la llamada de DMConnect.
Observaciones
DM_SD_TARGET_APP forma parte de la estructura DM_SEND_DATA_STRUCT
(Página 1593).
Archivos necesarios
dmclient.h
Consulte también
3.2.2.13 DM_TYPEREF (RT Professional)
Declaración
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;

Members
dwType
En dwType se especifica el tipo de variable:
DM_VARTYPE_BIT Variable binaria

DM_VARTYPE_SBYTE Valor de 8 bits con signo
DM_VARTYPE_BYTE Valor de 8 bits sin signo
DM_VARTYPE_SWORD Valor de 16 bits con signo
DM_VARTYPE_WORD Valor de 16 bits sin signo
DM_VARTYPE_SDWORD Valor de 32 bits con signo
DM_VARTYPE_DWORD Valor de 32 bits sin signo
DM_VARTYPE_FLOAT Coma flotante de 32 bits IEEE 754
DM_VARTYPE_DOUBLE Coma flotante de 64 bits IEEE 754
DM_VARTYPE_TEXT_8 Variable de texto de juego de caracteres 8 bits
DM_VARTYPE_RAW Tipo de datos sin formato
DM_VARTYPE_STRUCT Variable de estructura
DM_VARTYPE_TEXTREF Referencia de texto de la librería de textos
Valores >=1024 Tipos de estructura definidos por el usuario
Esta ID de tipo es necesaria en algunas llamadas, p. ej., durante
el filtrado, para identificar un tipo de estructura específica.
dwSize
En dwSize se indica la longitud (en bytes) del tipo de datos en el OS.
szTypeName
En szTypeName el nombre del tipo de estructura está en variables de estructura.
Observaciones
DM_TYPEREF se utiliza dentro de las estructuras DM_VAR_UPDATE_STRUCT
(Página 1600) y DM_VARIABLE_DATA (Página 1609).
Archivos necesarios
dmclient.h
Funciones API
DMGetVarType (Página 1752) Determinar el tipo de datos de una variable

Consulte también
DM_VAR_UPDATE_STRUCT (Página 1600)
DMGetVarType (Página 1752)
DM_VARIABLE_DATA (Página 1609)
DM_VAR_UPDATE_STRUCTEX (Página 1602)
DM_VARIABLE_DATA4 (Página 1611)
3.2.2.14 DM_VAR_UPDATE_STRUCT (RT Professional)
Declaración
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Members
dmTypeRef
La estructura DM_TYPEREF (Página 1596) contiene información sobre el tipo de variable.
Excepción: En solicitudes cíclicas, por motivos de rendimiento en esta estructura no se registra
nada.
dmVarKey
Con la estructura DM_VARKEY (Página 1614) se especifica la variable que debe procesarse.

dmValue
Nota
VARIANT dmValue debe inicializarse con VariantInit(&dmValue) antes del primer uso y volver
a habilitarse con VariantClear(&dmValue) después del uso.
Solo se puede preinicializar antes del primer uso una matriz de varias
DM_VAR_UPDATE_STRUCT con ZeroMemory() o memset(). Esto tiene efecto en la
VARIANT dmValue aquí contenida como una VariantInit(&dmValue), puesto que 0 equivale
a VT_EMPTY.
La estructura DM_VAR_UPDATE_STRUCT no se puede borrar con ZeroMemory() o memset()
si ya se ha utilizado una vez. Entonces VARIANT contiene datos que también pueden ser de
tipo VT_BSTR.
Si el tipo de variante es VT_BSTR surgen problemas con la administración de memoria
(MemoryLeak) si no se efectúa un VariantClear(&dmValue) antes, p. ej., de borrar estructuras
asignadas DM_VAR_UPDATE_STRUCT con delete[]
(0x0000) Ningún error

DM_VARSTATE_NOT_ESTABLISHED (0x0001) Conexión con el interlocutor no esta‐
blecida
DM_VARSTATE_HANDSHAKE_ERROR (0x0002) Error de protocolo
DM_VARSTATE_HARDWARE_ERROR (0x0004) Defecto del módulo/tarjeta de red
DM_VARSTATE_MAX_LIMIT (0x0008) Límite superior configurado excedido
DM_VARSTATE_MIN_LIMIT (0x0010) Límite inferior configurado no alcan‐
zado
DM_VARSTATE_MAX_RANGE (0x0020) Límite de formato excedido
DM_VARSTATE_MIN_RANGE (0x0040) Límite de formato no alcanzado
DM_VARSTATE_CONVERSION_ERROR (0x0080) Visualización de errores de conver‐
sión (en relación con DM_VARSTA‐
TE_..._RANGE)
DM_VARSTATE_STARTUP_VALUE (0x0100) Valor de inicialización de la variable
DM_VARSTATE_DEFAULT_VALUE (0x0200) Valor sustitutivo de la variable
DM_VARSTATE_ADDRESS_ERROR (0x0400) Error de direccionamiento en el canal
DM_VARSTATE_INVALID_KEY (0x0800) Variable no encontrada / no existente
DM_VARSTATE_ACCESS_FAULT (0x1000) Acceso a variable no permitido
DM_VARSTATE_TIMEOUT (0x2000) Timeout / ninguna respuesta del ca‐
nal
DM_VARSTATE_SERVERDOWN (0x4000) El servidor está apagado
Archivos necesarios
dmclient.h

Funciones API
DM_NOTIFY_VARIABLE_PROC (Página 1834) Determinar valores de variables (Callback)

DMGetValue (Página 1714) Determinar valores de variables
Consulte también
DM_NOTIFY_VARIABLE_PROC (Página 1834)
DM_VARKEY (Página 1614)
DMGetValue (Página 1714)
DM_TYPEREF (Página 1596)
3.2.2.15 DM_VAR_UPDATE_STRUCTEX (RT Professional)
Declaración
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
Excepción: En solicitudes cíclicas, por motivos de rendimiento en esta estructura no se registra
nada.
dmVarKey
Con la estructura DM_VARKEY (Página 1614) se especifica la variable que debe procesarse.

dmValue
Nota
VARIANT dmValue debe inicializarse con VariantInit(&dmValue) antes del primer uso y volver
a habilitarse con VariantClear(&dmValue) después del uso.
Sólo se puede preinicializar antes del primer uso una matriz de varias
DM_VAR_UPDATE_STRUCT con ZeroMemory() o memset(). Esto tiene efecto en la
VARIANT dmValue aquí contenida como una VariantInit(&dmValue), puesto que 0 equivale
a VT_EMPTY.
La estructura DM_VAR_UPDATE_STRUCTEX no se puede borrar con ZeroMemory() o
memset() si ya se ha utilizado una vez. Entonces VARIANT contiene datos que también
pueden ser de tipo VT_BSTR.
Si el tipo de variante es VT_BSTR surgen problemas con la administración de memoria
(MemoryLeak) si no se hace ningún VariantClear(&dmValue) antes, p. ej., de borrar
estructuras asignadas DM_VAR_UPDATE_STRUCTEX con delete[].
dwState
Indica si el valor de la variable se ha podido modificar correctamente o se han producido
errores:
DM_VARSTATE_NOT_ESTABLISHED 0x0001 Conexión con el interlocutor no estableci‐

da
DM_VARSTATE_HANDSHAKE_ERROR 0x0002 Error de protocolo
DM_VARSTATE_MAX_LIMIT 0x0008 Límite superior configurado excedido
DM_VARSTATE_MIN_LIMIT 0x0010 Límite inferior configurado no alcanzado
DM_VARSTATE_MAX_RANGE 0x0020 Límite de formato excedido
DM_VARSTATE_MIN_RANGE 0x0040 Límite de formato no alcanzado
DM_VARSTATE_CONVERSION_ERROR 0x0080 Visualización de errores de conversión
(en relación con DM_VARSTA‐
TE_..._RANGE)
DM_VARSTATE_INVALID_KEY 0x0800 Variable no encontrada / no existente
DM_VARSTATE_TIMEOUT 0x2000 Timeout / ninguna respuesta del canal
DM_VARSTATE_SERVERDOWN 0x4000 El servidor está apagado
dwQualityCode
Quality Code del valor de la variable.

La representación del Quality Code es la siguiente:
Estado de variables del DM de Quality Code según Profibus PA/OPC

WinCC
DM_VARSTATE_SERVERDOWN (0x4000) El servidor está apagado Bad, out of service, 0x1C
DM_VARSTATE_HARDWARE_ERROR Defecto del módulo/tarjeta de red Bad, device failure, 0x0C
(0x0004)
DM_VARSTATE_NOT_ESTABLISHED Conexión con el interlocutor no es‐ Bad, not connected, 0x08
(0x0001) tablecida
DM_VARSTATE_TIMEOUT (0x2000) Timeout / ninguna respuesta del Uncertain, last usable value, 0x44
canal
DM_VARSTATE_HANDSHAKE_ERROR Error de protocolo Bad, no communication (no usable va‐
(0x0002) lue), 0x18
DM_VARSTATE_ADDRESS_ERROR Error de direccionamiento en el ca‐ Bad, configuration error, value not ac‐
(0x0400) nal cepted, 0x04
DM_VARSTATE_INVALID_KEY (0x0800) Variable no encontrada / no exis‐ Bad, configuration error, value not ac‐
tente cepted, 0x04
DM_VARSTATE_ACCESS_FAULT (0x1000) Acceso a variable no permitido Bad, configuration error, value not ac‐
cepted, 0x04
DM_VARSTATE_MAX_RANGE (0x0020) Límite de formato excedido Uncertain, engineering unit range viola‐
tion, high limit gesetzt, 0x56
DM_VARSTATE_MIN_RANGE (0x0040) Límite de formato no alcanzado Uncertain, engineering unit range viola‐
tion, low limit gesetzt, 0x55
DM_VARSTATE_CONVERSION_ERROR Visualización de errores de conver‐ Uncertain, engineering unit range viola‐
(0x0080) sión tion, ohne limits gesetzt, 0x54
DM_VARSTATE_MAX_LIMIT (0x0008) Límite superior configurado exce‐ La imagen en Limit-Bit HIGH, 0x01, jun‐
dido to con los otros estados de variable
combinados lógicamente con la opera‐
ción O, p. ej., good (cascade), ok, da
0xC2
DM_VARSTATE_MIN_LIMIT (0x0010) Límite inferior configurado no al‐ La imagen en Limit-Bit LOW, 0x02, junto
canzado con los otros estados de variable com‐
binados lógicamente con la operación
O, p. ej., good (cascade), ok, da 0xC1
DM_VARSTATE_STARTUP_VALUE Valor de inicialización de la variable Uncertain, initial value, 0x4C
(0x0100)
DM_VARSTATE_DEFAULT_VALUE Valor sustitutivo de la variable Uncertain, substitute-set, 0x48
(0x0200)
Archivos necesarios
dmclient.h
Funciones API
DM_NOTIFY_VARIABLEEX_PROC (Pági‐ Determinar valores de variables (Callback)

na 1845)
DMGetValueEx (Página 1716) Determinar valores de variables

Consulte también
DM_NOTIFY_VARIABLEEX_PROC (Página 1845)
DMGetValueEx (Página 1716)
3.2.2.16 DM_VARFILTER (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
DWORD dwNumTypes;
LPDWORD pdwTypes;
LPSTR lpszGroup;
LPSTR lpszName;
LPSTR lpszConn;
}
DM_VARFILTER;
Members
dwFlags
El parámetro dwFlags permite ajustar un criterio de selección para las variables:
DM_VARFILTER_TYPE 0x00000001 Como criterio de selección se utiliza el tipo de variable

(pdwTypes).
DM_VARFILTER_GROUP 0x00000002 Como criterio de selección se utiliza el nombre del grupo
(lpszGroup).
DM_VARFILTER_NAME 0x00000004 Como criterio de selección se utiliza el nombre de va‐
riable (lpszName).
DM_VARFILTER_CONNECTION 0x00000008 Como criterio de selección se utiliza el nombre de la
conexión lógica (lpszConn).

DM_VARFILTER_FAST_CALLBACK 0x00010000 (Indicador de DMEnumVariables): Si está activado este

indicador, el búfer ya no respalda los datos de Callback.
De esta manera Callback proporciona los datos directa‐
mente de la base de datos.
La ventaja del indicador es una reacción más rápida
hasta que se envía la primera llamada. Simultaneamen‐
te se evita la carga adicional de la memoria en caso de
grandes volúmenes.
Precaución
No se debe llamar ninguna otra función de DMClient en
este Callback, ya que de lo contrario se puede producir
un bloqueo.
DM_VARFILTER_LOCAL_ONLY 0x00020000 (Indicador de DMEnumVariables): Si este indicador es‐
tá activado, sólo se enumeran variables locales. No se
solicitan variables de otros servidores utilizados en el
proyecto.
dwNumTypes
Número de tipos de variable indicados en pdwTypes.
pdwTypes
pdwTypes indica el tipo de variable que se debe utilizar como criterio de selección.

Los tipos DM_VARTYPE_RAW, DM_VARTYPE_STRUCT no DM_VARTYPE_TEXTREF no

se soportan.
Indique el TypID correspondiente para seleccionar variables estructuradas con estructuras
autodefinidas. Para determinar la TypID, utilice la función GAPIEnumTypes.
lpszGroup
Puntero al nombre de un grupo de variables. El nombre debe utilizarse como criterio de
selección. No se pueden indicar comodines.
lpszName
Puntero al nombre de una variable. El nombre debe utilizarse como criterio de selección. No
se pueden indicar comodines.

lpszConn
Puntero al nombre de una conexión lógica. El nombre debe utilizarse como criterio de
selección. No se pueden indicar comodines.
Archivos necesarios
dmclient.h
Funciones API
DMEnumVariables (Página 1711) Listar nombres de variables

Consulte también
DMEnumVariables (Página 1711)
3.2.2.17 DM_VARGRP_DATA (RT Professional)
Declaración
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
DWORD dwCreatorID;
WORD dwVarNum;
LPVOID lpvUserData;
}
DM_VARGRP_DATA;
Members
szName
Nombre del grupo de variables
dwCreatorID
La identificación del causante indica quién ha creado un objeto.
Los valores 0 – 10100 y 11000 - 11100 son internos o están reservados para determinados
sistemas.

dwVarNum
Número de variables dentro del grupo de variables
lpvUserData
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_VARGRP_PROC (Página 1709) Listar información sobre un grupo de variables

(Callback)
Consulte también
DM_ENUM_VARGRP_PROC (Página 1709)
3.2.2.18 DM_VARGRPKEY (RT Professional)
Declaración
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARGRPKEY;
Members
szName
Nombre del grupo de variables
lpvUserData
Archivos necesarios
dmclient.h

Funciones API
DMEnumVarGrpData (Página 1706) Listar información sobre un grupo de variables
Consulte también
DMEnumVarGrpData (Página 1706)
3.2.2.19 DM_VARIABLE_DATA (RT Professional)
Declaración
typedef struct {
DM_VARLIMIT dmVarLimit;
VARIANT dmStart;
VARIANT dmDefault;
DWORD dwNotify;
DWORD dwFlags;
CHAR szSpecific[MAX_DM_VAR_SPECIFIC +1];
CHAR szGroup[MAX_DM_GROUP_NAME +1];
CHAR szConnection[
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
}
DM_VARIABLE_DATA;
Members
dmTypeRef
dmVarLimit
La estructura DM_VARLIMIT (Página 1616) contiene información sobre los valores límite de
una variable
dmStart
Valor inicial de las variables. Debe volver a habilitarse con VariantClear(&dmStart) después
del uso.
dmDefault
Valor sustitutivo de la variable. Debe volver a habilitarse con VariantClear(&dmDefault)
después del uso.

dwNotify
dwNotify determina los eventos para los que se genera una entrada en el informe:
DM_NOTIFY_MAX_LIMIT 0x00000001 En caso de alcanzar el límite su‐

perior
DM_NOTIFY_MIN_LIMIT 0x00000002 En caso de alcanzar el límite in‐
ferior
DM_NOTIFY_FORMAT_ERROR 0x00000004 En caso de error de conversión
DM_NOTIFY_ACCESS_FAULT 0x00000008 En caso de acceso de escritura
no permitido
DM_NOTIFY_APPLICATION_WRITE 0x00000010 En caso de aplicación de acceso
de escritura
DM_NOTIFY_PROCESS_WRITE 0x00000020 En caso de proceso de acceso
de escritura
dwFlags
Indica cómo debe utilizarse el valor sustitutivo:
DM_HAS_MIN_LIMIT 0x00000008 La variable tiene un límite inferior

fijo
DM_HAS_MAX_LIMIT 0x00000010 La variable tiene un límite supe‐
rior fijo
DM_HAS_STARTUP_VALUE 0x00000040 La variable tiene valor de iniciali‐
zación
DM_USE_DEFAULT_ON_STARTUP 0x00000080 Introducir valor sustitutivo al ini‐
ciar el sistema
DM_USE_DEFAULT_ON_MAX 0x00000100 Introducir valor sustitutivo al ex‐
ceder el límite superior
DM_USE_DEFAULT_ON_MIN 0x00000200 Introducir valor sustitutivo al ex‐
ceder el límite inferior
DM_USE_DE‐ 0x00000400 Valor sustitutivo en caso de error
FAULT_ON_COMM_ERROR de conexión
szSpecific
szSpecific contiene la relación de direcciones de las variables, p. ej., bloque de datos y bytes
en el bloque.... Consulte la información específica del PLC en el manual de comunicación.
Parámetros.
szGroup
Nombre del grupo al que pertenece la variable.
Este valor no se suministra al multicliente en variables del servidor.
szConnection
Nombre de la conexión lógica con la que se combina la variable.

szChannel
Nombre de archivo del driver del canal.
szUnit
Nombre de la unidad de canal con la que se combina la variable.
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_VARIABLE_PROC (Página 1700) Listar información sobre una variable (Callback)
Consulte también
DM_ENUM_VARIABLE_PROC (Página 1700)
DM_VARLIMIT (Página 1616)
DMEnumVarData (Página 1698)
3.2.2.20 DM_VARIABLE_DATA4 (RT Professional)
Declaración
typedef struct {
DM_VARLIMIT dmVarLimit;
VARIANT dmStart;
VARIANT dmDefault;
DWORD dwNotify;
DWORD dwFlags;
CHAR szSpecific[MAX_DM_VAR_SPECIFIC +1];
CHAR szGroup[MAX_DM_GROUP_NAME +1];
CHAR szConnection[
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
MCP_VARIABLE_SCALES Scaling;
DWORD dwASDataSize;
DWORD dwOSDataSize;
DWORD dwVarProperty;
DWORD dwFormat;
}
DM_VARIABLE_DATA4;

Members
dmTypeRef
dmVarLimit
La estructura DM_VARLIMIT (Página 1616) contiene información sobre los valores límite de
una variable
dmStart
Valor inicial de las variables. Debe volver a habilitarse con VariantClear(&dmStart) después
del uso.
dmDefault
Valor sustitutivo de la variable. Debe volver a habilitarse con VariantClear(&dmDefault)
después del uso.
dwNotify
dwNotify determina los eventos para los que se genera una entrada en el informe:
DM_NOTIFY_MAX_LIMIT 0x00000001 En caso de alcanzar el límite su‐

perior
DM_NOTIFY_MIN_LIMIT 0x00000002 En caso de alcanzar el límite in‐
ferior
DM_NOTIFY_FORMAT_ERROR 0x00000004 En caso de error de conversión
DM_NOTIFY_ACCESS_FAULT 0x00000008 En caso de acceso de escritura
no permitido
DM_NOTIFY_APPLICATION_WRITE 0x00000010 En caso de aplicación de acceso
de escritura
DM_NOTIFY_PROCESS_WRITE 0x00000020 En caso de proceso de acceso
de escritura
dwFlags
Indica cómo debe utilizarse el valor sustitutivo:
DM_HAS_MIN_LIMIT 0x00000008 La variable tiene un límite inferior

fijo
DM_HAS_MAX_LIMIT 0x00000010 La variable tiene un límite supe‐
rior fijo
DM_HAS_STARTUP_VALUE 0x00000040 La variable tiene valor de iniciali‐
zación
DM_USE_DEFAULT_ON_STARTUP 0x00000080 Introducir valor sustitutivo al ini‐
ciar el sistema
DM_USE_DEFAULT_ON_MAX 0x00000100 Introducir valor sustitutivo al ex‐
ceder el límite superior

DM_USE_DEFAULT_ON_MIN 0x00000200 Introducir valor sustitutivo al ex‐

ceder el límite inferior
DM_USE_DEFAULT_ON_COMM_ERROR 0x00000400 Valor sustitutivo en caso de error
de conexión
szSpecific
Parámetros.
szGroup
szConnection
Nombre de la conexión lógica con la que se combina la variable.
szChannel
Nombre de archivo del driver del canal.
szUnit
Nombre de la unidad de canal con la que se combina la variable.
Scaling
Estructura MCP_VARIABLE_SCALES (Página 1641) con la descripción del escalado de la
variable.
dwASDataSize
Longitud de las variables en el PLC (número de bits)
dwOSDataSize
Longitud de las variables en el OS (número de bits)
dwVarProperty
Indica si es una variable interna o externa:
DM_INTERNAL_VAR 0x00000002 Variable interna

DM_EXTERNAL_VAR 0x00000004 Variable externa
dwFormat
Número de rutinas de conversión utilizadas. Encontrará más información en el apartado
"Rutinas de conversión".
Archivos necesarios
dmclient.h

Funciones API
DM_ENUM_VARIABLE_PROC4 (Página 1704) Listar información sobre una variable (Callback)
Consulte también
DMEnumVarData4 (Página 1702)
DM_ENUM_VARIABLE_PROC4 (Página 1704)
MCP_VARIABLE_SCALES (Página 1641)
3.2.2.21 DM_VARKEY (RT Professional)
Declaración
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;
Members
dwKeyType
dwKeyType indica si debe accederse a la variable a través de un ID clave o de su nombre:
DM_VARKEY_ID Especificación a través de ID clave

DM_VARKEY_NAME Especificación a través del nombre de la variable
Si se utiliza DM_VARKEY como estructura de retorno, los dos tipos pueden ser ocupados
cuando se devuelven la ID clave y el nombre de la variable.
Si se utiliza DM_VARKEY como parámetro de suministro, se debería ocupar preferiblemente
el nombre de la variable, ya que sólo puede especificarse con un prefijo de servidor. Si se
utiliza la ID clave, siempre se trabaja de forma local.
dwID
Contiene la ID clave de la variable, si dwKeyType está activado de la forma correspondiente.
szName
Contiene el nombre de la variable, si dwKeyType está activado de la forma correspondiente.

lpvUserData
Observaciones
La estructura DM_VARKEY forma parte de la estructura DM_VAR_UPDATE_STRUCT
(Página 1598).
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_TYPEMEMBERS_PROC_EX (Pági‐ Listar variables de una variable estructurada (Call‐

na 1809) back)
DM_ENUM_TYPEMEMBERS_PROC (Pági‐ Listar variables de una variable estructurada (Call‐
na 1804) back)
DM_ENUM_VAR_PROC (Página 1712) Listar nombres de variables (Callback)
DM_NOTIFY_SELECT_VAR_PROC (Pági‐ Abrir cuadro de diálogo de selección de variables
na 1795) (Callback)
DMEnumVarData (Página 1698) Listar información sobre una variable
DMGetValueWait (Página 1727) Determinar los valores de las variables con actua‐
lización
DMGetVarLimits (Página 1745) Determinar los valores límite de una variable
DMGetVarInfo (Página 1734) Determinar ID de variables, determinar nombre de
variables
DMGetVarType (Página 1752) Determinar el tipo de datos de una variable
DMSetValue (Página 1758) Modificar valores de variables
DMSetValueMessage (Página 1764) Modificar valores de variables con salida de avisos
DMSetValueWait (Página 1768) Modificar valores de variables con aviso
DMSetValueWaitMessage (Página 1774) Modificar valores de variables con aviso y salida
de avisos
DMStartVarUpdate (Página 1832) Definir variables de actualización
Consulte también
DMStartVarUpdate (Página 1832)
DMGetValueWait (Página 1727)
DMGetVarInfo (Página 1734)

DMGetVarLimits (Página 1745)

DMSetValue (Página 1758)
DMSetValueMessage (Página 1764)
DMSetValueWait (Página 1768)
DMSetValueWaitMessage (Página 1774)
DM_ENUM_VAR_PROC (Página 1712)
DM_ENUM_TYPEMEMBERS_PROC (Página 1804)
DM_ENUM_TYPEMEMBERS_PROC_EX (Página 1809)
DM_NOTIFY_SELECT_VAR_PROC (Página 1795)
DMStartVarUpdateEx (Página 1835)
DMGetValueWaitEx (Página 1729)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Página 1812)
MSG_CSDATA_STRUCT_PLUS (Página 2419)
3.2.2.22 DM_VARLIMIT (RT Professional)
Declaración
typedef struct {
VARIANT dmMaxRange;
VARIANT dmMinRange;
VARIANT dmMaxLimit;
VARIANT dmMinLimit;
}
DM_VARLIMIT;
Members
dmMaxRange
Límite superior de la conversión de formato

dmMinRange
Límite inferior de la conversión de formato
dmMaxLimit
Límite superior de la variable.
dmMinLimit
Límite inferior de la variable.
Observaciones
DM_VARLIMIT forma parte de la estructura DM_VARIABLE_DATA (Página 1607). Todos los
VARIANT deben volver a habilitarse con VariantClear(&dmxxx) después del uso.
Archivos necesarios
dmclient.h
Funciones API
DMGetVarLimits (Página 1745) Determinar los valores límite de una variable
Consulte también
3.2.2.23 MCP_NEWVARIABLE_DATA (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON Common;
MCP_VARIABLE_PROTOCOL Protocol;
MCP_VARIABLE_LIMITS Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1];
}
MCP_NEWVARIABLE_DATA;

Members
dwFlags
dwFlags indica cómo debe editarse la variable:
MCP_NVAR_FLAG_CREATE 1 Crear variable

MCP_NVAR_FLAG_MODIFY 2 Modificar variable (no se puede
utilizar en RT)
MCP_NVAR_FLAG_TEST 3 Comprobar la existencia de una
variable
Los flags no se pueden combinar lógicamente con la operación O.
szProjectFile
Nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects o en
RT con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno con el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con el error DM_E_NOT_CONNECTED.
szConnection
Nombre de la conexión lógica asignada a la variable.
szVarName
Nombre de la nueva variable que se va a procesar.
szGroupName
Si se indica un nombre de grupo que existe en otra conexión que en la indicada en
szConnection, el nombre del grupo se ignora sin mensaje de error y la variable se crea
directamente en la conexión.
Si se indica un nombre de grupo que aún no existe, el grupo se crea de manera implícita.
Al modificar una variable con MCP_NVAR_FLAG_MODIFY, se ignora un cambio del nombre
del grupo sin mensaje de error.
Common
Estructura MCP_VARIABLE_COMMON (Página 1629) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL (Página 1638) con la descripción del tratamiento
del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS (Página 1633) con los valores límite de la variable.

szSpecific
Parámetros.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX (Página 1624) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Funciones API
GAPICreateNewVariable (Página 1796) Crear variable
Consulte también
GAPICreateNewVariable (Página 1796)
MCP_VARIABLE_PROTOCOL (Página 1638)
MCP_VARIABLE_COMMON (Página 1629)
MCP_VARIABLE_LIMITS (Página 1633)
MCP_NEWVARIABLE_DATA_EX (Página 1624)

3.2.2.24 MCP_NEWVARIABLE_DATA_4 (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_LIMITS Limits;
}
MCP_NEWVARIABLE_DATA_4;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Modificar variable (si no existe,
se crea una nueva) (no se puede
utilizar en RT)
variable
szProjectFile
runtime con DMGetRuntimeProject.
que está abierto.
rechazan con error (DM_E_NOT_CONNECTED).
szConnection
szVarName

szGroupName
Common
Protocol
Limits
Estructura MCP_VARIABLE_LIMITS (Página 1633) con los valores límite de la variable.
szSpecific
Parámetros.
Scaling
variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX4 (Página 1626) tiene un uso similar en la
Archivos necesarios
dmclient.h
Funciones API
GAPICreateNewVariable4 (Página 1797) Crear variable

GAPICreateNewVariableEx4 (Página 1801) Crear variable con ID de Creator

Consulte también
GAPICreateNewVariable4 (Página 1797)
MCP_NEWVARIABLE_DATA_EX4 (Página 1626)
GAPICreateNewVariableEx4 (Página 1801)
3.2.2.25 MCP_NEWVARIABLE_DATA_5 (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_LIMITS5 Limits;
}
MCP_NEWVARIABLE_DATA_5;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Modificar variable (si no existe,
se crea una nueva) (no se puede
utilizar en RT)
variable
szProjectFile


que está abierto.
szConnection
szVarName
szGroupName
Common
Protocol
Limits
Estructura MCP_VARIABLE_LIMITS5 (Página 1635) con los valores límite de la variable.
szSpecific
Parámetros.
Scaling
variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX4 (Página 1626) tiene un uso similar en la

Archivos necesarios
dmclient.h
Funciones API
GAPICreateNewVariable5 (Página 1799) Crear variable con ID de Creator
Consulte también
MCP_VARIABLE_LIMITS5 (Página 1635)
3.2.2.26 MCP_NEWVARIABLE_DATA_EX (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
}
MCP_NEWVARIABLE_DATA_EX;
Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Modificar variable (no se puede utilizar en runtime)
MCP_NVAR_FLAG_TEST 3 Comprueba la existencia de una variable.

szProjectFile
que está abierto.
szConnection
szVarName
szGroupName
Common
Estructura MCP_VARIABLE_COMMON_EX (Página 1630) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL_EX (Página 1640) con la descripción del
tratamiento del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS_EX (Página 1637) con los valores límite de la variable.
szSpecific
Parámetros.
Observaciones
La estructura MCP_NEWVARIABLE_DATA (Página 1615) tiene un uso similar.

Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_TYPEMEMBERS_PROC_EX (Pági‐ Listar variables de una variable estructurada (Call‐

na 1809) back)
Consulte también
MCP_NEWVARIABLE_DATA (Página 1615)
MCP_VARIABLE_COMMON_EX (Página 1630)
MCP_VARIABLE_LIMITS_EX (Página 1637)
MCP_VARIABLE_PROTOCOL_EX (Página 1640)
3.2.2.27 MCP_NEWVARIABLE_DATA_EX4 (RT Professional)
Declaración
typedef struct {
DWORD dwFlags;
char szConnection[
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
}
MCP_NEWVARIABLE_DATA_EX4;

Members
dwFlags

MCP_NVAR_FLAG_MODIFY 2 Modificar variable (no se puede
utilizar en RT)
MCP_NVAR_FLAG_TEST 3 Comprueba la existencia de una
variable.
szProjectFile
que está abierto.
szConnection
szVarName
szGroupName
Common
Estructura MCP_VARIABLE_COMMON_EX (Página 1630) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL_EX (Página 1640) con la descripción del
tratamiento del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS_EX (Página 1637) con los valores límite de la variable.

szSpecific
Parámetros.
Scaling
variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_4 (Página 1618) tiene un uso similar.
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Pági‐ Listar variables de una variable estructurada (Call‐

na 1812) back)
Consulte también
MCP_NEWVARIABLE_DATA_4 (Página 1618)

3.2.2.28 MCP_VARIABLE_COMMON (RT Professional)
Declaración
typedef struct {
DWORD dwVarType;
DWORD dwVarLength;
DWORD dwFormat;
}
MCP_VARIABLE_COMMON;
Members
dwVarType
En dwVarType se especifica el tipo de variable:

dwVarLength
La indicación de la longitud de la variable sólo es relevante en las variables de texto
DM_VARTYPE_TEXT_8 y DM_VARTYPE_TEXT_16.
La longitud del texto se indica en caracteres (1 .... 255).
dwVarProperty
DM_INTERNAL_VAR Variable interna

DM_EXTERNAL_VAR Variable externa

dwFormat
Observaciones
MCP_VARIABLE_COMMON forma parte de las estructuras MCP_NEWVARIABLE_DATA
(Página 1615) y MCP_NEWVARIABLE_DATA_4 (Página 1618).
La estructura MCP_VARIABLE_COMMON_EX (Página 1630) tiene un uso similar en la
Archivos necesarios
dmclient.h
Consulte también
3.2.2.29 MCP_VARIABLE_COMMON_EX (RT Professional)
Declaración
typedef struct {
DWORD dwVarType;
DWORD dwCreatorID
DWORD dwVarLength;
DWORD dwFormat;
DWORD dwOSOffset;
DWORD dwASOffset;
char szStructTypeName
}
MCP_VARIABLE_COMMON_EX;

Members
dwVarType
En dwVarType se especifica el tipo de variable:

dwCreatorID
sistemas.
dwVarLength
La indicación de la longitud de la variable sólo es relevante en las variables de texto
DM_VARTYPE_TEXT_8 y DM_VARTYPE_TEXT_16. La longitud del texto se indica en
caracteres (1 .... 255).
dwVarProperty
DM_INTERNAL_VAR Variable interna

DM_EXTERNAL_VAR Variable externa
dwFormat
dwOSOffset
por 0.
dwASOffset
Offset en el búfer del PLC

El ASOffset orientado a bits se acciona internamente en BYTE.
szStructTypeName
Nombre del tipo de estructura
Observaciones
MCP_VARIABLE_COMMON_EX forma parte de la estructura
MCP_NEWVARIABLE_DATA_EX (Página 1622).
La estructura MCP_VARIABLE_COMMON (Página 1627) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también

3.2.2.30 MCP_VARIABLE_LIMITS (RT Professional)
Declaración
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
Valor del límite superior de la variable
dBottomLimit
Valor del límite inferior de la variable
dStartValue
Valor inicial de la variable
dSubstituteValue
Valor sustitutivo de la variable
bTopLimit
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando el valor de la variable
exceda el valor indicado en dTopLimit.
bBottomLimit
sea inferior al valor indicado en dBottomLimit.
bStartValue
Si el parámetro está activado, el valor sustitutivo debe utilizarse como valor inicial.

bConnectionErr
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando aparece un error de
conexión.
bTopLimitValid
Si el parámetro está activado, el valor del límite superior indicado en dTopLimit es válido.
bBottomLimitValid
Si el parámetro está activado, el valor del límite inferior indicado en dBottomLimit es válido.
bStartValueValid
Si el parámetro está activado, el valor inicial indicado en dStartValue es válido.
bSubstValueValid
Si el parámetro está activado, el valor sustitutivo indicado en dSubstitudeValue es válido.
Observaciones
MCP_VARIABLE_Limits forma parte de las estructuras MCP_NEWVARIABLE_DATA
La estructura MCP_VARIABLE_LIMITS_EX (Página 1637) tiene un uso similar en la
Archivos necesarios
dmclient.h
Consulte también

3.2.2.31 MCP_VARIABLE_LIMITS5 (RT Professional)
Declaración
typedef struct {
VARIANT varTopLimit;
VARIANT varBottomLimit;
VARIANT varStartValue;
VARIANT varSubstituteValue;
BOOL bTopLimit;
BOOL bBottomLimit;
BOOL bStartValue;
BOOL bConnectionErr;
BOOL bTopLimitValid;
BOOL bBottomLimitValid;
BOOL bStartValueValid;
BOOL bSubstValueValid;
}
MCP_VARIABLE_LIMITS5;
Members
varTopLimit
varBottomLimit
varStartValue
varSubstituteValue
bTopLimit
exceda el valor indicado en dTopLimit.
bBottomLimit
sea inferior al valor indicado en dBottomLimit.
bStartValue
Si el parámetro está activado, el valor sustitutivo debe utilizarse como valor inicial.

bConnectionErr
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando aparece un error de
conexión.
bTopLimitValid
Si el parámetro está activado, el valor del límite superior indicado en dTopLimit es válido.
bBottomLimitValid
Si el parámetro está activado, el valor del límite inferior indicado en dBottomLimit es válido.
bStartValueValid
Si el parámetro está activado, el valor inicial indicado en dStartValue es válido.
bSubstValueValid
Si el parámetro está activado, el valor sustitutivo indicado en dSubstitudeValue es válido.
Observaciones
MCP_VARIABLE_LIMITS5 forma parte de la estructura MCP_NEWVARIABLE_DATA_5
(Página 1620) y es necesario para poder especificar variables de texto con valor inicial y
sustitutivo con la función GAPICreateNewVariable5 (Página 1799).
Archivos necesarios
dmclient.h
Consulte también

3.2.2.32 MCP_VARIABLE_LIMITS_EX (RT Professional)
Declaración
typedef struct {
double dTopLimit
double dBottomLimit;
double dStartValue;
double dSubstituteValue;
DWORD dwLimitFlags
DWORD dwTextBibStartText;
char szTextStartText[255];
DWORD dwTextBibSubstitude;
char szTextSubstitude[255]
}
MCP_VARIABLE_LIMITS_EX;
Members
dTopLimit
dBottomLimit
dStartValue
dSubstituteValue
LimitFlags
El parámetro LimitFlags determina la validez del valor predefinido y del valor límite de una
variable:
MCP_VARLIM_HAS_MIN_LIMIT La variable tiene un límite inferior fijo

MCP_VARLIM_HAS_MAX_LIMIT La variable tiene un límite superior fijo
MCP_VARLIM_HAS_DEFAULT_VALUE La variable tiene valor sustitutivo
MCP_VARLIM_HAS_STARTUP_VALUE La variable tiene valor inicial
MCP_VARLIM_USE_DEFAULT_ON_STARTUP El valor sustitutivo debe utilizarse al iniciar el sistema.
MCP_VARLIM_USE_DEFAULT_ON_MAX El valor sustitutivo debe utilizarse en caso de rebase del lí‐
mite superior.
MCP_VARLIM_USE_DEFAULT_ON_MIN El valor sustitutivo debe utilizarse en caso de rebase del lí‐
mite inferior.
MCP_VARLIM_USE_DEFAULT_ON_COMM_ERROR El valor sustitutivo debe utilizarse cuando aparece un error
de conexión.

dwTextBibStartText
El parámetro sólo es relevante para las variables de texto. Si el texto que va a utilizarse como
valor inicial debe leerse del texto del proyecto, indique la ID del texto correspondiente.
szTextStartText
El parámetro sólo es relevante para las variables de texto. Indique directamente en
szTextStartText el texto que va a utilizarse como valor inicial.
dwTextBibSubstitude
El parámetro sólo es relevante para las variables de texto. Si el texto que va a utilizarse como
valor sustitutivo debe leerse del texto del proyecto, indique la ID del texto correspondiente.
szTextSubstitude
El parámetro sólo es relevante para variables de texto. Indique directamente en
szTextSubstitude el texto que va a utilizarse como valor sustitutivo.
Observaciones
MCP_VARIABLE_LIMITS_EX forma parte de la estructura MCP_NEWVARIABLE_DATA_EX
(Página 1622).
La estructura MCP_VARIABLE_LIMITS (Página 1631) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también
3.2.2.33 MCP_VARIABLE_PROTOCOL (RT Professional)
Declaración
typedef struct {
BOOL bTopLimitErr;
BOOL bBottomLimitErr;
BOOL bTransformationErr;
BOOL bWriteErr;
BOOL bWriteErrApplication;
BOOL bWriteErrProzess;
}
MCP_VARIABLE_PROTOCOL;

Members
bTopLimitErr
Se genera una entrada de protocolo si el valor de la variable excede el valor límite superior.
bBottomLimitErr
Se genera una entrada de protocolo si el valor de la variable excede el valor límite inferior.
bTransformationErr
Se crea una entrada de protocolo cuando aparece un error de conversión.
bWriteErr
Se genera una entrada de protocolo en cada acceso de escritura no válido.
bWriteErrApplication
Se crea una entrada de protocolo en cada acceso de escritura no válido en la aplicación.
bWriteErrProzess
Se crea una entrada de protocolo en cada acceso de escritura no válido en el proceso.
Observaciones
MCP_VARIABLE_PROTOCOL forma parte de las estructuras MCP_NEWVARIABLE_DATA
La estructura MCP_VARIABLE_PROTOCOL_EX (Página 1640) tiene un uso similar en la
Archivos necesarios
dmclient.h
Consulte también

3.2.2.34 MCP_VARIABLE_PROTOCOL_EX (RT Professional)
Declaración
typedef struct {
DWORD dwProtocolFlags
}
MCP_VARIABLE_PROTOCOL_EX;
Members
dwProtocolFlags
Con el parámetro dwProtocolFlags se determina con qué evento debe generarse una entrada
en el informe:
MCP_VARPROT_TOPLIMITERR Se genera una entrada en el informe si el valor de

la variable excede el valor límite superior.
MCP_VARPROT_BOTTEMLIMITERR Se genera una entrada en el informe si el valor de
la variable excede el valor límite inferior.
MCP_VARPROT_TRANSFORMATIONERR Se genera una entrada en el informe cuando apa‐
rece un error de conversión.
MCP_VARPROT_WRITEERR Se genera una entrada en el informe en cada ac‐
ceso de escritura no válido.
MCP_VARPROT_WRITEERRAPPLICATION Se crea una entrada en el informe en cada acceso
de escritura no válido en la aplicación.
MCP_VARPROT_WRITEERRPROCESS Se crea una entrada en el informe en cada acceso
de escritura no válido en el proceso.
Se permite una combinación lógica de estas constantes.
Observaciones
MCP_VARIABLE_PROTOCOL_EX forma parte de la estructura
MCP_NEWVARIABLE_DATA_EX (Página 1622).
La estructura MCP_VARIABLE_PROTOCOL (Página 1636) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también

3.2.2.35 MCP_VARIABLE_SCALES (RT Professional)
Declaración
typedef struct {
DWORD dwVarScaleFlags;
double doMinProc;
double doMaxProc;
double doMinVar;
double doMaxVar;
}
MCP_VARIABLE_SCALES;
Members
dwVarScaleFlags
DM_VARSCALE_NOSCALE: Sin escala
DM_VARSCALE_LINEAR: Escala lineal
doMinProc
Valor mínimo de las variables en el proceso
doMaxProc
Valor máximo de las variables en el proceso
doMinVar
Valor mínimo de las variables en WinCC
doMaxVar
Valor máximo de las variables en WinCC
Observaciones
MCP_VARIABLE_SCALES forma parte de la estructura MCP_NEWVARIABLE_DATA_4
(Página 1618).
Archivos necesarios
dmclient.h
Consulte también


3.2.3 Funciones generales (RT Professional)
3.2.3.1 DMActivateRTProject (RT Professional)
Utilización
La función activa el proyecto abierto en WinCC.
Declaración
BOOL DMActivateRTProject (
LPCMN_ERROR lpdmError);
Parámetros
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Proyecto activado.
FALSE
Error.
Comentario
Esta función se edita internamente de forma asíncrona. Si la petición se ha transferido
internamente de forma correcta, siempre devuelve TRUE. Si, p. ej., el nombre del equipo
servidor se ha indicado mal en el proyecto, no se notifica ningún error.
DMGetRTProject(..) comprueba si el inicio ha sido correcto.
Si es necesario comprobar que el nombre del equipo es correcto, utilice las funciones
DMGetMachineTable(..) y GetComputername(..).

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
3.2.3.2 DMAddNotify (RT Professional)
Declaración
BOOL DMAddNotify (
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
LPDWORD lpdwNotifyCookie,
Descripción
Incorporación de una llamada adicional de la función Notify a "DMClient". La funcionalidad
Notify se corresponde con la funcionalidad que puede indicarse con "DMConnect".
Parámetros
lpfnNotify
Puntero a funciones Notify adicionales.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Notify.
lpdwNotifyCookie
Puntero a un "DWORD" en el que se devuelve una cookie para Notify.
La cookie vuelve a necesitarse más tarde con la función "DMRemoveNotify" para eliminar la
ejecución de Notify.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
error el sistema escribe información de error en esta estructura.

Valor de retorno
TRUE
Función Notify adicional incorporada.
FALSE
Error
Observaciones
La función se necesita en el caso de que ya se haya ejecutado "DMConnect" dentro del
proceso pero no sea posible acceder a la función Notify allí indicada. Así, es posible incorporar
una función Notify adicional que permita asimismo evaluar las Notifies correspondientes.
Si, p. ej., se utiliza una DLL de creación propia con funcionalidad DMClient en una función de
script global, no podrán ejecutarse más "DMConnect". El script ya ha ejecutado un
"DMConnect" y ya no es posible la notificación.
En algunos casos excepcionales puede ocurrir que se suministre Notify antes de que retorne
la llamada de función.
Las funciones Notify incorporadas adicionalmente deberán ser eliminadas con
"DMRemoveNotify" antes de "DMDisconnect". Asimismo, la Notify no debe ser una función
miembro de un objeto de clase que pueda ser destruido o borrado antes de tiempo. Podría
haber otra llamada de Notify tras "DMRemoveNotify".
Mensajes de error
DM_E_NOT_CONNECTED "DMConnect" aún sin ejecutar. La administración

interna aún no está inicializada
DM_E_ALREADY_EXIST Ya existe "NotifyProc" con la misma dirección en
el proceso
DM_E_MAX_LIMIT Se ha alcanzado el número máximo de funciones
Notify adicionales (16)
DM_E_PARAM Error de parámetro
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
DMFireNotifyData Envía datos a la función Notify adicional por medio

de la cookie o a todas las funciones
DMRemoveNotify Elimina la función Notify adicional de la lista Notify
por medio de la cookie

Ejemplos
Button AddNotify:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
AddNotify();
}
Project-Function AddNotify:
extern BOOL DM_NotifyProcA(DWORD dwNotifyClass,
DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser);
void AddNotify()
{
BOOL bRet = FALSE;
DWORD dwNotifyCookie = 0L;
LPVOID lpvUser = NULL;
CMN_ERRORA err;
memset(&err, 0, sizeof(CMN_ERRORA));
dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");
if (dwNotifyCookie)
{
printf("\r\nremove first previous Notify Cookie=%08lx",
dwNotifyCookie);
bRet = DMRemoveNotifyA(dwNotifyCookie, &err);
if (FALSE == bRet)
{
printf("\r\nERROR: DMRemoveNotifyA [%s],%ld,%ld,%ld,
%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
dwNotifyCookie = 0L;
SetTagDWord("DMdwNotifyCookie",dwNotifyCookie);
}
lpvUser = (LPVOID)dwNotifyCookie; //set only for show in notify

bRet = DMAddNotifyA(DM_NotifyProcA,
lpvUser,
&dwNotifyCookie,
&err);
if (bRet)
{
printf("\r\nNotify added, Cookie=%08lx!", dwNotifyCookie);
}
else
{
printf("\r\nERROR: DMAddNotifyA [%s],%ld,%ld,%ld,%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
}
Project-Function DM_NotifyProcA:
extern void RemoveNotify();
BOOL DM_NotifyProcA(DWORD dwNotifyClass,

DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser)
{
BOOL bShowParams = FALSE;
BOOL bSpecialActionRemoveNotify = FALSE;
printf("\r\n\r\n#### extra added DMNotifyProc [%08lx] entry: ####",

(DWORD)lpvUser);
switch (dwNotifyClass)
{
case DM_NOTIFY_CLASS_ERROR:
switch (dwNotifyCode)
{
case DM_NOTIFY_SHUTDOWN:
printf("\r\nDM_NOTIFY_CLASS_ERROR: DM_NOTIFY_SHUTDOWN");
bShowParams = TRUE;
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_PROCESSNET_ERROR:
printf("\r\nDM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_PROCESSNET_ERROR");
bShowParams = TRUE;
break;
case DM_NOTIFY_SYSNET_ERROR:
printf("\r\nDM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_SYSNET_ERROR");

bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_ERROR:
dwNotifyCode[%08lx]", dwNotifyCode);
bShowParams = TRUE;
}
break;
case DM_NOTIFY_CLASS_WARNING:
{
case DM_NOTIFY_QUEUE_50_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT");
break;
break;
break;
break;
break;
case DM_NOTIFY_QUEUE_OVERFLOW:
DM_NOTIFY_QUEUE_OVERFLOW");
break;
case DM_NOTIFY_CYCLES_CHANGED:
DM_NOTIFY_CYCLES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_MACHINES_CHANGED:
DM_NOTIFY_MACHINES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_PROJECT_OPENED:
DM_NOTIFY_PROJECT_OPENED [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_PROJECT_CLOSED:

DM_NOTIFY_PROJECT_CLOSE");
break;
case DM_NOTIFY_SYSTEM_LOCALE:
DM_NOTIFY_SYSTEM_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_DATA_LOCALE:
DM_NOTIFY_DATA_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_PROJECT_RUNTIME:
DM_NOTIFY_ROJECT_RUNTIME [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_PROJECT_EDIT:
DM_NOTIFY_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_HOTKEY_CHANGE:
DM_NOTIFY_HOTKEY_CHANGE");
bShowParams = TRUE;
break;
case DM_NOTIFY_URSEL:
printf("\r\nDM_NOTIFY_CLASS_WARNING: DM_NOTIFY_URSEL");
bShowParams = TRUE;
break;
case DM_NOTIFY_BODO:
printf("\r\nDM_NOTIFY_CLASS_WARNING: DM_NOTIFY_BODO");
bShowParams = TRUE;
break;
case DM_NOTIFY_BEGIN_PROJECT_EDIT:
DM_NOTIFY_BEGIN_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_WARNING:
bShowParams = TRUE;
}
break;
case DM_NOTIFY_CLASS_DATA:

{
case DM_NOTIFY_APPLICATION_DATA:
printf("\r\nDM_NOTIFY_CLASS_DATA:
DM_NOTIFY_APPLICATION_DATA:");
bShowParams = TRUE;
break;
case DM_NOTIFY_VARIABLE_DATA:
printf("\r\nDM_NOTIFY_CLASS_DATA:
DM_NOTIFY_VARIABLE_DATA:");
bShowParams = TRUE;
break;
case DM_NOTIFY_FIRE_DATA:
// the data sended with DMFireNotifyData is char text
printf("\r\nDM_NOTIFY_CLASS_DATA: DM_NOTIFY_FIRE_DATA:
(data as text: [%s])",
(char*)lpbyData);
bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_DATA:
bShowParams = TRUE;
}
break;
default:
printf("\r\nunknown dwNotifyClass[%08lx],
dwNotifyCode[%08lx]",
dwNotifyClass,
dwNotifyCode);
bShowParams = TRUE;
}
if (bShowParams)
{
printf("\r\ndwNotifyClass=%08lx, dwNotifyCode=%08lx,
dwItems=%ld, lpbyData=%08lx, lpvUser=%08lx",
dwNotifyClass,
dwNotifyCode,
dwItems,
lpbyData,
(DWORD)lpvUser);
}
if (bSpecialActionRemoveNotify)
{
printf("\r\nHave to remove notify if RT exits:");
RemoveNotify();
}
printf("\r\n#### extra added Notify [%08lx] exit ####\r\n",

(DWORD)lpvUser);

return TRUE;
}
3.2.3.3 DMChangeDataLocale (RT Professional)
Utilización
Lanza el aviso a todas las aplicaciones conectadas con DMConnect al cambiar el idioma de
runtime.
Declaración
BOOL DMChangeDataLocale (
LPCTSTR lpszProjectFile,
DWORD dwLocaleID,
LPCMN_ERROR lpdmError );
Parámetros
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
dwLocaleID
Puntero al código del nuevo idioma ajustado. Los valores posibles son los códigos de todos
los idiomas configurados en la librería de textos.
lpdmError
Valor de retorno
TRUE
Aplicaciones informadas del cambio de idioma.
FALSE
Error.

Comentario
La aplicación se notificada a través de la función Callback DM_NOTIFY_PROC
(Página 1654) con los siguientes parámetros:
dwNotifyClass DM_NOTIFY_CLASS_WARNING
dwNotifyCode DM_NOTIFY_DATA_LOCALE
lpbyData Puntero al código del nuevo idioma que debe ajus‐
tarse.
Mensajes de error
DM_E_NOT_CONNECTED Sin conexión con el administrador de datos

DM_E_NOT_SUPPORTED Servicio solicitado no disponible
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
AUTOHOTSPOT Establecer conexión con el administrador de datos
Consulte también
DM_NOTIFY_PROC (Página 1654)
DMGetRuntimeProject (Página 1684)
3.2.3.4 DMConnect (RT Professional)
Utilización
Establecimiento de conexión de una aplicación con el administrador de datos. En una
aplicación (proceso) sólo puede realizarse un DMConnect. Las siguientes llamadas devuelven
el error DM_E_ALREADY_CONNECTED.

Declaración
BOOL DMConnect (
LPTSTR lpszAppName,
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
Parámetros
lpszAppName
Puntero al nombre de la aplicación que efectúa la llamada. Se puede seleccionar cualquier
nombre ya que el parámetro sirve como identificación interna.
La longitud del nombre de la aplicación está limitada en MAX_DM_APP_NAME (32
caracteres). Los nombres más largos producen errores en el OHIOIPC.DLL subordinado y la
cancelación con el error DM_E_NOT_CONNECTED.
lpfnNotify
Puntero a la función de notificación para enviar mensajes administrativos del administrador
de datos a la aplicación.
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear notificaciones de WinCC y, con ello, todo el
WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
La rutina Notify también debe estar disponible después de DMDisConnect, ya que pueden
llegar llamadas atrasadas.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Conexión con el administrador de datos establecida.
FALSE
Error.

Comentario
En las variantes de WinCC que se implementan en las plataformas del sistema operativo que
soportan multithread, las llamadas a la función de notificación se realizan de forma asíncrona
respecto al proceso que efectúa la llamada.
Se debe configurar una sincronización apropiada dentro de la aplicación.
Si en un programa se distribuyen funciones del administrador de datos entre varios threads,
ejecute en cada uno de los threads un DMConnect y al final un DMDisconnet.
Compruebe primero con DMGetConnectionState si otro thread ya ha establecido una
conexión. Si ya existe una conexión, no se debe ejecutar DMConnect ni DMDisConnect.
Para evitar este conflicto, agrupe en un solo thread las llamadas de función al administrador
de datos y ejecute la llamada sólo desde ahí.
Si las funciones del administrador de datos se transfieren a una DLL que se ha integrado en
una aplicación con funciones de administrador de datos, compruebe si puede realizar la
conexión y la desconexión en la DLL. En este caso, la aplicación debe asegurar cada una de
las llamadas de función del administrador de datos con DMGetConnectionState. No obstante,
el encapsulado de threads en la DLL no ofrece ninguna seguridad antes de la desconexión.
Defina un único establecimiento de conexión en un indicador, para que DMDisConnect sólo
se ejecute en caso de que se desee.
Una llamada DMConnect no comprobada con Notify que devuelve el mensaje de error
DM_E_ALREADY_CONNECTED puede cancelar el Notify de una llamada anterior y ocasionar
resultados no deseados.
Los punteros a las áreas de datos transferidos en la función de rellamada sólo tienen validez
dentro de la función, es decir, tras el retorno de Callback el administrador de datos autoriza
posibles áreas de memoria asignadas. Si la aplicación necesita acceder a los datos después
del tiempo de llamada, debe copiarlos adecuadamente.
Además, existen punteros a las áreas de memoria de las plataformas que lo soportan,
exclusivamente acceso a lectura, de modo que un acceso de escritura a los datos relevantes
provoca una violación de protección.
Actualmente no se evalúa el valor de retorno de Callback, pero será relevante en futuras
versiones. La aplicación generalmente debe devolver TRUE.
Las DLL de API no deben utilizarse directamente en los servicios (ISS), ya que no tienen
disponibles los recursos internos necesarios.
Si se utilizan las funciones del administrador de datos, por ejemplo, en un Wrapper de un
entorno gestionado (C#), tenga en cuenta que en el mismo proceso se utilizan varios
ApplicationDomains de una aplicación. Por eso sólo está permitido un DMConnect en todos
los ApplicationDomains.

Mensajes de error
DM_E_ALREADY_CONNECTED La conexión con el administrador de datos ya exis‐

te.
DM_E_NOT_CONNECTED No se ha podido establecer la conexión con el ad‐
ministrador de datos (p. ej., por un nombre de apli‐
cación largo, ...).
DM_E_ACCESS_FAULT Sin derechos para establecer conexión con el ad‐
ministrador de datos
(contexto de usuario no válido, p. ej., en servicios
ISS, ...).
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DMDisconnect (Página 1658) Deshacer conexión con el administrador de datos

DMGetConnectionState (Página 1670) Comprobar conexión con el administrador de da‐
tos
DM_NOTIFY_PROC (Página 1654) Función de notificación
Ejemplos
Connection to DM (Página 1851) "DM01.cpp"
Consulte también
DM_NOTIFY_PROC (Página 1654)
DMDisconnect (Página 1658)
DMGetConnectionState (Página 1670)
Connection to DM (Página 1851)
APConnect (Página 1983)
3.2.3.5 DM_NOTIFY_PROC (RT Professional)
Descripción
Para que la aplicación pueda ser notificada, p. ej., de cambios de idioma, es preciso facilitar
una función Callback del tipo DM_NOTIFY_PROC.

Declaración
BOOL ( * DM_NOTIFY_PROC) (
DWORD dwNotifyClass,
DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser);
Parámetros
dwNotifyClass
Indica la clase de notificación:
DM_NOTIFY_CLASS_ERROR (0x00000001)
DM_NOTIFY_CLASS_WARNING (0x00000002)
DM_NOTIFY_CLASS_DATA (0x00000003)
dwNotifyCode
Código de notificación
Para DM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_SHUTDOWN (0x00000001) Se finaliza el administrador de
datos
DM_NOTIFY_PROCESSNET_ERROR (0x00000002) Error en el bus de procesos
DM_NOTIFY_SYSNET_ERROR (0x00000003) Error en el bus de sistemas
Para DM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT (0x00000001) Nivel de llenado de la cola de
aplicación 50%
aplicación 60%
aplicación 70%
aplicación 80%
aplicación 90%
DM_NOTIFY_QUEUE_OVERFLOW (0x00000006) Rebase de la cola de aplicación
DM_NOTIFY_CYCLES_CHANGED (0x00000010) Volver a leer ciclos de actualiza‐
ción
DM_NOTIFY_MACHINES_CHANGED (0x00000011) Volver a leer lista de equipos
DM_NOTIFY_PROJECT_OPENED (0x00000012) El proyecto se carga
DM_NOTIFY_PROJECT_CLOSE (0x00000013) El proyecto se cierra
DM_NOTIFY_SYSTEM_LOCALE (0x00000014) Cambiar idioma de configuración
DM_NOTIFY_DATA_LOCALE (0x00000015) Cambiar el idioma de la interfaz
de usuario
DM_NOTIFY_PROJECT_RUNTIME (0x00000016) El proyecto se activa

DM_NOTIFY_PROJECT_EDIT (0x00000017) El proyecto se desactiva

DM_NOTIFY_HOTKEY_CHANGE (0x00000018) Se ha modificado una tecla de
acceso directo
Para DM_NOTIFY_CLASS_DATA:
DM_NOTIFY_APPLICATION_DATA (0x00000001) Datos de aplicación
DM_NOTIFY_VARIABLE_DATA (0x00000002) Datos de variables
Encontrará más información acerca de los códigos de notificación en la descripción de

constantes.
lpbyData
Puntero a los datos notificados dentro de la clase DM_NOTIFY_CLASS_DATA.
dwItems
Número de entradas en lpbyData.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
Los valores de retorno dependen de su implementación.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función DMConnect.
Archivos necesarios
dmclient.h

Ejemplos
AUTOHOTSPOT "DM01.cpp"
Consulte también
DMConnect (Página 1649)
3.2.3.6 DMDeactivateRTProject (RT Professional)
Utilización
El proyecto ubicado en el modo runtime se desactiva.
Declaración
BOOL DMDeactivateRTProject (
Parámetros
lpdmError
Valor de retorno
TRUE
Proyecto desactivado.
FALSE
Error.
Mensajes de error
DM_E_NO_RT_PRJ Ningún proyecto en modo runtime
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Ejemplos
OnTestDeactivateRuntimeProject (Página 1863) "TESTCDoc.cpp"
Consulte también
OnTestDeactivateRuntimeProject (Página 1863)
3.2.3.7 DMDisconnect (RT Professional)
Utilización
Con esta función una aplicación deshace una conexión existente con el administrador de
datos.
Declaración
BOOL DMDisConnect (
Parámetros
lpdmError
Valor de retorno
TRUE
Conexión interrumpida.
FALSE
Error.

Observaciones
Si no se ha inicializado ninguna conexión con el administrador de datos con la función
DMConnect, el valor de retorno es FALSE. El código de error lpdmError->dwError contiene el
valor DM_E_NOT_CONNECTED, sin conexión con el administrador de datos.
Nota
La llamada no puede utilizarse en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a unos mecanismos específicos de Microsoft, existe la posibilidad de que la llamada quede
"colgada" y, por tanto, también el programa.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Connection to DM (Página 1851) "DM01.cpp"
Consulte también
3.2.3.8 DMEnumNumberFormats (RT Professional)
Utilización
La función lista todas las conversiones de formato disponibles en FORMAT.DLL .

Declaración
BOOL DMEnumNumberFormats (
LPDWORD lpdwItems,
DM_ENUM_FORMATS_PROC lpfnFormat,
LPVOID lpvUser,
Parámetros
lpdwItems
Puntero a una variable de palabra doble de la aplicación que tras la llamada contiene la
cantidad de información de formato enumerada.
lpfnFormat
Puntero a la función Callback que se llama para cada formato de número disponible.
lpvUser
lpdmError
Valor de retorno
TRUE
Conversiones de formato listadas.
FALSE
Error.
Observaciones
Los punteros transferidos en la función Callback sólo tienen validez dentro de ella, ya que el
sistema vuelve a autorizar todas las posibles áreas de memoria asignadas tras el retorno de
la función. Si una aplicación requiere acceso externo a los datos, debe copiarlos
adecuadamente.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
DM_ENUM_FORMATS_PROC (Página 1661)
3.2.3.9 DM_ENUM_FORMATS_PROC (RT Professional)
Descripción
Para poder evaluar las conversiones de formato listadas en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_FORMATS_PROC.
Declaración
BOOL ( * DM_ENUM_FORMATS_PROC) (
LPDM_FORMAT_INFO lpdmFormat,
DWORD dwItem,
LPVOID lpvUser );
Parámetros
lpdmFormat
Puntero a una estructura del tipo DM_FORMAT_INFO (Página 1590) con datos de una
conversión de formato.
dwItem
Contador de llamadas continuo. Si la enumeración no se cancela prematuramente, dwItem
contiene el número de conversiones de formato disponibles.
lpvUser
función Callback.

Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
Archivos necesarios
dmclient.h
DMEnumNumberFormats (Página 1657) Listar conversiones de formato
Consulte también
DMEnumNumberFormats (Página 1657)
DM_FORMAT_INFO (Página 1590)
3.2.3.10 DMEnumUpdateCycles (RT Professional)
Utilización
La función lista todos los ciclos de actualización definidos en el sistema. La función transfiere
en cada llamada de la función Callback una estructura de información para el ciclo.
Declaración
BOOL DMEnumUpdateCycles (
LPCSTR lpszProjectFile,
LPDWORD lpdwItems,
DM_ENUM_CYCLES_PROC lpfnCycle,
LPVOID lpvUser,

Parámetros
lpszProjectFile
lpdwItem
cantidad de información de ciclo enumerada.
lpfnCycle
Puntero a la función Callback que se llama para cada ciclo de actualización disponible.
lpvUser
lpdmError
Valor de retorno
TRUE
Ciclos de actualización listados
FALSE
Error
Observaciones
Los punteros transferidos en la función Callback sólo tienen validez dentro de la función, ya
que el sistema vuelve a autorizar todas las posibles áreas de memoria asignadas tras el
retorno de la función.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Ejemplos
OnTestUpdateCycles (Página 1871) "TESTCDoc.cpp"
Consulte también
DM_ENUM_CYCLES_PROC (Página 1664)
OnTestUpdateCycles (Página 1871)
3.2.3.11 DM_ENUM_CYCLES_PROC (RT Professional)
Descripción
Para poder evaluar los ciclos de actualización listados en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_CYCLES_PROC.
Declaración
BOOL ( * DM_ENUM_CYCLES_PROC) (
LPDM_CYCLE_INFO lpdmCycle,
DWORD dwItem,
LPVOID lpvUser);
Parámetros
lpdmCycle
Puntero a una estructura del tipo DM_CYCLE_INFO (Página 1586) con datos de un ciclo de
actualización.
dwItem
Contador de llamadas continuo. Si la enumeración no se cancela prematuramente, dwItem
contiene el número de ciclos de actualización disponibles.
lpvUser
función Callback.

Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h
DMEnumUpdateCycles (Página 1660) Listar ciclos de actualización
Consulte también
DMEnumUpdateCycles (Página 1660)
DM_CYCLE_INFO (Página 1586)
3.2.3.12 DMExitWinCC (RT Professional)
Utilización
Esta función finaliza WinCC.
Declaración
BOOL DMExitWinCC (
VOID);

Parámetros
Ninguno
Observaciones
Asimismo, la función DMExitWinCCEx determina el comportamiento del sistema operativo
tras finalizar WinCC.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DMExitWinCCEx (Página 1666) Finalizar WinCC con valores predeterminados
Ejemplos
OnTestWinCCShutdown (Página 1888) "TESTCDoc.cpp"
Consulte también
OnTestWinCCShutdown (Página 1888)
DMExitWinCCEx (Página 1666)
3.2.3.13 DMExitWinCCEx (RT Professional)
Utilización
Esta función finaliza WinCC. Además se puede determinar cómo debe comportarse el sistema
operativo tras finalizar WinCC.
Declaración
BOOL DMExitWinCCEx (
DWORD dwMode );

Parámetros
dwMode
dwMode permite determinar diferentes modos de comportamiento del sistema operativo tras
finalizar WinCC.
DM_SDMODE_WINCC WinCC se finaliza

DM_SDMODE_LOGOFF Tras finalizar WinCC también se cierra la sesión
del usuario.
DM_SDMODE_SYSTEM Tras finalizar WinCC se cierra el sistema operati‐
vo.
DM_SDMODE_REBOOT Tras finalizar WinCC se vuelve a arrancar el siste‐
ma operativo.
Observaciones
Con el parámetro DM_SDMODE_WINCC la función tiene los mismos efectos que
DMExitWinCC.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DMExitWinCC (Página 1663) Finalizar WinCC
Consulte también
DMExitWinCC (Página 1663)
3.2.3.14 DMFireNotifyData (RT Professional)
Declaración
BOOL DMFireNotifyData (
DWORD dwNotifyCookie,
DWORD dwByteCount,
LPBYTE lpbyData,

Descripción
Envía una Notify adicional a una Notify incorporada por medio de la identificación de cookie
indicada.
Parámetros
dwNotifyCookie
Cookie de una función Notify adicional incorporada con "DMAddNotify".
Si está indicado "0", los datos Notify se envían a todas las Notifies activas (broadcast).
dwByteCount
Tamaño del búfer de datos que hay que enviar en "BYTE".
lpbyData
Puntero a un búfer "BYTE" que contiene los datos Notify que hay que enviar.
El tamaño del búfer se indica con "dwByteCount".
lpdmError
Valor de retorno
TRUE
Datos Notify enviados.
FALSE
Error
Observaciones
La Notify enviada se procesa en la rutina Notify activada en
"dwNotifyClass=DM_NOTIFY_CLASS_DATA" y "dwNotifyCode=DM_NOTIFY_FIRE_DATA".
Si se ejecuta "DMDisconnect" sin borrar antes las funciones Notify adicionales, vuelve a
enviarse al final un "DM_NOTIFY_SHUTDOWN" a todas estas funciones Notify, que se
borrarán entonces internamente con la administración. A continuación podrán desecharse la
conexión y las cookies, ya que dejan de ser válidas.
Mensajes de error
DM_E_NOT_CONNECTED "DMConnect" aún sin ejecutar o "DMDisconnect"

ya ejecutado
DM_E_DONT_EXIST No existe Notify para la cookie indicada

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMAddNotify Incorpora una función Notify adicional a

"DMClient"
DMFireNotify Elimina la función Notify adicional de la lista Notify
por medio de la cookie
Ejemplos
Button DMFireNotifyData:
{
DWORD dwNotifyCookie;
CHAR* pszNotifyText;
CMN_ERROR err;
BOOL bRet;
pszNotifyText = GetTagChar("DMNotifySendText");
memset(&err, 0, sizeof(err));
bRet = FALSE;
bRet = DMFireNotifyData(dwNotifyCookie,
strlen(pszNotifyText)*sizeof(CHAR)+1,
(LPBYTE)pszNotifyText, &err);
if (FALSE == bRet)
{
printf("\r\nERROR: DMFireNotifyData [%s],%ld,%ld,%ld,%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}

3.2.3.15 DMGetConnectionState (RT Professional)
Utilización
Esta función consulta si existe una conexión con el administrador de datos, p. ej., para verificar
si la llamada de función DMConnect se ha ejecutado correctamente.
Declaración
BOOL DMGetConnectionState (
Parámetros
lpdmError
Valor de retorno
TRUE
La conexión existe.
FALSE
Error o la conexión no existe.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Ejemplos
AUTOHOTSPOT "DM01.cpp"
Consulte también
3.2.3.16 DMGetDataLocale (RT Professional)
Utilización
La función determina la ID del idioma actualmente ajustado de runtime.
Declaración
BOOL DMGetDataLocale (
LPDWORD lpdwLocaleID,
Parámetros
lpdwLocaleID
Puntero al código del idioma ajustado actual. Los valores de retorno son los códigos de todos
los idiomas configurados en la librería de textos.
lpdmError
Valor de retorno
TRUE
ID de idioma determinada.
FALSE
Error.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.3.17 DMGetHotkey (RT Professional)
Utilización
Esta función determina la tecla de acceso directo correspondiente a una acción.
Declaración
BOOL DMGetHotKey (
DWORD dwHotKeyAction,
LPDWORD lpdwHotKey,
Parámetros
dwHotKeyAction
Acción
lpdwHotKey
Puntero al lugar de la memoria en que se almacena la tecla de acceso directo.
lpdmError
Valor de retorno
TRUE
ID de tecla de acceso directo determinada.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib

dmclient.dll
3.2.3.18 DMGetMachineInfo (RT Professional)
Utilización
Con esta función una aplicación determina su parámetro de arranque en función del equipo.
No obstante, para ello la aplicación debe haber realizado previamente las correspondientes
entradas para las propiedades del equipo con las funciones del administrador de proyectos.
Declaración
BOOL DMGetMachineInfo (
LPCSTR lpszLogicalName,
LPVOID lpvData,
LPDWORD lpdwSize,
Parámetros
lpszLogicalName
Puntero al nombre lógico de la DLL de Explorer cuyos parámetros de arranque se consultan.
lpvData
Puntero a un área de datos por la que se transfieren los datos del parámetro de arranque a
la aplicación.
lpdwSize
Si lpvData = 0, en lpdwSize se indica el tamaño del área de datos.
lpdmError
Valor de retorno
TRUE
Información sobre el PC local determinada.
FALSE
Error.

Mensajes de error

DM_E_MACHINE_NOT_FOUND PC no encontrado
DM_E_NO_INFO_FOUND No se ha encontrado información de arranque
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.3.19 DMGetMachineTable (RT Professional)
Utilización
Esta función permite obtener, además del número de PCs implicados en el proyecto,
información acerca de PCs individuales.
Declaración
BOOL DMGetMachineTable (
LPDM_MACHINE_TABLE lpdmMachineTable,
Parámetros
lpdwProjectFile
lpdmMachineTable
Puntero a la estructura DM_MACHINE_TABLE (Página 1591), en la que se guardan los datos
de la lista de equipos.
lpdmError

Valor de retorno
TRUE
Datos de la lista de equipos determinados.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestMachines (Página 1866) "TESTCDoc.cpp"
Consulte también
DM_MACHINE_TABLE (Página 1591)
OnTestMachines (Página 1866)
DMActivateRTProject (Página 1640)
3.2.3.20 DMRemoveNotify (RT Professional)
Declaración
BOOL DMRemoveNotify (
DWORD dwNotifyCookie,
Descripción
Borra una función Notify incorporada adicionalmente de la lista Notify adicional por medio de
su identificación de cookie.
Esta función está disponible a partir de la versión V7.2 de WinCC.

Parámetros
dwNotifyCookie
Cookie de una función Notify adicional incorporada con "DMAddNotify".
lpdmError
Valor de retorno
TRUE
Función Notify adicional eliminada.
FALSE
Error
Observaciones
Si se ejecuta "DMDisconnect" sin borrar antes las funciones Notify adicionales, vuelve a
enviarse al final un "DM_NOTIFY_SHUTDOWN" a todas estas funciones Notify, que se
borrarán entonces internamente con la administración. A continuación podrán desecharse la
conexión y las cookies, ya que dejan de ser válidas.
Mensajes de error
DM_E_NOT_CONNECTED "DMConnect" aún sin ejecutar o "DMDisconnect"

ya ejecutado
DM_E_DONT_EXIST No existe Notify para la cookie indicada
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMFireNotifyData Envía datos a la función Notify adicional por medio

de la cookie o a todas las funciones
DMAddNotify Incorpora una función Notify adicional a
"DMClient"

Ejemplos
Button RemoveNotify:
{
RemoveNotify ();
}
Project-Function RemoveNotify:
void RemoveNotify()
{
DWORD dwNotifyCookie = 0L;
CMN_ERRORA err;
BOOL bRet = FALSE;
if (dwNotifyCookie)
{
bRet = DMRemoveNotify(dwNotifyCookie, &err);
if (bRet)
{
printf("\r\nNotify [%08lx] removed", dwNotifyCookie);
dwNotifyCookie = 0L;
}
else
{
printf("\r\nERROR: DMRemoveNotifyA [%s],%ld,%ld,%ld,
%ld,%ld, Cookie=%08lx",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5,
dwNotifyCookie);
}
}
else
{
printf("\r\nNo Notify present to remove!");
}
}

3.2.4 Funciones para la administración de proyectos (RT Professional)
3.2.4.1 DMEnumOpenedProjects (RT Professional)
Utilización
Llama para cada proyecto abierto en WinCC la función Callback transferida.
Declaración
BOOL DMEnumOpenedProjects (
LPDWORD lpdwItems,
DM_ENUM_OPENED_PROJECTS_PROC lpfnEnum,
LPVOID lpvUser,
Parámetros
lpdwItems
Puntero a una variable de palabra doble en la que se almacena el número de proyectos
abiertos tras finalizar la enumeración.
lpfnEnum
Puntero a la función Callback que recibe los datos del proyecto.
lpvUser
lpdmError
Valor de retorno
TRUE
Proyectos listados.
FALSE
Error.

Observaciones
Actualmente sólo se abre un proyecto en WinCC. Por tanto sólo se obtiene información acerca
de dicho proyecto.
Mensajes de error
DM_E_FILE Error en la operación con archivos
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_ENUM_OPENED_PROJECTS_PROC (Pági‐ Listar proyectos abiertos (Callback)

na 1679)
Ejemplos
Enum open projects (Página 1856) "DM01.cpp"
OnTestOpenProjects (Página 1870) "TESTCDoc.cpp"
Consulte también
DM_PROJECT_INFO (Página 1592)
Enum open projects (Página 1856)
OnTestOpenProjects (Página 1870)
DMChangeDataLocale (Página 1648)
3.2.4.2 DM_ENUM_OPENED_PROJECTS_PROC (RT Professional)
Descripción
Para poder evaluar los proyectos listados por el sistema debe proporcionarse una función
Callback del tipo DM_ENUM_OPENED_PROJECTS_PROC.

Declaración
BOOL ( * DM_ENUM_OPENED_PROJECTS_PROC) (
LPDM_PROJECT_INFO lpInfo,
LPVOID lpvUser);
Parámetros
lpInfo
Puntero a una estructura del tipo DM_PROJECT_INFO (Página 1592) con información sobre
un proyecto abierto.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Observaciones
Actualmente sólo se puede abrir un proyecto en WinCC. Por tanto sólo se obtiene información
acerca de dicho proyecto.
Nota
Archivos necesarios
dmclient.h
DMEnumOpenedProjects (Página 1676) Listar proyectos (abiertos)

Ejemplos
Enum open projects "DM01.cpp"
Consulte también
Enum open projects (Página 1856)
3.2.4.3 DMGetProjectDirectory (RT Professional)
Utilización
Proporciona a la aplicación la ruta válida de los datos de configuración para el proyecto
transferido.
Declaración
BOOL DMGetProjectDirectory (
LPCSTR lpszAppName,
LPDM_DIRECTORY_INFO lpdmDirInfo,
Parámetros
lpszAppName
Puntero al nombre de la aplicación para la que se determina la ruta.
lpszProjectFile
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects.
lpdmDirInfo
Puntero a la estructura DM_DIRECTORY_INFO (Página 1588), en la que se guardan las rutas
de los datos de configuración.
lpdmError

Valor de retorno
TRUE
Indicaciones de ruta determinadas.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestProjectPaths (Página 1868) "TESTCDoc.cpp"
Consulte también
DM_DIRECTORY_INFO (Página 1588)
OnTestProjectPaths (Página 1868)
3.2.4.4 DMGetProjectInformation (RT Professional)
Utilización
Determina información relevante sobre el proyecto transmitido como indicaciones de ruta,
Data Source Name, configuración del equipo, etc.
Declaración
BOOL DMGetProjectInformation (
LPDM_PROJECT_INFO lpProjectInfo,

Parámetros
lpszProjectFile
RT con DMGetRuntimeProject.
lpProjectInfo
Puntero a la estructura DM_PROJECT_INFO (Página 1592), en la que debe guardarse la
información del proyecto.
lpdmError
Valor de retorno
TRUE
Información del proyecto determinada
FALSE
Error
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Inquire project informations (Página 1862) "DM01.cpp"
OnTestProjectInfo (Página 1867) "TESTCDoc.cpp"
Consulte también
Inquire project informations (Página 1862)
OnTestProjectInfo (Página 1867)

3.2.4.5 DMGetRuntimeProject (RT Professional)
Utilización
Proporciona el nombre de archivo del proyecto ubicado en el modo Online. Para determinar
tras la ejecución correcta todos los demás datos del proyecto, la aplicación que efectúa la
llamada recuerda el nombre de archivo del proyecto registrado en lpszProjectFile.
Declaración
BOOL DMGetRuntimeProject (
LPSTR lpszProjectFile,
DWORD dwBufSize,
Parámetros
lpszProjectFile
Búfer para incluir el nombre del archivo de proyecto, ruta y extensión incluidas. El búfer debe
tener un tamaño mínimo de _MAX_PATH caracteres.
dwBufSize
El tamaño en caracteres del búfer transmitido.
lpdmError
Valor de retorno
TRUE
Nombre del proyecto activado determinado.
FALSE
Error.
Observaciones
Entonces la llamada ya se ejecuta correctamente, cuando runtime arranca, pero no están
activados todos los componentes.

Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Read tag (Página 1890) "DM02.cpp"
Write tag (Página 1895) "DM02.cpp"
OnTestRuntimeProject (Página 1870) "TESTCDoc.cpp"
Consulte también
Read tag (Página 1890)
Write tag (Página 1895)
OnTestRuntimeProject (Página 1870)
DMChangeDataLocale (Página 1648)
3.2.4.6 DMOpenProjectDocPlus (RT Professional)
Utilización
Abre el proyecto indicado en lpszProjectFile.
Declaración
BOOL DMOpenProjectDocPlus (
Parámetros
lpszProjectFile
Puntero al nombre del archivo de proyecto que hay que abrir, ruta y extensión incluidas.

El nombre de habilitación creado implícitamente en WinCC (p. ej. WinCC50_Project_Odk) no

puede utilizarse como ruta, ya que sólo existe mientras el proyecto está abierto.
lpdmError
Valor de retorno
TRUE
Proyecto abierto.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.4.7 DMOpenProjectPlus (RT Professional)
Utilización
Selecciona un archivo de proyecto en el diálogo de selección estándar del sistema. Si el
proyecto aún no está abierto en WinCC, se carga la información necesaria para el proyecto.
En una ejecución correcta, la aplicación que efectúa la llamada debe recordar el nombre de
archivo del proyecto registrado en lpszProjectFile para poder determinar todos los demás
datos del proyecto.
El nombre del archivo de proyecto también puede determinarse más adelante con
DMEnumOpenedProjects.
Declaración
BOOL DMOpenProjectPlus (
HWND hwndParent,
DWORD dwBufSize,

Parámetros
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpszProjectFile
Puntero al búfer para incluir el nombre del archivo de proyecto, ruta y extensión incluidas. El
búfer debe tener un tamaño mínimo de _MAX_PATH caracteres.
En la llamada de la función, lpszProjectFile debe ser una string vacía o una ruta válida de un
proyecto existente.
Si lpszProjectFile es una string vacía, se llama el diálogo de selección estándar del sistema
(véase arriba).
Si lpszProjectFile no está vacío, WinCC interpreta que la cadena de caracteres que contiene
lpszProjectFile es la ruta del proyecto e intenta abrirla sin diálogo de selección.
El nombre de habilitación creado implícitamente en WinCC (p. ej. WinCC50_Project_Odk) no
puede utilizarse como ruta del proyecto, ya que sólo existe mientras el proyecto está abierto.
dwBufSize
El tamaño en caracteres del búfer transmitido.
lpdmError
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR"
Observaciones
El proceso de apertura de un proyecto puede tardar varios minutos.
Mensajes de error
DM_E_CANCEL El usuario ha seleccionado "Cancelar" en un cuadro

de diálogo
DM_E_UPDATE El proyecto se está actualizando

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Open project by means of dialog (Página 1889) "DM01.cpp"
OnTestOpenProject (Página 1869) "TESTCDoc.cpp"
Consulte también
Open project by means of dialog (Página 1889)
OnTestOpenProject (Página 1869)
3.2.5 Canales de transporte de datos (RT Professional)
3.2.5.1 DMClearBlockQueue (RT Professional)
Utilización
Borra todas las entradas existentes en la cola de espera de notificaciones de la aplicación.
Declaración
BOOL DMClearBlockQueue (
Parámetros
lpdmError
Valor de retorno
TRUE
Cola de espera de notificaciones borrada.

FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.5.2 DMEnumDataServices (RT Professional)
Utilización
DMEnumDataServices llama la función Callback transferida para cada servicio instalado
mientras que la función Callback devuelva TRUE.
Declaración
BOOL DMEnumDataServices (
LPDWORD lpdwItems,
DM_ENUM_DATA_SERVICE_PROC lpfnEnum,
LPVOID lpvUser,
Parámetros
lpdwItems
cantidad de servicios enumerada.
lpfnEnum
Puntero a la función Callback que se llama para cada servicio instalado.
lpvUser

lpdmError
Valor de retorno
TRUE
Servicios listados.
FALSE
Error.
Comentario
Los punteros transferidos en la función Callback sólo tienen validez dentro de ella, ya que el
sistema vuelve a autorizar todas las posibles áreas de memoria asignadas tras el retorno de
la función. Si una aplicación requiere acceso externo a los datos, debe copiarlos
adecuadamente.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_ENUM_DATA_SERVICE_PROC (Pági‐ Listar canales de transporte de datos (Callback)

na 1691)
DMInstallDataService (Página 1694) Instalar canal de transporte de datos
Consulte también
DM_ENUM_DATA_SERVICE_PROC (Página 1691)
DMInstallDataService (Página 1694)

3.2.5.3 DM_ENUM_DATA_SERVICE_PROC (RT Professional)
Descripción
Para poder evaluar los canales de transporte de datos instalados listados en el sistema, es
preciso facilitar una función Callback del tipo DM_ENUM_DATA_SERVICE_PROC.
Declaración
BOOL ( * DM_ENUM_DATA_SERVICE_PROC) (
LPCSTR pszService,
DM_DATA_SERVICE_PROC pfnService,
LPVOID lpvUser );
Parámetros
pszService
Puntero al nombre lógico del canal de transporte de datos.
pfnService
Puntero a la función Callback del tipo DM_DATA_SERVICE_PROC (Página 1692), en la que
se proporcionan más datos de un servicio.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota

Archivos necesarios
dmclient.h
DMEnumDataServices (Página 1687) Listar canales de transporte de datos
Consulte también
DMEnumDataServices (Página 1687)
3.2.5.4 DM_DATA_SERVICE_PROC (RT Professional)
Descripción
Para que la aplicación pueda recibir datos, es preciso haber instalado un canal de transporte
de datos con DMInstallDataService y facilitar una función Callback del tipo
DM_DATA_SERVICE_PROC.
También se necesita una función Callback de este tipo, si se quieren evaluar los canales de
transporte (servicios) listados en el sistema.
Declaración
BOOL ( * DM_DATA_SERVICE_PROC) (
LPDM_DATA_SERVICE lpds,
LPVOID lpvUser);
Parámetros
lpds
Puntero a una estructura del tipo DM_DATA_SERVICE (Página 1587) con información sobre
un canal de transporte de datos (servicio) instalado.
lpvUser
función Callback.
Valor de retorno
TRUE
Según el uso de la función Callback.

FALSE
Error
Nota
WinCC.
Archivos necesarios
dmclient.h
DMInstallDataService (Página 1694) Instalar canal de transporte de datos

DM_ENUM_DATA_SERVICE_PROC (Pági‐ Listar canales de transporte de datos (Callback)
na 1689)
Consulte también
DM_ENUM_DATA_SERVICE_PROC (Página 1689)
DM_DATA_SERVICE (Página 1587)
DMInstallDataService (Página 1694)
3.2.5.5 DMGetNumPendingBlocks (RT Professional)
Utilización
Con esta función una aplicación determina las entradas existentes en su cola de espera.

Declaración
BOOL DMGetNumPendingBlocks (
LONG *plEntries,
Parámetros
plEntries
Contiene en una ejecución correcta de la función el número de paquetes de datos que hay
en la cola de espera de la aplicación.
lpdmError
Valor de retorno
TRUE
Número de entradas de la cola de espera determinado.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.5.6 DMInstallDataService (RT Professional)
Utilización
Instala un canal de transporte (servicio) para transferir datos entre aplicaciones. La función
señaliza la disponibilidad de la aplicación para recibir datos que se envían desde cualquier
otra aplicación bajo el nombre del servicio indicado. Si ya se ha instalado un servicio con el
nombre transmitido, la función de rellamada instalada se sustituye por la transmitida. Si
lpfnService == NULL se elimina el servicio instalado con lpszService.

Declaración
BOOL DMInstallDataService (
LPCSTR lpszService,
DM_DATA_SERVICE_PROC lpfnService,
LPVOID lpvUser,
Parámetros
lpszService
Puntero al nombre del servicio. Con él, a partir de los nombres libres asignables, se lleva a
cabo la identificación del canal de transporte.
lpfnService
Puntero a una función Callback que es llamada cuando los datos de este servicio se envían
a la aplicación.
WinCC.
lpvUser
lpdmError
Valor de retorno
TRUE
Canal de transporte de datos instalado.
FALSE
Error.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_DATA_SERVICE_PROC (Página 1690) Listar canales de transporte de datos (Callback)

Instalar canal de transporte de datos (Callback)
Consulte también
DMEnumDataServices (Página 1687)
3.2.5.7 DMSendApplicationData (RT Professional)
Utilización
Los datos transmitidos en lpdmSendData se envían a todas las aplicaciones que
corresponden a las condiciones definidas en la estructura DM_SEND_DATA_STRUCT y han
instalado el servicio descrito en szService con DMInstallDataService.
Declaración
BOOL DMSendApplicationData (
LPDM_SEND_DATA_STRUCT lpdmSendData,
Parámetros
lpdmSendData
Puntero a la estructura DM_SEND_DATA_STRUCT (Página 1593).
lpdmError
Valor de retorno
TRUE
Datos enviados a la aplicación.

FALSE
Error.
Comentario
La función sólo se implementa localmente.
Los miembros existentes en la estructura DM_SEND_DATA_STRUCT para acceso remoto a
"TargetMachine" están reservados para futura ampliación.
dwTargetMachineFlags sólo puede estar ocupado con DM_SD_LOCAL ; cualquier otra
información produce errores y dwTargetMachines debe ser 0L.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
3.2.5.8 DMSetBlockQueueSize (RT Professional)
Utilización
Con la función se define el número máximo de mensajes que aparecen en la cola de espera
de notificaciones de la aplicación.
Declaración
BOOL DMSetBlockQueueSize (
LONG nCount,
Parámetros
nCount
Número máximo de mensajes.
lpdmError

Valor de retorno
TRUE
Tamaño de la cola de espera definido.
FALSE
Error.
Comentario
El valor estándar de la plataforma de 32 bits es de 1000 entradas, lo que suele ser suficiente.
Cada mensaje ocupa memoria en el espacio de direcciones de la aplicación. Se recomienda
evitar el aumento del número de mensajes, ya que implica un procesamiento más lento en la
aplicación.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.6 Funciones para procesar variables (RT Professional)
3.2.6.1 DMEnumVarData (RT Professional)
Utilización
La función sirve para determinar datos acerca de objetos que están enlazados con una
variable, p. ej., grupo de variables correspondiente, unidad de canal, etc.

Declaración
BOOL DMEnumVarData (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DM_ENUM_VARIABLE_PROC lpfnEnum,
LPVOID lpvUser,
Parámetros
lpszProjectFile
lpdmVarKey
Puntero al principio de un campo de estructuras del tipo DM_VARKEY (Página 1612) mediante
las que se especifican las variables que hay que listar. Si a partir de la versión V5.0 de SP2
no se indica ninguna matriz y proporciona NULL, se enumeran todas las variables.
Si en DM_VARKEY se indica un nombre o un ID incorrecto, no hay ninguna indicación de
error ya que en una lista puede haber algunos válidos y algunos defectuosos. Para que el
usuario detecte una DM_VARKEY defectuosa, debe transmitir en Callback una estructura del
tipo DM_VARIABLE_DATA (Página 1607) que esté completamente ocupada con 0.
dwItems
Número de las variables cuyos datos se listan (= número de especificaciones de variables en
lpdmVarKey). Si el número se pone a 0, se enumeran todas las variables.
lpfnEnum
Puntero a la función Callback que recibe la información de una variable.
lpvUser
lpdmError
Valor de retorno
TRUE
Información sobre variables listada.

FALSE
Error
Comentario
Hay una función más avanzada: DMEnumVarData4.
Nota
Las implementaciones existentes de una enumeración multietapa de DMEnumVariables con
la llamada de DMEnumVarDataX en la función Callback para cada uno de los elementos debe
sustituirse por una llamada individual de DMEnumVarData4. Los filtros necesarios se llevan
a cabo en la propia función Callback. El cambio mejora el rendimiento considerablemente.
Mensajes de error

DM_E_INVALID_KEY Variable no encontrada
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
3.2.6.2 DM_ENUM_VARIABLE_PROC (RT Professional)
Descripción
Para poder evaluar la información de una variable listada en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_VARIABLE_PROC.

Declaración
BOOL ( * DM_ENUM_VARIABLE_PROC) (
LPDM_VARIABLE_DATA lpdmVarData,
LPVOID lpvUser
Parámetros
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 1612) para especificar las variables
que hay que listar.
lpdmVarData
Puntero a una estructura del tipo DM_VARIABLE_DATA (Página 1607) con información sobre
una variable.
Si la estructura está completamente ocupada con 0, en DM_VARKEY se ha indicado un
nombre o un ID incorrecto. Es posible consultar, p. ej., con lpdmVarData->dmTypeRef-
>dwType.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
La enumeración se cancela
Nota
Archivos necesarios
dmclient.h

DMEnumVarData (Página 1696) Listar información sobre una variable
Consulte también
3.2.6.3 DMEnumVarData4 (RT Professional)
Utilización
La función sirve para determinar datos acerca de objetos enlazados con una variable, p. ej.,
grupo de variables correspondiente o unidad de canal.
Se diferencia de DMEnumVarData por la salida adicional de los datos de escala.
Declaración
BOOL DMEnumVarData4 (
DWORD dwItems,
DM_ENUM_VARIABLE_PROC4 lpfnEnum,
LPVOID lpvUser,
Parámetros
lpszProjectFile
lpdmVarKey
Puntero al principio de un campo de estructuras del tipo DM_VARKEY (Página 1612) mediante
las que se especifican las variables que hay que listar. Si el parámetro proporciona NULL, se
enumeran todas las variables.
Si en DM_VARKEY se indica un nombre o un ID incorrecto, no hay ninguna indicación de
error ya que en una lista puede haber algunos válidos y algunos defectuosos. Para que el
usuario detecte una DM_VARKEY defectuosa, debe transmitir en Callback una estructura del
tipo DM_VARIABLE_DATA4 (Página 1609) que esté completamente ocupada con 0.

dwItems
Número de las variables cuyos datos deben listarse (= número de especificaciones de
variables en lpdmVarKey). Si el número está puesto a 0, se enumeran todas las variables.
lpfnEnum
Puntero a la función Callback que recibe la información de una variable.
lpvUser
lpdmError
Valor de retorno
TRUE
Información sobre variables listada.
FALSE
Error.
Comentario
Nota
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DM_ENUM_VARIABLE_PROC4 (Pági‐ Listar información sobre una variable (Callback)

na 1704)
Ejemplos
Enum Data of Tags (Página 1854) "DM01.cpp"
Consulte también
Enum Data of Tags (Página 1854)
3.2.6.4 DM_ENUM_VARIABLE_PROC4 (RT Professional)
Descripción
Para poder evaluar la información de una variable listada en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_VARIABLE_PROC4. Esta función Callback se
diferencia de DM_ENUM_VARIABLE_PROC por la salida adicional de los datos de escala
Declaración
BOOL ( * DM_ENUM_VARIABLE_PROC4) (
LPDM_VARIABLE_DATA4 lpdmVarData,
LPVOID lpvUser
Parámetros
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 1612) para especificar las variables
que hay que listar.
lpdmVarData
Puntero a una estructura del tipo DM_VARIABLE_DATA4 (Página 1609) con información
sobre una variable.
Si la estructura está completamente ocupada con 0, en DM_VARKEY se ha indicado un
nombre o un ID incorrecto. Es posible consultar, p. ej., con lpdmVarData->dmTypeRef-
>dwType.

lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h
DMEnumVarData4 (Página 1700) Listar información sobre una variable
Ejemplos
Enum Data of Tags (Página 1854) "DM01.cpp"
Consulte también
Enum Data of Tags (Página 1854)

3.2.6.5 DMEnumVarGrpData (RT Professional)
Utilización
La función proporciona la información acerca del grupo de variables mediante la función
Callback DM_ENUM_VARGRP_PROC, p. ej., nombre, CreatorID y número de variables en el
grupo.
Declaración
BOOL DMEnumVarGrpData (
LPDM_VARGRPKEY lpdmVarGrpKey,
DWORD dwItems,
DM_ENUM_VARGRP_PROC lpfnEnum,
LPVOID lpvUser,
Parámetros
lpszProjectFile
lpdmVarGrpKey
Puntero a la primera estructura del tipo DM_VARGRPKEY (Página 1606) , en la que se
especifica el grupo de variables.
dwItems
Número de grupos de variables cuyos datos se listan.
lpfnEnum
Puntero a la función Callback que recibe la información de un grupo de variables.
lpvUser
lpdmError

Valor de retorno
TRUE
Información de un grupo de variables listada.
FALSE
Error.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_ENUM_VARGRP_PROC (Pági‐ Listar información sobre un grupo de variables (Callback)

na 1709)
Ejemplos
OnTestEnumGroupsAll (Página 1863) "TESTCDoc.cpp"
Consulte también
DM_VARGRPKEY (Página 1606)
DM_ENUM_VARGRP_PROC (Página 1709)
OnTestEnumGroupsAll (Página 1863)

3.2.6.6 DMEnumVarGrpDataExStr (RT Professional)
Declaración
BOOL DMEnumVarGrpDataExStr (
LPTSTR lpszProjectFile,
DWORD dwFlags,
LPVARIANT lpvdmVarGrpKey,
LPDWORD lpdwVarGrpCount,
DM_ENUM_VARGRP_PROC_EXSTR lpfnEnum,
LPVOID lpvUser,
Descripción
La función proporciona información acerca de los grupos de variables mediante la función
Callback "DM_ENUM_VARGRP_PROC_EXSTR", p. ej., nombre, ID y número de variables en
el grupo.
Parámetros
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
dwFlags
Reservado para uso futuro. Debe ajustarse con "0L".
lpvdmVarGrpKey
Puntero a la primera de las estructuras del tipo "DM_VARGRPKEY" mediante la que se
especifican los grupos de variables.
Puntero a un VARIANT para la lista de grupos de variables. La lista debe crearse como
"VT_ARRAY | VT_VARIANT", ya que se indican diferentes tipos de datos mezclados como
"VT_I4", "VT_BSTR" y, bajo ciertas condiciones, también "VT_LPSTR". También puede
crearse un VARIANT sencillo si solo se indica una clave.
Si aquí se indica "NULL" o "VT_EMPTY", se enumeran todos los grupos.
lpdwVarGrpCount
Puntero a "DWORD" para el número de grupos de variables.
Con "lpfnCallback = NULL", primero se determina cuánta memoria se necesita para los grupos
de variables.

lpfnEnum
Puntero a la función Callback que recibe información de un grupo de variables.
lpvUser
que vuelve a ponerse a disposición en la función Callback.
lpdmError
error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Información del grupo de variables listada
FALSE
Error
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DM_ENUM_VARGRP_PROC_EXSTR Listar información sobre un grupo de variables (Callback)
3.2.6.7 DM_ENUM_VARGRP_PROC (RT Professional)
Descripción
Para poder evaluar la información de un grupo de variables listada en el sistema, es preciso
facilitar una función Callback del tipo DM_ENUM_VARGRP_PROC.

Declaración
BOOL ( * DM_ENUM_VARGRP_PROC) (
LPDM_VARGRP_DATA lpdmVarGrpData,
LPVOID lpvUser );
Parámetros
lpdmVarGrpData
Puntero a una estructura del tipo DM_VARGRP_DATA (Página 1605) con información sobre
el grupo de variables.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h
DMEnumVarGrpData (Página 1704) Listar información sobre un grupo de variables
Consulte también
DM_VARGRP_DATA (Página 1605)

3.2.6.8 DMEnumVariables (RT Professional)
Utilización
Con la función se listan los nombres de todas las variables que se corresponden con un criterio
de selección determinado. El criterio de selección se define en la estructura DM_VARFILTER .
Declaración
BOOL DMEnumVariables (
LPDM_VARFILTER lpdmVarFilter,
DM_ENUM_VAR_PROC lpfnEnum,
LPVOID lpvUser,
Parámetros
lpszProjectFile
lpdmVarFilter
Puntero a la estructura DM_VARFILTER (Página 1603), en la que se definen los criterios de
selección.
lpfnEnum
Puntero a la función Callback que recibe los nombres de variable.
lpvUser
lpdmError
Valor de retorno
TRUE
Nombres de variable listados.
FALSE
Error.

Comentario
Nota
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_ENUM_VAR_PROC (Página 1712) Listar nombres de variables (Callback)
Ejemplos
OnTestEnumVariables (Página 1864) "TESTCDoc.cpp"
Consulte también
DM_VARFILTER (Página 1603)
DM_ENUM_VAR_PROC (Página 1712)
OnTestEnumVariables (Página 1864)
3.2.6.9 DM_ENUM_VAR_PROC (RT Professional)
Descripción
Para poder evaluar los nombres de variable listados en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_VAR_PROC.
Declaración
BOOL ( * DM_ENUM_VAR_PROC) (
LPVOID lpvUser

Parámetro
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 1612) con el nombre de una variable.
lpvUser
función Callback.
Valor de retorno
TRUE
Son deseables más llamadas Callback.
FALSE
La serie Callback debe cancelarse.
Observación
ATENCIÓN
No se debe llamar ninguna otra función de DMClient en este Callback, ya que de lo contrario
se puede producir un bloqueo.
Nota
Archivos necesarios
dmclient.h
DMEnumVariables (Página 1709) Listar nombres de variables
Consulte también

3.2.6.10 DMGetValue (RT Professional)
Utilización
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
La función DMGetValueEx más avanzada, además proporciona en la estructura
DM_VAR_UPDATE_STRUCTEX el Quality Code.
Declaración
BOOL DMGetValue (
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
Parámetros
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 1612) que identifican los valores
de las variables que hay que leer.
dwItems
Número de estructuras transmitidas (equivale al número de valores de variables por leer).
lpdmvus
Puntero a la primera de las estructuras DM_VAR_UPDATE_STRUCT (Página 1598) que tras
el retorno de la función contienen los valores de variable.
lpdmError
Puntero a la primera estructura de error dwItems del tipo CMN_ERROR. Si aparece un error
al escribir una variable, el sistema escribe la información de error en la estructura
correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Valores determinados.
FALSE
Error.

Comentario
Para, p. ej., darle a una aplicación la posibilidad de administrar los ciclos por separado, se
indica en DMStartVarUpdate un puntero NULL como función Callback. A continuación, el
administrador de datos se encarga de la actualización de la variable en el ciclo solicitado, pero
delega a la aplicación la responsabilidad de leer a tiempo la memoria imagen de proceso.
Dado que puede haber solicitudes de actualización para una variable de varias aplicaciones
en diferentes ciclos, el administrador de datos siempre toma como base el ciclo más pequeño
solicitado para actualizar su memoria imagen de proceso.
Mensajes de error

DM_E_PARAM Parámetro no válido
DM_E_OOM Falta de memoria
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
lización
Ejemplos
Read tag (Página 1890) "DM02.cpp"
OnTestVariablenGetvalue (Página 1874) "TESTCDoc.cpp"
Consulte también
Read tag (Página 1890)
OnTestVariablenGetvalue (Página 1874)

3.2.6.11 DMGetValueEx (RT Professional)
Utilización
A diferencia de DMGetValue, en la estructura DM_VAR_UPDATE_STRUCTEX también se
devuelve el Quality Code.
Declaración
BOOL DMGetValueEx (
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
Parámetros
lpdmVarKey
dwItems
lpdmvus
Puntero a la primera de las estructuras DM_VAR_UPDATE_STRUCTEX (Página 1600) que
tras el retorno de la función contienen los valores de variable.
lpdmError
Valor de retorno
TRUE
FALSE
Error.

Comentario
Para, p. ej., darle a una aplicación la posibilidad de administrar los ciclos por separado, puede
indicarse en DMStartVarUpdate un puntero NULL como función Callback. A continuación, el
administrador de datos se encarga de la actualización de la variable en el ciclo solicitado, pero
delega a la aplicación la responsabilidad de leer a tiempo la memoria imagen de proceso.
Dado que puede haber solicitudes de actualización para una variable de varias aplicaciones
en diferentes ciclos, el administrador de datos siempre toma como base el ciclo más pequeño
solicitado para actualizar su memoria imagen de proceso.
Mensajes de error

DM_E_OOM out of memory
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
lización
Consulte también

3.2.6.12 DMGetValueExStr (RT Professional)
Declaración
BOOL DMGetValueExStr (
DWORD dwFlags,
LPVARIANT lpdmVarKey,
LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus,
DWORD dwdmvusCount,
Descripción
A diferencia de "DMGetValueEx", ya no se utiliza más la estructura "DM_VARKEY" para que
no haya ninguna limitación de longitud en el nombre de variable.
Parámetros
dmFlags
Si se necesita un retorno del nombre de variable en el VARIANT de la estructura
"DM_VAR_UPDATE_STRUCT_EXSTR" en formato "VT_LPSTR", aquí puede especificarse
el indicador "DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKey
Puntero a un VARIANT para la lista de variables. La lista debe crearse como "VT_ARRAY |
VT_VARIANT", ya que puede haber diferentes tipos de datos como "VT_I4", "VT_BSTR" y,
bajo ciertas condiciones, también "VT_LPSTR". Esto también vale para una única clave.
lpdmvus
Puntero a la primera de las estructuras "DM_VAR_UPDATE_STRUCT_EXSTR" que
contienen los valores de las variables tras el retorno de la función.
dwdmvusCount
Número de estructuras "DM_VAR_UPDATE_STRUCT_EXSTR" transferidas (equivale al
número de valores de variables por leer). El número debe coincidir con el tamaño de la matriz
Variant en "lpvdmVarKey".
lpdmError
Puntero a la primera de las estructuras de error "dwdmvusCount" del tipo "CMN_ERROR". Si
se produce un error al escribir una variable, el sistema escribe la información de error en la
estructura correspondiente. No hay que olvidar reservar espacio para estas estructuras.

Valor de retorno
TRUE
Valores determinados
FALSE
Error
Comentario
Para, p. ej., darle a una aplicación la posibilidad de administrar los ciclos por separado, puede
indicarse en "DMStartVarUpdate" un puntero "NULL" como función Callback. A continuación,
el administrador de datos se encarga de la actualización de la variable en el ciclo solicitado,
pero delega a la aplicación la responsabilidad de leer a tiempo la memoria imagen de proceso.
Dado que puede haber solicitudes de actualización para una variable por parte de varias
aplicaciones en diferentes ciclos, el administrador de datos siempre toma como base el ciclo
más pequeño solicitado para actualizar su memoria imagen de proceso.
Mensajes de error

Estos errores se devuelven solo en la primera estructura de error.
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMGetValueWaitExStr Determinar los valores de las variables con actua‐

lización
DMSetValueExStr Modificar valores de variables
Ejemplos
Ejemplo de script "Button DMGetValueExStr/DMSetValueExStr|DMGetValueWaitExStr/
DMSetValueWaitExStr":
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{

#pragma code ("kernel32.dll")

#define CP_ACP 0
int MultiByteToWideChar(UINT CodePage, DWORD dwFlags, LPCSTR
lpMultiByteStr, int cbMultiByte, LPWSTR lpWideCharStr, int
cchWideChar);
int WideCharToMultiByte(UINT CodePage, DWORD dwFlags, LPCWSTR
lpWideCharStr, int cchWideChar, LPSTR lpMultiByteStr, int
cbMultiByte, LPCSTR lpDefaultChar, LPBOOL lpUsedDefaultChar);
#pragma code()
#pragma code ("OleAut32.dll")

//#include "OleAuto.h"
SAFEARRAY * SafeArrayCreateVector(VARTYPE vt, long lLbound, unsigned
int cElements );
HRESULT SafeArrayPtrOfIndex(SAFEARRAY FAR* psa, long FAR* rgIndices,
void HUGEP* FAR* ppvData );
HRESULT SafeArrayLock(SAFEARRAY FAR* psa);
HRESULT SafeArrayUnlock(SAFEARRAY FAR* psa);
HRESULT VariantChangeType( VARIANTARG FAR* pvargDest, VARIANTARG
FAR* pvarSrc, unsigned short wFlags, VARTYPE vt);
typedef WCHAR OLECHAR;
BSTR SysAllocString(OLECHAR FAR* sz);
HRESULT SysFreeString(BSTR bstr);
#pragma code()
extern BOOL DM_NotifyVariableProcExStr_GetValueWait(DWORD dwTAID,

LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus, DWORD dwItems, LPVOID lpvUser);
extern BOOL DM_CompletitionProc(DWORD dwTAID, LPDWORD lpdmVarState,
DWORD dwItems, LPVOID lpvUser);
VARIANT vVarKey;
VARIANT* pvElem;
VARIANT vdmValue;
SAFEARRAY* parrayKeys;
SAFEARRAY* parrayValues;
DWORD dwVal[4];
DWORD dwState[4];
DWORD dwMerk;
CMN_ERROR err;
CMN_ERROR errArray[4];
DM_VAR_UPDATE_STRUCT_EXSTR dmvus[4];
HRESULT hr;
long lInx;
BOOL bRet;
DWORD dwFlags;
DWORD* pdwVarState;
DWORD dwTAID;
memset(dmvus, 0, sizeof(dmvus));
dwVal[0] = 1;
dwVal[1] = 2;

dwVal[2] = 3;
dwVal[3] = 4;
dwMerk = 0L;
memset(dwState, 0, sizeof(dwState));
pvElem = NULL;
parrayKeys = NULL;
parrayValues = NULL;
hr = 0L; //S_OK
lInx = 0L;
bRet = FALSE;
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
pdwVarState = dwState;
dwTAID = 0L;
printf("\r\n\r\n########## enter Test with DMGetValue(Wait)ExStr/

DMSetValue(Wait)ExStr ##########");
VariantInit(&vVarKey);
parrayKeys = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarKey.vt = VT_ARRAY | VT_VARIANT;
vVarKey.u.parray = parrayKeys;
SafeArrayLock(parrayKeys);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_1";
lInx = 1L;
lInx = 2L;
lInx = 3L;
SafeArrayUnlock(parrayKeys);
printf("\r\ncall DMGetValueExStr:");
bRet = DMGetValueExStr(dwFlags, &vVarKey, dmvus, 4L, &err);
if (bRet == FALSE)
{
printf("\r\n error DMGetValueExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else

{
int i = 0;
for (i = 0; i < 4; i++)
{
hr = VariantChangeType((VARIANTARG*)&(dmvus[i].vdmValue),
(VARIANTARG*)&(dmvus[i].vdmValue), 0, VT_I4);
if (hr)
{
printf("\r\n error VariantChangeType[%d] hr=%08lx",
i, hr);
}
else
{
if (dmvus[i].vdmValue.vt == VT_I4)
{
dwVal[i] = dmvus[i].vdmValue.u.lVal;
printf("\r\n Var[%d]:[%s] = %ld",
i, dmvus[i].vdmVarKey.u.pbVal,
dmvus[i].vdmValue.u.lVal);
}
else
{
printf("\r\n wrong datatype %ld, VT_I4 expected after
VariantChange",
dmvus[i].vdmValue.vt == VT_I4);
}
}
}
//clear the internal alloced Data, that no memoryleaks

//the vdmValues no need to clear here, while no PROPVARIANT here
given (double used)
//only the dmVarkey of dmvus have to free here
for (i = 0; i < 4; i++)
{
free(dmvus[i].vdmVarKey.u.pbVal);
dmvus[i].vdmVarKey.u.pbVal = NULL;
dmvus[i].vdmVarKey.vt = VT_EMPTY;
}
}
// change the values before set again

dwMerk = dwVal[0];
dwVal[0] = dwVal[3];
dwVal[3] = dwMerk;
dwMerk = dwVal[1];
dwVal[1] = dwVal[2];
dwVal[2] = dwMerk;
VariantInit(&vdmValue);
parrayValues = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmValue.vt = VT_ARRAY | VT_VARIANT;

vdmValue.u.parray = parrayValues;
SafeArrayLock(parrayValues);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[0];
lInx = 1L;
pvElem->vt = VT_I4;
lInx = 2L;
pvElem->vt = VT_I4;
lInx = 3L;
pvElem->vt = VT_I4;
SafeArrayUnlock(parrayValues);
printf("\r\ncall DMSetValueExStr:");
bRet = DMSetValueExStr(&vVarKey, &vdmValue, pdwVarState, &err);
if (bRet == FALSE)
{
printf("\r\n error DMSetValueExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
printf("\r\n dwVarState[%d] = %ld", i, dwState[i]);
}
}
// clear the values before read back again with DMGetValueWait

(timeout 2sec.)
dwVal[0] = 0;
dwVal[1] = 0;
dwVal[2] = 0;
dwVal[3] = 0;
printf("\r\ncall DMGetValueWaitExStr:");
bRet = DMGetValueWaitExStr(&dwTAID, dwFlags, &vVarKey, TRUE, 2000,
DM_NotifyVariableProcExStr_GetValueWait, dwVal, &err);

if (bRet == FALSE)
{
printf("\r\n error DMGetValueWaitExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
printf("\r\n dwValue[%d] = %ld", i, dwVal[i]);
}
}
//increment values for identify execute of following DMSetValueWait

dwVal[0] = dwVal[0] + 1;
if (dwVal[0] >= 100)
{
dwVal[0] = dwVal[0] - 100;
}
if (dwVal[1] >= 100)
{
dwVal[1] = dwVal[1] - 100;
}
if (dwVal[2] >= 100)
{
dwVal[2] = dwVal[2] - 100;
}
if (dwVal[3] >= 100)
{
dwVal[3] = dwVal[3] - 100;
}
VariantClear(&vdmValue);
parrayValues = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmValue.vt = VT_ARRAY | VT_VARIANT;
vdmValue.u.parray = parrayValues;
SafeArrayLock(parrayValues);
lInx = 0L;
pvElem->vt = VT_I4;
lInx = 1L;
pvElem->vt = VT_I4;
lInx = 2L;

pvElem->vt = VT_I4;
lInx = 3L;
pvElem->vt = VT_I4;
SafeArrayUnlock(parrayValues);
printf("\r\ncall DMSetValueWaitExStr:");
memset(errArray, 0, sizeof(errArray));
bRet = DMSetValueWaitExStr(&dwTAID, &vVarKey, 4, &vdmValue,
pdwVarState, 2000, DM_CompletitionProc, NULL, errArray);
if (bRet == FALSE)
{
int i = 0;
for(i=0; i < 4; i++)
{
printf("\r\n error DMSetValueWaitExStr, errArray[%d]=%ld,
%ld,%ld,%ld,%ld,[%s]",
i, errArray[i].dwError1, errArray[i].dwError2,
errArray[i].dwError3,
errArray[i].dwError4, errArray[i].dwError5,
errArray[i].szErrorText);
}
}
else
{
}
printf("\r\n########## exit Test with DMGetValue(Wait)ExStr/

DMSetValue(Wait)ExStr ##########\r\n");
Ejemplo de script "Project-Function DM_NotifyVariableProcExStr_GetValueWait":

#pragma code()
BOOL DM_NotifyVariableProcExStr_GetValueWait(DWORD dwTAID,

LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus, DWORD dwItems, LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
DWORD* pdwVal = NULL;
pdwVal = (DWORD*)lpvUser;
// the DMGetValueWait used PROPVARIANT and the lpvUser is ptr to
OutDataArray (DWORDS)
printf("\r\n*** DM_NotifyVariableProcExStr_GetValueWait entry ***");

for (i = 0; i < dwItems; i++)

{
VariantChangeType((VARIANTARG*)&(lpdmvus[i].vdmValue),
(VARIANTARG*)&(lpdmvus[i].vdmValue), 0, VT_I4);
if (0 == strcmp((LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal, "dwVal_1"))
{
pdwVal[0] = lpdmvus[i].vdmValue.u.lVal;
printf("\r\n set dwVal_1=%ld to dwVal[0]", pdwVal[0]);
bRet = TRUE;
}
{
bRet = TRUE;
}
{
bRet = TRUE;
}
{
bRet = TRUE;
}
}
printf("\r\n*** DM_NotifyVariableProcExStr_GetValueWait exit ***");

return bRet;
}
Project-Function DM_CompletitionProc:
BOOL DM_CompletitionProc(DWORD dwTAID, LPDWORD lpdmVarState, DWORD

dwItems, LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
printf("\r\n*** DM_CompletitionProc entry ***");

{
printf("\r\n VarState[%d] = %ld", i, lpdmVarState[i]);
}
printf("\r\n*** DM_CompletitionProc exit ***");

return bRet;
}
3.2.6.13 DMGetValueWait (RT Professional)
Utilización
A diferencia de DMGetValue, esta función fuerza una actualización de los valores de las
variables en base al valor.
La función DMGetValueWaitEx más avanzada proporciona además el Quality Code en la
estructura DM_VAR_UPDATE_STRUCTEX de la función Callback
DM_NOTIFY_VARIABLEEX_PROC .
Declaración
BOOL DMGetValueWait (
LPDWORD pdwTAID,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
Parámetros
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpdmVarKey
dwItems
fWaitForCompletition
Si el indicador fWaitForCompletition está activado, la función Callback transmitida sólo es
llamada cuando todas las variables solicitadas están actualizadas o se ha excedido el tiempo
timeout.

Si fWaitForCompletition no está activado, la función Callback transmitida se llama

inmediatamente. El comportamiento temporal equivale a la función DMGetValue.
dwTimeout
Tiempo de espera máximo de la aplicación en ms. Si una vez transcurrido el tiempo de espera
no se han actualizado todos los valores de las variables, la función Callback es llamada con
los códigos de error correspondientes.
Si el indicador fWaitForCompletition == FALSE, el valor transmitido no se evalúa.
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLE_PROC que se llama después de
actualizar todas las variables solicitadas o una vez transcurrido el tiempo de espera.
Si fWaitForCompletition == FALSE, la función Callback es llamada inmediatamente con los
valores que hay en ese momento en la memoria imagen de proceso del administrador de
datos.
WinCC.
lpvUser
lpdmError
Valor de retorno
TRUE
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DM_NOTIFY_VARIABLE_PROC (Página 1834) Determinar los valores de las variables con actua‐
lización (Callback)
DMGetValueWaitEx (Página 1729) Determinar los valores de las variables con actua‐
lización
AUTOHOTSPOT Modificar valores de variables con aviso
Ejemplos
OnTestVariablenGetvaluewait (Página 1877) "TESTCDoc.cpp"
Consulte también
OnTestVariablenGetvaluewait (Página 1877)
3.2.6.14 DMGetValueWaitEx (RT Professional)
Utilización
A diferencia de DMGetValueEx, con esta función se fuera una actualización de los valores de
las variables en base al valor.
Declaración
BOOL DMGetValueWaitEx (
LPDWORD pdwTAID,
DWORD dwItems,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,

Parámetros
pdwTAID
lpdmVarKey
dwItems
Si el indicador fWaitForCompletition está activado, la función Callback transmitida sólo es
llamada cuando todas las variables solicitadas están actualizadas o se ha excedido el tiempo
timeout.
Si fWaitForCompletition no está activado, la función Callback transmitida es llamada
inmediatamente. El comportamiento temporal equivale a la función DMGetValue.
dwTimeout
no se han actualizado todos los valores de las variables, la función Callback es llamada con
los códigos de error correspondientes.
Si el indicador fWaitForCompletition == FALSE, el valor transmitido no se evalúa.
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLEEX_PROC que se llama después de
actualizar todas las variables solicitadas o una vez transcurrido el tiempo de espera.
Si fWaitForCompletition == FALSE, la función Callback es llamada inmediatamente con los
datos.
WinCC.
lpvUser
lpdmError

Valor de retorno
TRUE
FALSE
Error.
DM_NOTIFY_VARIABLEEX_PROC (Pági‐ Determinar los valores de las variables con notifi‐

na 1845) cación (Callback)
DMGetValueEx (Página 1714) Determinar valores de variables
Consulte también
3.2.6.15 DMGetValueWaitExStr (RT Professional)
Declaración
BOOL DMGetValueWaitExStr (
LPDWORD pdwTAID,
DWORD dwFlags
LPVARIANT lpvdmVarKey,
LPVARIANT lpvCookie,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
Descripción

A diferencia de "DMGetValueExStr", con esta función puede forzarse una actualización de los
valores de las variables.
A diferencia de "DMGetValueEx", ya no se utiliza más la estructura "DM_VARKEY" para que
no haya ninguna limitación de longitud en el nombre de variable.
Parámetros
pdwTAID
dwFlags
"DM_VAR_UPDATE_STRUCT_EXSTR" de "DM_NOTIFY_VARIABLE_PROC_EXSTR" en
formato "VT_LPSTR", aquí puede especificarse el indicador
"DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKey
Puntero a un VARIANT para la lista de variables. La lista debe crearse como "VT_ARRAY |
VT_VARIANT", ya que puede haber diferentes tipos de datos como "VT_I4", "VT_BSTR" y,
bajo ciertas condiciones, también "VT_LPSTR".
lpvCookie
Puntero a un VARIANT para una lista adicional de datos específicos de usuario para cada
variable.
Está pensado para sustituir "lpvUserData" del anterior "DM_VARKEY" y se devuelve también
en la estructura "DM_VAR_UPDATE_STRUCT_EXSTR" para cada variable.
Si "fWaitForCompletition" está activado, la función Callback transmitida solo se llama cuando
todas las variables solicitadas están actualizadas o se ha excedido el tiempo timeout indicado.
Si "fWaitForCompletition" no está activado, la función Callback transmitida se llama
inmediatamente. El comportamiento temporal equivale al de la función "DMGetValueExStr".
dwTimeout
Tiempo de espera máximo de la aplicación en "ms". Si una vez transcurrido el tiempo de
espera no se han actualizado todos los valores de las variables, la función Callback es llamada
con los códigos de error correspondientes.
Con "fWaitForCompletition == FALSE", no se evalúa el valor transferido.
lpfnVariable
Puntero a la función Callback "DM_NOTIFY_VARIABLEEX_PROC_EXSTR" que se llama
después de actualizar todas las variables solicitadas o una vez transcurrido el tiempo de
espera.

Con "fWaitForCompletition == FALSE", la función Callback se llama inmediatamente con los

datos.
WinCC.
lpvUser
lpdmError
Valor de retorno
TRUE
Valores determinados
FALSE
Error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMGetValueExStr Determinar valores de variables

DMSetValueWaitExStr Modificar valores de variables con aviso
Ejemplos
Encontrará ejemplos en la página de "DMGetValueExStr".

3.2.6.16 DMGetVarInfo (RT Professional)
Utilización
DMGetVarInfo determina la clave completa de una variable. Esta orden permite obtener el
nombre de variable de una ID de variable y viceversa.
Declaración
BOOL DMGetVarInfo (
DWORD dwItems,
Parámetros
lpszProjectFile
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 1612) con las claves de variable que se
completan.
dwItems
Número de estructuras transmitidas.
lpdmError
Valor de retorno
TRUE
Clave de variable determinada.
FALSE
Error.

Comentario
No alterne la llamada con llamadas para crear variables. Si DMGetVarInfo se utiliza por
primera vez tras crear una variable, se reordenan las listas de búsqueda, lo que ocupa más
tiempo de ejecución.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenGetVarInfo (Página 1881) "TESTCDoc.cpp"
Consulte también
OnTestVariablenGetVarInfo (Página 1881)
3.2.6.17 DMGetVarInfoExStr (RT Professional)
Declaración
BOOL DMGetVarInfoExStr (
DWORD dwFlags,
LPVARIANT lpvdmVarKeyIn,
LPVARIANT lpvdmVarKeyOut,
Descripción
Determina la clave completa de una variable. De tal modo, con una ID de variable se
proporcionará también el nombre de variable y viceversa.
A diferencia de "DMGetVarInfo", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". El retorno se efectúa en un segundo VARIANT. Con ello
desaparece la limitación de la longitud de los nombres de variable.

Parámetros
lpszProjectFile
dwFlags
Si se necesita el retorno del nombre de variable en el VARIANT "lpvdmVarKeyOut" en formato
"VT_LPSTR", aquí puede indicarse "DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKeyIn
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables o VARIANT sencillo si solo se indica una variable.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
lpvdmVarKeyOut
Puntero al VARIANT con el que pueden devolverse los correspondientes valores para
"lpvdmVarKeyIn".
Con un nombre de variable predefinido en "lpvdmVarKeyIn" se devolverá la ID de variable y
viceversa.
Si el VARIANT se ha inicializado con "VT_EMPTY", se crea y rellena una matriz
correspondiente con "VT_ARRAY | VT_VARIANT" con el mismo tamaño que en
"lpvdmVarKeyIn".
Si el VARIANT no está vacío, se llama primero un "VariantClear" antes de crearse. Si el
VARIANT no se ha inicializado, puede producirse una excepción.
Si no existe la variable o no puede accederse a ella, se mantiene el tipo en "VT_EMPTY" para
la entrada correspondiente.
lpdmError
Valor de retorno
TRUE
Clave de variable determinada
FALSE
Error

Comentario
La llamada no debe alternarse con llamadas para crear variables. Al utilizar por primera vez
la función "DMGetVarInfo" o "DMGetVarInfoExStr" tras la creación de una variable, tendrán
que volver a clasificarse cada vez las listas de búsqueda. Esto aumenta el tiempo de ejecución.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMGetVarInfoExStr":
lpszPropertyName)
{
#pragma code ("kernel32.dll")
#define CP_ACP 0
int MultiByteToWideChar(UINT CodePage,
DWORD dwFlags,
LPCSTR lpMultiByteStr,
int cbMultiByte,
LPWSTR lpWideCharStr,
int cchWideChar);
int WideCharToMultiByte(UINT CodePage,
DWORD dwFlags,
LPCWSTR lpWideCharStr,
int cchWideChar,
LPSTR lpMultiByteStr,
int cbMultiByte,
LPCSTR lpDefaultChar,
LPBOOL lpUsedDefaultChar);
#pragma code()

int cElements );
HRESULT SafeArrayPutElement(SAFEARRAY FAR* psa, long FAR* rgIndices,
void FAR* pv );
HRESULT SafeArrayGetElement(SAFEARRAY FAR* psa, long FAR* rgIndices,
void FAR* pv );


typedef WCHAR OLECHAR;
BSTR SysAllocString(OLECHAR FAR* sz);
HRESULT SysFreeString(BSTR bstr);
#pragma code()
VARIANT vVarkeyIn;
VARIANT vVarkeyOut;
VARIANT vElem;
VARIANT* pvElem;
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
DWORD dwFlags;
BOOL bRet;
DWORD dwVarID1, dwVarID2, dwVarID3, dwVarID4;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[265];
SAFEARRAY* parrayIN;
SAFEARRAY* parrayOUT;
long lInx;
WCHAR wszBuffer[256];
int nRet;
bRet = FALSE;
szProjectName[0] = 0;
dwFlags = 0;
VariantInit(&vVarkeyIn);
VariantInit(&vVarkeyOut);
VariantInit(&vElem);
parrayIN = NULL;
parrayOUT = NULL;
//hr = E_FAIL;
nRet = 0;
printf("\r\n\r\n########## enter Test with DMGetVarInfoExStr
##########");
bRet = DMGetRuntimeProject(szProjectName, 256, &err);

if (!bRet)
{
printf("\r\n error DMGetRuntimeProject =>[%s], err=%ld,%ld,%ld,
%ld,%ld,[%s]", szProjectName,
}
dwVarID1 = GetTagDWord("dwVarKeyID_1");
strncpy(szVarNam1, GetTagChar("szVarKeyName_1"), 256);


printf("\r\n set vVarkeyIn:");
printf("\r\n dwVarID1=%ld, szVarNam1=[%s] (use name as VT_BSTR)",
dwVarID1, szVarNam1);
printf("\r\n dwVarID2=%ld, szVarNam2=[%s] (use name as VT_LPSTR)",
printf("\r\n dwVarID3=%ld, szVarNam3=[%s] (use ID)", dwVarID3,
szVarNam3);
printf("\r\n dwVarID4=%ld, szVarNam4=[%s] (useID)", dwVarID4,
szVarNam4);
//preseting input Variant: name1, name2, id3, id4
// will deliver on output Variant: id1, id2, name3, name4
parrayIN = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarkeyIn.vt = (VT_ARRAY | VT_VARIANT);
vVarkeyIn.u.parray = parrayIN;
// name1 as VT_BSTR
vElem.vt = VT_BSTR;
nRet = MultiByteToWideChar(CP_ACP, 0, szVarNam1, -1, wszBuffer,
256);
vElem.u.bstrVal = SysAllocString(wszBuffer);
lInx = 0;
hr = SafeArrayPutElement(parrayIN, &lInx, &vElem);
VariantClear(&vElem);
// name2 as VT_LPSTR
SafeArrayLock(parrayIN);
lInx = 1;
hr = SafeArrayPtrOfIndex(parrayIN, &lInx, &pvElem);
pvElem->u.pbVal = szVarNam2;
SafeArrayUnlock(parrayIN);
if (hr)
{
printf("\r\nerror SafeArrayPutElement: hr = %08lx", hr);
}
vElem.vt = VT_I4;
vElem.u.lVal = dwVarID3;
lInx = 2;
vElem.vt = VT_I4;
vElem.u.lVal = dwVarID4;
lInx = 3;
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{
printf("\r\n error DMGetVarInfoExStr[%s], err=%ld,%ld,%ld,%ld,
%ld,[%s]", szProjectName,


if (err.dwError1 == DM_E_DONT_EXIST)
{
//reset error, elements wil be checked each for error in type
(VT_EMPTY == not exist)
bRet = TRUE;
}
}
else
{
printf("\r\n DMGetVarInfoExStr return OK");
}
if (bRet)
{
if (vVarkeyOut.vt == VT_EMPTY)
{
printf("\r\n vVarkeyOut is VT_EMPTY");
}
else
{
parrayOUT = vVarkeyOut.u.parray;
lInx = 0;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4", lInx,
vElem.vt);
dwVarID1 = 0L;
}
else
{
dwVarID1 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_1",dwVarID1);
lInx = 1;
{
vElem.vt);
dwVarID2 = 0L;
}
else
{
}
lInx = 2;
if (vElem.vt != VT_BSTR)
{

printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_BSTR",

lInx, vElem.vt);
strcpy(szVarNam3, "error!!!");
}
else
{
nRet = WideCharToMultiByte(CP_ACP, 0L,
(WCHAR*)vElem.u.bstrVal, -1,
szVarNam3, 256, NULL, NULL);
}
SetTagChar("szVarKeyName_3",szVarNam3);
lInx = 3;
if (vElem.vt != VT_BSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_BSTR",
lInx, vElem.vt);
}
else
{
nRet = WideCharToMultiByte(CP_ACP, 0L,
(WCHAR*)vElem.u.bstrVal, -1,
szVarNam4, 256, NULL, NULL);
}
printf("\r\n get vVarkeyOut:");
printf("\r\n dwVarID1=%ld, szVarNam1=[%s] (delivered ID)",
printf("\r\n dwVarID3=%ld, szVarNam3=[%s] (delivered name
VT_BSTR)", dwVarID3, szVarNam3);
VT_BSTR)", dwVarID4, szVarNam4);
}
}
printf("\r\n set flag DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR and
repeat DMGetVarInfoExStr");
hr = VariantClear(&vVarkeyOut);
if (hr)
{
printf("\r\nerror VariantClear(vVarKeyOut: hr = %08lx", hr);
}
&vVarkeyOut, &err);
if (!bRet)
{


{
bRet = TRUE;
}
}
else
{
}
if (bRet)
{
{
}
else
{
parrayOUT = vVarkeyOut.u.parray;
lInx = 0;
{
vElem.vt);
dwVarID1 = 0L;
}
else
{
}
lInx = 1;
{
vElem.vt);
dwVarID2 = 0L;
}
else
{
}
SafeArrayLock(parrayOUT);
lInx = 2;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);

if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
}
else
{
strncpy(szVarNam3, (LPSTR)pvElem->u.pbVal, 255);
szVarNam3[255] = 0;
}
lInx = 3;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);
if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
}
else
{
strncpy(szVarNam4, (LPSTR)pvElem->u.pbVal, 255);
szVarNam4[255] = 0;
}
SafeArrayUnlock(parrayOUT);
printf("\r\n get vVarkeyOut:");

VT_LPSTR)", dwVarID3, szVarNam3);
VT_LPSTR)", dwVarID4, szVarNam4);
}
}
printf("\r\n only 1 Input (ID = VT_I4 and dwVarID1) without

VT_ARRAY, set flag DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR and repeat
DMGetVarInfoExStr");
hr = VariantClear(&vVarkeyIn);
if (hr)
{
printf("\r\n error VariantClear(vVarKeyIn): hr = %08lx", hr);
// know that error, have to free the PROPVARIANT in Array manualy
//this can be set to VT_EMPTY direct, while no alloc of string
was used

parrayIN = vVarkeyIn.u.parray;
SafeArrayLock(parrayIN);
lInx = 1;
hr = SafeArrayPtrOfIndex(parrayIN, &lInx, &pvElem);
pvElem->vt = VT_EMPTY;
pvElem->u.pbVal = NULL;
SafeArrayUnlock(parrayIN);
hr = VariantClear(&vVarkeyIn);
if (hr)
{
printf("\r\n error VariantClear(vVarkeyIn) again after
manualy reset the PROPVARIANT in 2. elem: hr = %08lx", hr);
}
else
{
printf("\r\n VariantClear(vVarkeyIn) OK after manualy reset
the PROPVARIANT in 2. elem");
}
}
hr = VariantClear(&vVarkeyOut);
if (hr)
{
printf("\r\n error VariantClear(vVarkeyOut): hr = %08lx", hr);
}
vVarkeyIn.vt = VT_I4;
vVarkeyIn.u.lVal = dwVarID1;
&vVarkeyOut, &err);
if (!bRet)
{
{
bRet = TRUE;
}
}
else
{
}
if (bRet)
{
{
}
else

{
if (vVarkeyOut.vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut.vt = [%ld] != VT_LPSTR",
vVarkeyOut.vt);
}
else
{
strncpy(szVarNam1, (LPSTR)vVarkeyOut.u.pbVal, 255);
szVarNam1[255] = 0;
}
}
}
printf("\r\n########## exit Test with DMGetVarInfoExStr ##########\r

\n");
3.2.6.18 DMGetVarLimits (RT Professional)
Utilización
DMGetVarLimits determina para la variable indicada los límites en los cuales se pueden
realizar operaciones de escritura con la función DMSetValue.
Declaración
BOOL DMGetVarLimits (
DWORD dwItems,
LPDM_VARLIMIT lpdmVarLimit,
Parámetros
lpszProjectFile
lpdmVarKey
Puntero a estructuras del tipo DM_VARKEY (Página 1612) para especificar variables.

dwItems
lpdmVarLimit
Puntero a estructuras del tipo DM_VARLIMIT (Página 1614) en las que se guardan los valores
límite.
lpdmError
Valor de retorno
TRUE
Valores límite determinados.
FALSE
Error.
Comentario
Además de los límites superior e inferior de una variable definidos en la configuración, hay
otra limitación del margen numérico permitido debido a una norma de formato agregada.
El ejemplo siguiente representa las relaciones con una variable del tipo
DM_VARTYPE_BYTE , que se agrega al sistema de automatización como byte en formato
BCD.
Mensajes de error
DM_E_MAX_RANGE Límite superior de la conversión de formato exce‐

dido
DM_E_MIN_RANGE Límite inferior de la conversión de formato no al‐
canzado
DM_E_MAX_LIMIT Límite superior de la variable excedido
DM_E_MIN_LIMIT Límite inferior de la variable rebasado no alcanza‐
do
DM_E_INVALID_TYPE Tipo de variable no válido
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Ejemplos
OnTestVariablenGetvarlimits (Página 1882) "TESTCDoc.cpp"
Consulte también
OnTestVariablenGetvarlimits (Página 1882)
3.2.6.19 DMGetVarLimitsExStr (RT Professional)
Declaración
BOOL DMGetVarLimitsExStr (
LPDM_VARLIMIT lpdmVarLimit,
Descripción
Determina para las variables indicadas los límites en los cuales se pueden realizar
operaciones de escritura con las funciones "DMSetValueExStr".
A diferencia de "DMGetVarLimits", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". Con ello desaparece la limitación de la longitud de los
nombres de variable.
Parámetros
lpszProjectFile
lpvdmVarKey
variables o VARIANT sencillo si solo se indica una variable.
"VT_BSTR".

lpdmVarLimit
Puntero a estructuras del tipo "DM_VARLIMIT" en las que se guardan los valores límite.
lpdmError
Valor de retorno
TRUE
Valores límite determinados
FALSE
Error
Comentario
Además de los límites superior e inferior configurados de una variable, se da otra limitación
del margen numérico permitido debido a una norma de formato agregada.
El siguiente ejemplo muestra las relaciones con una variable del tipo "DM_VARTYPE_BYTE"
almacenada en el AS como byte en formato "BCD".
Mensajes de error

dido
canzado
do
DM_E_INVALID_TYPE Tipo de variable no válido
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMGetVarLimitsExStr":


lpszPropertyName)
{
int cElements );
FAR* pvarSrc, unsigned short wFlags, VARTYPE vt );
#pragma code()
VARIANT vdmVarkey;
VARIANT* pvElem;
VARIANT vElem;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
SAFEARRAY* parray;
long lInx;
int nRet;
DM_VARLIMIT dmLimits[4];
int i;
bRet = FALSE;
VariantInit(&vElem);
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;
printf("\r\n\r\n########## enter Test with DMGetVarLimitsExStr

##########");

if (!bRet)
{
}



printf("\r\n set the vdmVarkey with names in VT_LPSTR:");
parray = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmVarkey.vt = (VT_ARRAY | VT_VARIANT);
vdmVarkey.u.parray = parray;
SafeArrayLock(parray);
lInx = 0;
hr = SafeArrayPtrOfIndex(parray, &lInx, &pvElem);
lInx = 1;
lInx = 2;
lInx = 3;
SafeArrayUnlock(parray);
memset(dmLimits, 0, sizeof(DM_VARLIMIT)*4);
bRet = DMGetVarLimitsExStr(szProjectName, &vdmVarkey, dmLimits,
&err);
if (!bRet)
{
printf("\r\n error DMGetVarLimitsExStr[%s], err=%ld,%ld,%ld,%ld,
bRet = TRUE; //clear error flag, the defect data is set to VT_EMPTY
}
else
{
printf("\r\n DMGetVarLimitsExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmLimits[%d]:{",i);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMaxRange, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
dmLimits[i].dmMaxRange.vt))
{
printf("dmMaxRange=[%g], ", vElem.u.dblVal);

}
else
{
printf("dmMaxRange{VariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMaxRange.vt);
}
(VARIANTARG*)&dmLimits[i].dmMinRange, 0, VT_R8);
dmLimits[i].dmMinRange.vt))
{
printf("dmMinRange=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMinRange{VariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMinRange.vt);
}
(VARIANTARG*)&dmLimits[i].dmMaxLimit, 0, VT_R8);
dmLimits[i].dmMaxLimit.vt))
{
printf("dmMaxLimit=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMaxLimitVariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMaxLimit.vt);
}
(VARIANTARG*)&dmLimits[i].dmMinLimit, 0, VT_R8);
dmLimits[i].dmMinLimit.vt))
{
printf("dmMinLimit=[%g]", vElem.u.dblVal);
}
else
{
printf("dmMinLimitVariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMinLimit.vt);
}
printf("}");
}
}

printf("\r\n########## exit Test with DMGetVarLimitsExStr ##########

\r\n");
3.2.6.20 DMGetVarType (RT Professional)
Utilización
DMGetVarType determina la referencia del tipo para las variables indicadas.
Declaración
BOOL DMGetVarType (
DWORD dwItems,
LPDM_TYPEREF lpdmTypeRef,
Parámetros
lpszProjectFile
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 1612) con las claves de variables cuyo tipo se
determina.
dwItems
lpdmTypeRef
Puntero a la lista de estructuras DM_TYPEREF (Página 1596) para devolver el tipo de variable.
lpdmError

Valor de retorno
TRUE
Tipo de datos determinado.
FALSE
Error.
Comentario
Las funciones de configuración para crear variables transmiten a la aplicación que efectúa la
llamada las estructuras DM_VARREF y DM_TYPEREF ocupadas con indicaciones del tipo
de datos de la variable.
Para ahorrar espacio de memoria dentro de la aplicación, ésta no debe ser forzada a recordar
la referencia del tipo de cada variable, sino que puede consultarla cada vez desde el
administrador de datos con DMGetVarType.
No alterne la llamada con llamadas para crear variables. Si DMGetVarType se utiliza por
primera vez tras crear una variable, se reordenan las listas de búsqueda, lo que ocupa más
tiempo de ejecución.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenGetvartype (Página 1883) "TESTCDoc.cpp"
Consulte también
OnTestVariablenGetvartype (Página 1883)

3.2.6.21 DMGetVarTypeExStr (RT Professional)
Declaración
BOOL DMGetVarTypeExStr (
LPDM_TYPEREF_EXSTR lpdmTypeRef,
Descripción
Determina la referencia del tipo para las variables transferidas.
A diferencia de "DMGetVarType", la lista de variables se transfiere como puntero a VARIANT
nombres de variable. Lo mismo sucede con los nombres de tipo en las estructuras
"DM_TYPEREF_EXSTR".
Parámetros
lpszProjectFile
lpvdmVarKey
variables.
"VT_BSTR".
lpdmTypeRef
Puntero a la lista de estructuras "DM_TYPEREF_EXSTR" para el retorno de las indicaciones
del tipo de variable.
La lista debe tener al menos el tamaño de la matriz Variant en "lpvdmVarKey". Los punteros
"lpszTypeName" y "dwBufferCount" deben haberse inicializado y remitir a una matriz de
cadena propia.
Si "lpszTypeName" es "NULL", compruebe el retorno. El propio usuario deberá volver a
habilitar los punteros asignados.

lpdmError
Valor de retorno
TRUE
Tipo de datos determinado
FALSE
Error
Comentario
Para ahorrar memoria dentro de la aplicación, esta no debe memorizar forzosamente la
referencia del tipo para cada variable. La referencia del tipo puede consultarse en todo
momento al administrador de datos con "DMGetVarType".
La llamada no debe alternarse con llamadas para crear variables. Al utilizar por primera vez
la función "DMGetVarType" o "DMGetVarTypeExStr" tras la creación de una variable, tendrán
que volver a clasificarse cada vez las listas de búsqueda. Esto aumenta el tiempo de ejecución.
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMGetVarTypeExStr":
lpszPropertyName)
{
int cElements );

#pragma code()
VARIANT vdmVarkey;
VARIANT* pvElem;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
SAFEARRAY* parray;
long lInx;
int nRet;
DM_TYPEREF_EXSTR dmTypeRef[4];
CHAR szTypeName[4][256];
int i;
memset(dmTypeRef, 0, sizeof(DM_TYPEREF_EXSTR)*4);
szTypeName[0][0] = 0;
bRet = FALSE;
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;
printf("\r\n\r\n########## enter Test with DMGetVarTypeExStr

##########");

if (!bRet)
{
}

printf("\r\n set the vdmVarkey with names in VT_LPSTR:");
parray = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmVarkey.vt = (VT_ARRAY | VT_VARIANT);
vdmVarkey.u.parray = parray;
SafeArrayLock(parray);
lInx = 0;

lInx = 1;
lInx = 2;
lInx = 3;
SafeArrayUnlock(parray);
printf("\r\n call DMGetVarTypeExStr with NULL for names");

bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef, &err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s], err=%ld,%ld,%ld,%ld,
}
else
{
printf("\r\n DMGetVarTypeExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmTypeRef[%d]:{",i);
printf("dwType=[%ld]", dmTypeRef[i].dwType);
printf(", dwSize=[%ld]", dmTypeRef[i].dwSize);
if (dmTypeRef[i].lpszTypeName)
{
printf(", lpszTypeName=[%s]", dmTypeRef[i].lpszTypeName);
printf(", dwNameCharCount=[%ld]",
dmTypeRef[i].dwNameCharCount);
//clear the delivered strings that no memoryleak
free(dmTypeRef[i].lpszTypeName);
dmTypeRef[i].lpszTypeName = NULL;
dmTypeRef[i].dwNameCharCount = 0L;
//set name store for next read (no need to free after
call)
dmTypeRef[i].lpszTypeName = szTypeName[i];
dmTypeRef[i].dwNameCharCount = 255;
}
printf("}");

}
}
printf("\r\n call DMGetVarTypeExStr with pointers and size for name
storage");
bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef, &err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s], err=%ld,%ld,%ld,%ld,
}
else
{
printf("\r\n DMGetVarTypeExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmTypeRef[%d]:{",i);
printf("dwType=[%ld]", dmTypeRef[i].dwType);
printf(", dwSize=[%ld]", dmTypeRef[i].dwSize);
printf(", lpszTypeName=[%s]", dmTypeRef[i].lpszTypeName);
dmTypeRef[i].dwNameCharCount);
printf("}");
}
}
printf("\r\n########## exit Test with DMGetVarTypeExStr ##########\r
\n");
3.2.6.22 DMSetValue (RT Professional)
Utilización
La función modifica los valores de las variables descritas en lpdmVarKey por los valores
indicados en lpdmValue.
La interrupción de los cambios las variables es asíncrona de acuerdo con el lema "dispara y
olvida".

Declaración
BOOL DMSetValue (
DWORD dwItems,
LPVARIANT lpdmValue,
LPDWORD lpdmVarState,
Parámetros
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 1612) que identifican las
variables que hay que modificar.
dwItems
Número de estructuras transmitidas (equivale al número de variables por modificar).
lpdmValue
Puntero al primer valor nuevo de las variables que hay que modificar.
lpdmVarState
Puntero al primer lugar de la memoria al que se agrega la información si el valor de la variable
se ha podido modificar correctamente o se han producido errores.
Un 0 (OK) significa que se ha enviado/modificado correctamente y que como mínimo existe
una de las variables indicadas. Si no existe ninguna de las variables indicadas, se recibe un
error con el estado DM_VARSTATE_INVALID_KEY.
Para comprobar si el valor también se ha aplicado, debe utilizarse DMSetValueWait.

blecida
DM_VARSTATE_MIN_LIMIT (0x0010) Límite inferior configurado no alcanza‐
do
DM_VARSTATE_CONVER‐ (0x0080) Visualización de errores de conver‐
SION_ERROR sión (en relación con DM_VARSTA‐
TE_..._RANGE)

DM_VARSTATE_TIMEOUT (0x2000) Timeout / ninguna respuesta del canal

lpdmError
Valor de retorno
TRUE
Variables modificadas.
FALSE
Error.
Comentario
No es necesario indicar una norma de acceso para lpdmValue ya que el administrador de
datos puede encontrar una asignación para cada tipo de variable partiendo de la clave de
variable transmitida.
En las variables externas se realiza un acceso de escritura al proceso, en los PCs de un cliente
WinCC la petición se transfiere al servidor correspondiente.
Normalmente, las peticiones de escritura de las aplicaciones se ejecutan de forma asíncrona.
Todas las peticiones de escritura se ponen en la cola de espera del administrador de datos y
se transmiten secuencialmente a la DLL de canal responsable.
Si la petición de escritura de la DLL de canal se confirma positivamente, el nuevo valor en la
memoria imagen de proceso del servidor responsable de la petición es válido. A continuación
se lleva a cabo la actualización en las estaciones WinCC conectadas con el bus de sistemas.
De ello resulta que a corto plazo puede haber diferentes valores para una variable en
diferentes estaciones.
Mensajes de error

do
dido
canzado
DM_E_ACCESS_FAULT Acceso de escritura a una variable no permitido

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

de avisos
Ejemplos
Write tag (Página 1895) "DM02.cpp"
OnTestVariablenSetvalue (Página 1885) "TESTCDoc.cpp"
Consulte también
Write tag (Página 1895)
OnTestVariablenSetvalue (Página 1885)
3.2.6.23 DMSetValueExStr (RT Professional)
Declaración
BOOL DMSetValueExStr (
LPVARIANT lpvdmValue,

Descripción
La función cambia los valores de las variables descritas en "lpvdmVarKey" por los valores
indicados en "lpvdmValue".
La señalización de los cambios de las variables sucede de forma asíncrona de acuerdo con
el lema "dispara y olvida".
A diferencia de "DMSetValue", la lista de variables se transfiere como puntero a VARIANT
Parámetros
lpvdmVarKey
variables o VARIANT sencillo si solo se indica una variable que identifica las variables que
hay que modificar.
"VT_BSTR".
En proyectos multicliente a partir de la versión V5.0 de WinCC, aquí también debe indicarse,
dado el caso, un prefijo de servidor en cada nombre (ver tipos de proyecto y versiones).
lpvdmValue
lpdmVarState
Puntero al primer lugar de la memoria en el que se almacena información si se ha podido
modificar correctamente el valor de las variables o se han producido errores.
Un "0" (OK) significa que se ha enviado/modificado correctamente y que existe al menos una
de las variables indicadas. Si no existe ninguna de las variables indicadas, se emite un error
con el estado "DM_VARSTATE_INVALID_KEY".
Para comprobar si el valor también ha sido adoptado por el PLC, debe utilizarse
"DMSetValueWaitExStr".

blecida
do


SION_ERROR sión (en combinación con DM_VARS‐
TATE_..._RANGE)
lpdmError
Valor de retorno
TRUE
FALSE
Error
Comentario
No es necesario indicar una norma de acceso para "lpdmValue", ya que el administrador de
datos puede efectuar una asignación al tipo correspondiente partiendo de la clave de variable
transmitida.
Con variables externas se realiza un acceso de escritura al proceso; con equipos cliente
WinCC, la petición se transfiere al servidor correspondiente.
Normalmente, las peticiones de escritura de las aplicaciones se ejecutan de forma asíncrona,
es decir, todas las peticiones de escritura se ponen en la cola de espera del administrador de
datos y se transmiten secuencialmente a la DLL de canal responsable.
El nuevo valor es válido en la memoria imagen de proceso del servidor responsable de la
petición si la DLL de canal confirma positivamente la petición de escritura. A continuación se
lleva a cabo la actualización en las estaciones WinCC conectadas con el bus de sistemas.
De ello resulta que a corto plazo puede haber diferentes valores para una variable en
diferentes estaciones.
Mensajes de error

do


dido
canzado
DM_E_ACCESS_FAULT Acceso de escritura a una variable no permitido
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMGetValueExStr Determinar valores de variables

DMSetValueMessageExStr Modificar valores de variables con salida de avisos
DMSetValueWaitMessageExStr Modificar valores de variables con aviso y salida
de avisos
Ejemplos
3.2.6.24 DMSetValueMessage (RT Professional)
Utilización
La función modifica el valor de la variable descrita en lpdmVarKey por el valor indicado en
lpdmValue.
A diferencia de la función DMSetValue, sólo se modifica una variable. Si el valor de la variable
se ha modificado correctamente, se entrega un texto de aviso libremente definible.
Declaración
BOOL DMSetValueMessage (
DWORD fFlags,
LPSTR lpszMessage,

Parámetros
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 1612) que marca la variable que hay que
modificar.
En los proyectos multicliente a partir de la versión 5.0 de WinCC se indica, en caso necesario,
con un prefijo de servidor en lpdmVarKey->szName (véase tipos de proyecto y versiones).
lpdmValue
Puntero al nuevo valor de las variables que hay que modificar.
fFlags
Con fFlags se determina cómo se procesa el texto de aviso:
DMSVM_OPERATIONREPORT El aviso se agrega al informe de operación.

DMSVM_OPERATIONMESSAGE El aviso se emite como aviso de operación.
lpszMessage
Texto del aviso que se entrega.
lpdmError
Valor de retorno
TRUE
Variable modificada.
FALSE
Error.
Comentario
Encontrará más información acerca de la modificación de valores de variable en la función
DMSetValue.
Mensajes de error

Archivos necesarios
dmclient.h

dmclient.lib
dmclient.dll

de avisos
Consulte también
3.2.6.25 DMSetValueMessageExStr (RT Professional)
Declaración
BOOL DMSetValueMessageExStr (
DWORD fFlags,
LPTSTR lpszMessage,
Descripción
La función cambia el valor de la variable descrita en "lpvdmVarKey" por el valor indicado en
"lpdmValue".
A diferencia de la función "DMSetValueExStr", solo puede modificarse una variable. Si el valor
de la variable se ha modificado correctamente, se señaliza un texto de aviso libremente
definible.
Parámetros
lpvdmVarKey
Puntero a VARIANT para la transferencia del nombre de variable, ID de variable o VARIANT
sencillo si solo se indica una variable que identifica las variables que hay que modificar.


"VT_BSTR".
Si se indica una matriz con "VT_ARRAY | VT_VARIANT", solo se evalúa el primer elemento.
dado el caso, un prefijo de servidor en el nombre (ver tipos de proyecto y versiones).
lpvdmValue
fFlags
Especifica cómo se procesa el texto de aviso:

lpszMessage
lpdmError
Valor de retorno
TRUE
Variables modificadas
FALSE
Error
Comentario
"DMSetValueExStr".
Mensajes de error


Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll

de avisos
3.2.6.26 DMSetValueWait (RT Professional)
Utilización
La función modifica los valores de las variables descritas en lpdmVarKey por los valores
indicados en lpdmValue.
A diferencia de DMSetValue, DMSetValueWait permite que la aplicación sea notificada de
que se ha actualizado correctamente la máquina local.
Declaración
BOOL DMSetValueWait (
LPDWORD pdwTAID,
DWORD dwItems,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
LPVOID lpvUser,
Parámetros
pdwTAID
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 1612) que identifican las
variables que hay que modificar.

dwItems
Número de estructuras transmitidas (equivale al número de variables por modificar).
lpdmValue
dwTimeout
no se han escrito todas las variables, la función Callback es llamada con los códigos de error
correspondientes.
lpfnCompletition
Puntero a la función Callback que se llama después de actualizar todas las variables
solicitadas o una vez transcurrido el tiempo de espera.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear notificaciones de WinCC y, con ello, todo el WinCC.
lpvUser
lpdmError
Valor de retorno
TRUE
FALSE
El error ocurrido se puede identificar con la estructura de error.
Comentario
DMSetValue.
Mensajes de error


Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

de avisos
DM_COMPLETITION_PROC (Página 1779) Modificar valores de variables (Callback)
Ejemplos
OnTestVariablenSetvaluewait (Página 1886) "TESTCDoc.cpp"
Consulte también
DM_COMPLETITION_PROC (Página 1779)
OnTestVariablenSetvaluewait (Página 1886)
3.2.6.27 DMSetValueWaitExStr (RT Professional)
Declaración

BOOL DMSetValueWaitExStr (
LPDWORD pdwTAID,
DWORD dwItems,
LPDWORD lpdwState,
DWORD dwTimeOut,
LPVOID lpvUser,
Descripción
La función cambia los valores de las variables descritas en "lpvdmVarKey" por los valores
indicados en "lpvdmValue".
A diferencia de "DMSetValueExStr", "DMSetValueWaitExStr" da a la aplicación la posibilidad
de ser informada tras una actualización en el equipo local.
A diferencia de "DMSetValueWait", la lista de variables se transfiere como puntero a VARIANT
Parámetros
pdwTAID
lpvdmVarKey
variables o VARIANT sencillo si solo se indica una variable que identifica las variables que
hay que modificar.
"VT_BSTR".
dwItems
Número de valores transferidos en "lpvdmValue" y estructuras de error en "lpdmError". El
número debe ser igual o superior a la matriz de entrada en "lpvdmVarKey".
Si el número es superior a la matriz de entrada, se ignoran los valores sobrantes y se ajustan
las respectivas estructuras de error con "DM_E_PARAM", puesto que no es posible la
asignación.

Si el número es inferior a la matriz de entrada, solo se devuelve el error "DM_E_PARAM" en

la primera estructura de error y no se escriben valores.
lpvdmValue
lpdwState
Puntero al primer lugar de la memoria en el que se almacena información si se ha podido
modificar correctamente el valor de las variables o se han producido errores.
Un 0 (OK) significa que se ha enviado/modificado correctamente y que como mínimo existe
una de las variables indicadas. Si no existe ninguna de las variables indicadas, se emite un

blecida
do
SION_ERROR sión (en combinación con DM_VARS‐
TATE_..._RANGE)
dwTimeout
Tiempo de espera máximo de la aplicación en "ms". Si no se han escrito todas las variables
una vez transcurrido el tiempo de espera, se llama la función Callback con los códigos de
error correspondientes.
lpfnCompletition
WinCC.

lpvUser
lpdmError
Puntero a la primera de las estructuras de error dwItems del tipo "CMN_ERROR". Si se
produce un error al escribir una variable, el sistema escribe la información de error en la
estructura correspondiente. Por ello, no hay que olvidar reservar espacio para estas
estructuras e inicializar.
Valor de retorno
TRUE
FALSE
El error ocurrido se puede identificar con la estructura de error.
Comentario
"DMSetValueExStr".
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll

de avisos
DM_COMPLETITION_PROC Modificar valores de variables (Callback)

Ejemplos
3.2.6.28 DMSetValueWaitMessage (RT Professional)
Utilización
La función reúne las funciones de DMSetValueMessage y DMSetValueWait. A diferencia de
la función DMSetValueWait, sólo se puede modificar una variable.
El valor de las variables descritas en lpdmVarKey se modifica por el valor indicado en
lpdmValue. Si el valor de las variables se ha modificado correctamente, por una parte se
entrega un texto de aviso libremente definible y, por la otra, la aplicación tiene la posibilidad
de ser notificada de que la máquina local se ha actualizado correctamente.
Declaración
BOOL DMSetValueWaitMessage (
LPDWORD pdwTAID,
DWORD dwTimeOut,
DWORD fFlags,
LPSTR lpszMessage,
LPVOID lpvUser,
Parámetros
pdwTAID
lpdmVarKey
Puntero a las estructuras DM_VARKEY (Página 1612) que identifican la variable que hay que
modificar.
lpdmValue
dwTimeOut
no se han escrito todas las variables, la función Callback es llamada con los códigos de error
correspondientes.

lpfnCompletition
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear notificaciones de WinCC y, con ello, todo el WinCC.
fFlags
Con fFlags se determina cómo se procesa el texto de aviso:

lpszMessage
Texto de aviso que se entrega.
lpvUser
lpdmError
Valor de retorno
TRUE
FALSE
Error.
Comentario
DMSetValue.
Mensajes de error


Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_COMPLETITION_PROC (Página 1779) Modificar valores de variables (Callback)

Consulte también
OnTestVariablenSetvaluewait (Página 1886)
DM_COMPLETITION_PROC (Página 1779)
3.2.6.29 DMSetValueWaitMessageExStr (RT Professional)
Declaración
BOOL DMSetValueWaitMessageExStr (
LPDWORD pdwTAID,
DWORD dwTimeOut,
DWORD fFlags,
LPTSTR lpszMessage,
LPVOID lpvUser,
Descripción
La función combina las funcionalidades de "DMSetValueMessageExStr" y
"DMSetValueWaitExStr".
A diferencia de la función "DMSetValueWaitExStr", solo puede modificarse una variable.

El valor de la variable descrita en "lpvdmVarKey" se cambia por el valor indicado en

"lpvdmValue". Si el valor de la variable se ha modificado correctamente, se señaliza por un
lado un texto de aviso libremente definible. Por otro lado, la aplicación tiene la posibilidad de
ser informada si se efectúa una actualización en el equipo local.
A diferencia de "DMSetValueWaitMessage", la variable se transfiere como puntero a
VARIANT. Con ello desaparece la limitación de la longitud del nombre de variable.
Parámetros
pdwTAID
lpvdmVarKey
Puntero a VARIANT para la transferencia del nombre de variable, ID de variable o VARIANT
sencillo si solo se indica una variable que identifica las variables que hay que modificar.
"VT_BSTR".
dado el caso, un prefijo de servidor en el nombre (ver tipos de proyecto y versiones).
lpvdmValue
dwTimeOut
Tiempo de espera máximo de la aplicación en "ms". Si no se han escrito todas las variables
una vez transcurrido el tiempo de espera, se llama la función Callback con los códigos de
error correspondientes.
lpfnCompletition
WinCC.
fFlags
Con fFlags se especifica cómo se procesa el texto de aviso:


lpszMessage
lpvUser
lpdmError
Puntero a la primera de las estructuras de error dwItems del tipo "CMN_ERROR". Si se
produce un error al escribir una variable, el sistema escribe la información de error en la
estructura correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
FALSE
Error
Comentario
"DMSetValueExStr".
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DM_COMPLETITION_PROC Modificar valores de variables (Callback)



3.2.6.30 DM_COMPLETITION_PROC (RT Professional)
Descripción
Para que la aplicación pueda ser notificada de la correcta modificación de los valores de
variables, es preciso facilitar una función Callback del tipo DM_COMPLETITION_PROC.
Declaración
BOOL ( * DM_COMPLETITION_PROC) (
DWORD dwTAID,
DWORD dwItems,
LPVOID lpvUser);
Parámetros
dwTAID
ID de transacción que ha sido asignada por el administrador de datos a la función para
modificar los valores de variables.
lpdmVarState
Puntero al primer lugar de la memoria al que se agrega la información si el valor de la variable
se ha podido modificar correctamente o se han producido errores:
Un 0 (OK) significa que se ha enviado y modificado correctamente y que como mínimo existe
una de las variables indicadas. Si no existe ninguna de las variables indicadas, se recibe un

blecida
do
DM_VARSTATE_CONVERSION_ERROR (0x0080) Visualización de errores de conver‐
sión (en relación con DM_VARSTA‐
TE_..._RANGE)


dwItems
Número de modificaciones de variables cuyo estado se transmite en lpdmVarState.
lpvUser
función Callback.
Valor de retorno
Los valores de retorno dependen de la implementación
Nota
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
Archivos necesarios
dmclient.h

de avisos
Consulte también

3.2.6.31 DMShowVarPropertiesExStr (RT Professional)
Declaración
BOOL DMShowVarPropertiesExStr (
HWND hwndParent,
LPCTSTR lpszVariableName,
DWORD dwVariableID,
Descripción
La función abre el cuadro de diálogo para editar las propiedades de variables.
Parámetros
lpszProjectFile
hwndParent
lpszVariableName
Puntero al nombre de la variable cuyas propiedades se muestran.
SI "lpszVariableName" es "NULL", debe indicarse una "dwVariableID" válida. En caso
contrario, se emite el error "DM_E_PARAM".
dwVariableID
ID de la variable. No se utiliza si hay indicado un nombre en "lpszVariableName".
lpdmError
Valor de retorno
TRUE

FALSE
Salir del error o del diálogo con "Cancelar"
Mensajes de error

de diálogo
DM_E_PARAM Al menos un parámetro se ha transferido con error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMShowVarPropertiesExStr":
lpszPropertyName)
{
BOOL bRet = FALSE;
CHAR szVariableName[256];
DWORD dwVariableID;
CMN_ERROR err;
HWND hwndParent;
szVariableName[0] = 0;
dwVariableID = 0L;
hwndParent = NULL;
printf("\r\n\r\n########## enter Test with DMShowVarProperitesExStr

##########");

if (!bRet)
{
}

dwVariableID = GetTagDWord("dwVarKeyID_1");
printf("\r\n call DMShowVarPropertiesExStr with ID");
bRet = DMShowVarPropertiesExStr(szProjectName, hwndParent, NULL,
dwVariableID, &err);
if (!bRet)
{
printf("\r\n error DMShowVarPropertiesExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}
strncpy(szVariableName, GetTagChar("szVarKeyName_1"), 255);

printf("\r\n call DMShowVarPropertiesExStr with VarName");

bRet = DMShowVarPropertiesExStr(szProjectName, hwndParent,
szVariableName, 0L, &err);
if (!bRet)
{
printf("\r\n error DMShowVarPropertiesExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}
printf("\r\n########## exit Test with DMShowVarProperitesExStr

##########\r\n");
}
3.2.6.32 DMShowVarDatabase (RT Professional)
Utilización
La función abre el cuadro de diálogo de selección de variables para el proyecto especificado.
A diferencia de ShowVarDatabaseMulti, sólo se selecciona una variable.

Declaración
BOOL DMShowVarDatabase (
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
Parámetros
lpszProjectFile
hwndParent
lpdmOptions
Puntero a la estructura DM_DLGOPTIONS (Página 1589) con especificaciones de cómo debe
comportarse el cuadro de diálogo. Si el puntero es NULL, se selecciona el cuadro de diálogo
estándar.
lpdmFilter
Puntero a la estructura de filtros DM_VARFILTER (Página 1603). Si el puntero es NULL se
muestran todas las variables.
Sólo se soporta el filtrado por nombre de variable y tipo de variable. El filtrado de variables
por grupos y conexiones no está implementado.
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 1612). Si deben mostrarse las propiedades de
una variable, lpdmVarKey contiene la clave de esta variable al salir del cuadro de diálogo.
lpdmError
Valor de retorno
TRUE
FALSE
Error o salir del cuadro de diálogo con "CANCELAR".

Mensajes de error

DM_E_INV_PRJ El proyecto indicado no se ha encontrado/cargado
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
DM_DLGOPTIONS (Página 1589)
3.2.6.33 DMShowVarDatabaseExStr (RT Professional)
Declaración
BOOL DMShowVarDatabaseExStr (
HWND hwndParent,
LPTSTR* lppszVariableName,
LPDWORD lpdwVarNameCharCount,
LPDWORD lpdwVariableID,
Descripción
A diferencia de "ShowVarDatabaseMultiExStr", solo puede seleccionarse una variable.

Parámetros
lpszProjectFile
hwndParent
lpdmOptions
Puntero a la estructura "DM_DLGOPTIONS" con especificaciones de cómo debe comportarse
el cuadro de diálogo; con "NULL", se corresponde con el cuadro de diálogo estándar.
lpdmFilter
Puntero a la estructura de filtro "DM_VARFILTER". Con "NULL", se muestran todas las
variables.
Solo se admite el filtrado por nombre y tipo de variable. El filtrado de variables por grupos y
conexiones no está implementado.
lppszVariableName
Puntero a puntero del búfer de retorno para el nombre de variable.
Si está indicado "NULL", debe haber un puntero válido a "lpdwVariableID". Entonces se
suministrará solo la ID y no el nombre. "dwVarNameCharCount" no se tiene en cuenta. Si
ambos punteros son "NULL", se devuelve "DM_E_PARAM".
Si el puntero interno es "NULL", se asigna y se devuelve el búfer. El tamaño se devuelve en
"lpdwVarNameCharCount".
lpdwVarNameCharCount
Puntero a un "DWORD" en el que se guarda el tamaño del búfer de retorno. El tamaño
seleccionado debe ser suficiente para que pueda guardarse el nombre de variable con
terminación nula.
Si el búfer es demasiado pequeño, se guarda el nombre cortado y se devuelve el error
"DM_E_OOM".
lpdwVariableID
Puntero a un "DWORD" en el que se guarda la ID de variable.
Si está indicado "NULL", debe haber un puntero válido a "lpszVariableName" y un tamaño
válido en "dwVarNameCharCount". Entonces se devolverá solo el nombre de variable.
El retorno de la ID de variable ya no puede garantizarse (p. ej., variables Package,
determinadas variables S7, etc.). En estos casos se suministra "0".
Si es necesario, bajo ciertas condiciones puede completarse la información con una llamada
consecutiva de "DMGetVarInfoExStr".

lpdmError
Valor de retorno
TRUE
FALSE
Mensajes de error

DM_E_PARAM Parámetro no coherente
DM_E_OOM Error de memoria: el búfer "lpszVariableName" in‐
dicado en "dwVarNameCharCount" es demasiado
pequeño y se ha cortado el nombre
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMShowVarDatabaseMultiExStr Abrir cuadro de diálogo de selección de variables
Ejemplos
Ejemplo de script "Button DMShowVarDatabaseExStr":
lpszPropertyName)
{
BOOL bRet = FALSE;
CMN_ERROR err;
HWND hwndParent;
CHAR szVariableName[256];
LPSTR pszVariableName;
DWORD dwVarNamCharCount = 256;
DWORD dwVarID = 0L;

hwndParent = NULL;
pszVariableName= szVariableName;
printf("\r\n\r\n########## enter Test with DMShowVarDatabaseExStr

##########");

if (!bRet)
{
}
bRet = DMShowVarDatabaseExStr(szProjectName, hwndParent, NULL, NULL,

&pszVariableName, &dwVarNamCharCount,
&dwVarID, &err);
if (!bRet)
{
printf("\r\n error DMShowVarDatabaseExStr: err=%ld,%ld,%ld,%ld,
%ld,[%s]",
}
else
{
printf("\r\n DMShowVarDatabaseEsStr OK! (set to first line)");
printf("\r\n szVarName=[%s], dwVarID=[%ld]", szVariableName,
dwVarID);
SetTagChar("szVarKeyName_1",szVariableName);
SetTagDWord("dwVarKeyID_1",dwVarID);
}
3.2.6.34 DMShowVarDatabaseMulti (RT Professional)
Utilización
A diferencia de ShowVarDatabase, se pueden seleccionar varias variables.

Declaración
BOOL DMShowVarDatabaseMulti (
HWND hwndParent,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC lpfnVariables,
LPVOID lpvUser,
Parámetros
lpszProjectFile
hwndParent
lpdmOptions
Puntero a la estructura DM_DLGOPTIONS (Página 1589) con especificaciones de cómo debe
comportarse el cuadro de diálogo. Si es NULL, se utiliza el cuadro de diálogo estándar.
lpdmFilter
Puntero a la estructura de filtros DM_VARFILTER (Página 1603). En caso de NULL, se
muestran todas las variables.
Sólo se soporta el filtrado por nombre de variable y tipo de variable. El filtrado de variables
por grupos y conexiones no está implementado.
lpdwItems
Puntero a un búfer DWORD que incluye el número de variables seleccionadas.
lpfnVariables
Puntero a la función Callback que se llama para cada variable seleccionada.
lpvUser
lpdmError

Valor de retorno
TRUE
FALSE
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DM_NOTIFY_SELECT_VAR_PROC (Pági‐ Abrir cuadro de diálogo de selección de variables
na 1795) (Callback)
Consulte también
DM_DLGOPTIONS (Página 1589)
DM_NOTIFY_SELECT_VAR_PROC (Página 1795)

3.2.6.35 DMShowVarDatabaseMultiExStr (RT Professional)
Declaración
BOOL DMShowVarDatabaseMultiExStr (
HWND hwndParent,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC_EXSTR lpfnVariables,
LPVOID lpvUser,
Descripción
A diferencia de "ShowVarDatabaseExStr", se pueden seleccionar varias variables.
Parámetros
lpszProjectFile
hwndParent
lpdmOptions
Puntero a la estructura "DM_DLGOPTIONS" con especificaciones de cómo debe comportarse
el cuadro de diálogo; con "NULL", se corresponde con el cuadro de diálogo estándar.
lpdmFilter
Puntero a la estructura de filtro "DM_VARFILTER". Con "NULL", se muestran todas las
variables.
Solo se admite el filtrado por nombre y tipo de variable. El filtrado de variables por grupos y
conexiones no está implementado.
lpdwItems
Puntero a un búfer DWORD que incluye el número de variables seleccionadas en total.
lpfnVariables
Puntero a la función Callback que se llama para cada variable seleccionada.

lpvUser
lpdmError
Valor de retorno
TRUE
FALSE
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMShowVarDatabaseExStr Abrir cuadro de diálogo de selección de variables

DM_NOTIFY_SELECT_VAR_PROC_EXSTR Abrir cuadro de diálogo de selección de variables
(Callback)
Ejemplos
Ejemplo de script "Button DMShowVarDatabaseMultiExStr":
lpszPropertyName)
{
extern BOOL DM_NotifySelectVarProcA(LPCSTR lpszVariableName, DWORD
dwVariableID, LPVOID lpvUser);
BOOL bRet = FALSE;

CMN_ERROR err;

HWND hwndParent;
DWORD dwItems;
DWORD dwInxDecr;
hwndParent = NULL;
dwItems = 0;
dwInxDecr = 4; /*for decrement index to save in DM tags from callback
set to lpvUser*/
printf("\r\n\r\n########## enter Test with

DMShowVarDatabaseMultiExStr ##########");

if (!bRet)
{
}
bRet = DMShowVarDatabaseMultiExStr(szProjectName, hwndParent, NULL,

NULL,
&dwItems, DM_NotifySelectVarProcA,
&dwInxDecr, &err);
if (!bRet)
{
printf("\r\n error DMShowVarDatabaseMultiExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
}
else
{
printf("\r\n DMShowVarDatabaseExStrMulti OK!");
printf("\r\n [%ld] Var's selected", dwItems);
}
printf("\r\n########## exit Test with DMShowVarDatabaseMultiExStr

##########\r\n");
}
Ejemplo de script "Project-Function DM_NotifySelectVarProcA":
BOOL DM_NotifySelectVarProcA(LPCSTR lpszVariableName, DWORD

dwVariableID, LPVOID lpvUser)
{
BOOL bRet = TRUE;
DWORD* pdwInxDecr = NULL;

pdwInxDecr = (DWORD*)lpvUser;
printf("\r\n\r\n#### DM_NotifySelectVarProc entry: ####");

printf("\r\n VarName=[%s], VarID=[%ld], lpvUser=[0x%08lx]",
lpszVariableName, dwVariableID, lpvUser);
if (pdwInxDecr)
{
// handle max 4 outputs, ignore all others
if(4 == *pdwInxDecr )
{
SetTagChar("szVarKeyName_4",lpszVariableName);
SetTagDWord("dwVarKeyID_4",dwVariableID);
printf("\r\n save in szVarKeyName_4 and dwVarKeyID_4");
}
{
}
{
}
{
}
}
if (pdwInxDecr && (0L < *pdwInxDecr))
{
*pdwInxDecr = *pdwInxDecr - 1L;
printf("\r\n Inx=%ld", *pdwInxDecr);
}
printf("\r\n#### DM_NotifySelectVarProc exit ####\r\n");
return bRet;
}

3.2.6.36 DM_NOTIFY_SELECT_VAR_PROC (RT Professional)
Descripción
Para poder evaluar las variables seleccionadas en el diálogo de selección con la función
DMShowVarDatabaseMulti, es preciso facilitar una función Callback del tipo
DM_NOTIFY_SELECT_VAR_PROC.
Declaración
BOOL ( * DM_NOTIFY_SELECT_VAR_PROC) (
DWORD dwItem,
LPVOID lpvUser );
Parámetros
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 1612) con el nombre y
el identificador de una variable.
dwItem
Número de estructuras transmitidas en lpdmVarKey.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota

Archivos necesarios
dmclient.h
Consulte también
3.2.6.37 GAPICreateNewVariable (RT Professional)
Utilización
Crea una variable o comprueba si existe una. Esta función sólo puede aplicarse a variables
temporales, variables $.
Declaración
BOOL GAPICreateNewVariable (
LPMCP_NEWVARIABLE_DATA pData,
Parámetro
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA (Página 1615) con los datos de las
variables.
lpdmError
Valor de retorno
TRUE
Variable creada.
Al comprobar: La variable no existe.

FALSE
Error.
Al comprobar con Errorcode1 = DM_E_ALREADY_EXIST: La variable existe
Comentario
Hay funciones más avanzadas.
GAPICreateNewVariable4
GAPICreateNewVariableEx4
Mensajes de error

DM_E_ALREADY_EXIST El objeto que hay que crear ya existe
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas

Consulte también
3.2.6.38 GAPICreateNewVariable4 (RT Professional)
Utilización

Esta función se diferencia de GAPICreateNewVariable por la posible indicación de datos de

escala.
Declaración
BOOL GAPICreateNewVariable4 (
LPMCP_NEWVARIABLE_DATA_4 pData,
Parámetros
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_4 (Página 1618) con los datos de la
variable.
lpdmError
Valor de retorno
TRUE
Variable creada.
FALSE
Error.
Al comprobar con Errorcode1 = DM_E_ALREADY_EXIST: La variable existe.
Comentario
Hay funciones más avanzadas.
GAPICreateNewVariableEx4 Crear variable con ID de Creator

GAPICreateNewVariable5 Crear variable con ID de Creator
Mensajes de error


Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Consulte también
3.2.6.39 GAPICreateNewVariable5 (RT Professional)
Utilización
Esta función se diferencia de GAPICreateNewVariable4 por la indicación del causante y
porque los valores iniciales y de sustitución también se pueden indicar para variables de texto.
Declaración
BOOL GAPICreateNewVariable5 (
DWORD dwCreatorID,
Parámetros
dwCreatorID
sistemas.

pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_5 (Página 1620) con los datos de la
variable.
lpdmError
Valor de retorno
TRUE
Variable creada.
FALSE
Error.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Consulte también
MCP_VARIABLE_LIMITS5 (Página 1633)

3.2.6.40 GAPICreateNewVariableEx4 (RT Professional)
Utilización
Esta función se diferencia de GAPICreateNewVariable4 por la indicación del causante.
Declaración
BOOL GAPICreateNewVariableEx4 (
DWORD dwCreatorID,
Parámetro
dwCreatorID
sistemas.
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_4 (Página 1618) con los datos de las
variables.
lpdmError
Valor de retorno
TRUE
Variable creada.
FALSE
Error.

Comentario
Hay una función más avanzada.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Consulte también
3.2.7 Funciones para procesar variables estructuradas (RT Professional)
3.2.7.1 GAPIEnumTypeMembers (RT Professional)
Utilización
La función proporciona los nombres de las variables pertenecientes a una variable
estructurada.

Declaración
BOOL GAPIEnumTypeMembers (
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC lpfnCallback,
LPVOID lpvUser,
Parámetros
lpszProjectFile
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
que está abierto.
lpszTypeName
Nombre del tipo de una variable estructurada cuyas variables deben listarse.
lpfnCallback
Puntero a la función Callback que se llama para cada variable.
lpvUser
lpdmError
Valor de retorno
TRUE
Listar variables de una variable estructurada.
FALSE
Error.
Archivos necesarios
dmclient.h

dmclient.lib
dmclient.dll
DM_ENUM_TYPEMEMBERS_PROC Listar variables de una variable estructurada

(Página 1804) (Callback)
GAPIEnumTypeMembersEx (Pági‐ Listar variables de una variable estructurada
na 1805)
GAPIEnumTypeMembersEx4 (Pági‐ Listar variables de una variable estructurada
na 1810)
Consulte también
DM_ENUM_TYPEMEMBERS_PROC (Página 1804)
GAPIEnumTypeMembersEx (Página 1805)
GAPIEnumTypeMembersEx4 (Página 1810)
3.2.7.2 DM_ENUM_TYPEMEMBERS_PROC (RT Professional)
Descripción
Para poder evaluar los nombres de variable listados en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_TYPEMEMBERS_PROC.
Declaración
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC) (
LPCSTR lpszMemberName,
LPVOID lpvUser );
Parámetros
lpszStructTypeName
Puntero al nombre de las variables pertenecientes a una variable estructurada.
lpvUser
función Callback.

Valor de retorno
TRUE
FALSE
Nota
● Funciones ODK de la misma DLL
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
GAPIEnumTypeMembers (Página 1800) Listar variables de una variable estructurada
Consulte también
GAPIEnumTypeMembers (Página 1800)
3.2.7.3 GAPIEnumTypeMembersEx (RT Professional)
Utilización
La función proporciona una descripción que incluye todos los valores predeterminados de las
variables pertenecientes a una variable estructurada, pero sin los datos de escala.
Si también se quieren leer los datos de escala, se necesita la función
GAPIEnumTypeMembersEx4.

Declaración
BOOL GAPIEnumTypeMembersEx (
DM_ENUM_TYPEMEMBERS_PROC_EX lpfnCallback,
LPVOID lpvUser,
Parámetros
lpszProjectFile
que está abierto.
lpszTypeName
En los clientes sólo pueden enumerarse tipos de variables locales.
lpfnCallback
lpvUser
lpdmError
Valor de retorno
TRUE
Variables de una variable estructurada listadas.
FALSE
Error.

Comentario
Hay una función más avanzada: GAPIEnumTypeMembersEx4.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_ENUM_TYPEMEMBERS_PROC_EX Listar variables de una variable estructurada (Callback)

(Página 1809)
na 1810)
Consulte también
3.2.7.4 GAPIEnumTypeMembersExStr (RT Professional)
Declaración
BOOL GAPIEnumTypeMembersExStr (
LPCTSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
Descripción
La función proporciona una descripción que incluye todos los valores predeterminados de las
variables pertenecientes a una variable estructurada, pero sin los datos de escala.

Parámetros
lpszProjectFile
A partir de la versión V5.0 SP2 de WinCC, al indicar una cadena vacía se ejecuta un
"DMEnumOpenedProjects" interno con el proyecto que está abierto.
En runtime solo debe indicarse el proyecto que está abierto. A partir de la versión V5.0 SP2
de WinCC, si se indica algo diferente, los datos se rechazarán con el error
"DM_E_NOT_CONNECTED".
lpszTypeName
Nombre del tipo de una variable estructurada cuyas variables se muestran listadas.
En multiclientes (V5) y clientes (V6) solo pueden enumerarse tipos de variables locales.
lpfnCallback
lpvUser
lpdmError
Valor de retorno
TRUE
Variables de una variable estructurada listadas
FALSE
Error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll

DM_ENUM_TYPEMEM‐ Listar variables de una variable estructurada (Callback)

BERS_PROC_EXSTR
GAPIEnumTypeMembersEx4 Listar variables de una variable estructurada
3.2.7.5 DM_ENUM_TYPEMEMBERS_PROC_EX (RT Professional)
Descripción
Para poder evaluar las descripciones de variable listadas en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_TYPEMEMBERS_PROC_EX.
Declaración
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC_EX) (
LPMCP_NEWVARIABLE_DATA_EX lpdmVarDataEx,
LPVOID lpvUser );
Parámetros
lpdmVarKey
Puntero a la primera de las estructuras del tipo AUTOHOTSPOT con las claves (ID y nombre)
de una variable
lpdmVarDataEx
Puntero a una estructura del tipo MCP_NEWVARIABLE_DATA_EX (Página 1622) con la
descripción de una variable.
lpvUser
función Callback.
Valor de retorno
TRUE

FALSE
Nota
Archivos necesarios
dmclient.h
GAPIEnumTypeMembersEx (Pági‐ Listar variables de una variable estructurada

na 1803)
Consulte también
3.2.7.6 GAPIEnumTypeMembersEx4 (RT Professional)
Utilización
La función proporciona una descripción completa que incluye todos los valores
predeterminados de las variables pertenecientes a una variable estructurada.
Declaración
BOOL GAPIEnumTypeMembersEx4 (
DM_ENUM_TYPEMEMBERS_PROC_EX4 lpfnCallback,
LPVOID lpvUser,

Parámetros
lpszProjectFile
que está abierto.
rechazan (DM_E_NOT_CONNECTED).
lpszTypeName
En los clientes sólo pueden enumerarse tipos de variables locales.
lpfnCallback
lpvUser
lpdmError
Valor de retorno
TRUE
Variables de una variable estructurada listadas.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DM_ENUM_TYPEMEMBERS_PROC_EX4 Listar variables de una variable estructurada (Call‐

(Página 1812) back)
Consulte también
3.2.7.7 DM_ENUM_TYPEMEMBERS_PROC_EX4 (RT Professional)
Descripción
Para poder evaluar las descripciones de variable listadas en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_TYPEMEMBERS_PROC_EX4. Se diferencia de
DM_ENUM_TYPEMEMBERS_PROC_EX por la salida adicional de los datos de escala.
Declaración
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC_EX4) (
LPMCP_NEWVARIABLE_DATA_EX4 lpdmVarDataEx,
LPVOID lpvUser );
Parámetros
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 1612) con las claves
(ID y nombre) de una variable
lpdmVarDataEx
Puntero a una estructura del tipo MCP_NEWVARIABLE_DATA_EX4 (Página 1624) con la
descripción de una variable.
lpvUser
función Callback.

Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h

na 1808)
Consulte también
3.2.7.8 GAPIEnumTypes (RT Professional)
Utilización
La función lista los nombres y números de ID de los tipos de variable estructurada configurados

Declaración
BOOL GAPIEnumTypes (
DM_ENUM_TYPES_PROC lpfnCallback,
LPVOID lpvUser,
Parámetros
lpszProjectFile
que está abierto.
lpfnCallback
Puntero a la función Callback que recibe los datos de los tipos de variables.
lpvUser
lpdmError
Valor de retorno
TRUE
Tipos de variables estructuradas listados.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DM_ENUM_TYPES_PROC (Pági‐ Listar tipos de variables estructuradas (Callback)

na 1815)
Ejemplos
Enumerate all structured types (Página 1858) "DM01.cpp"
Consulte también
DM_ENUM_TYPES_PROC (Página 1815)
Enumerate all structured types (Página 1858)
3.2.7.9 DM_ENUM_TYPES_PROC (RT Professional)
Descripción
Para poder evaluar los tipos de variables listados en el sistema, es preciso facilitar una función
Callback del tipo DM_ENUM_TYPES_PROC.
Declaración
BOOL ( * DM_ENUM_TYPES_PROC) (
DWORD dwTypeID,
DWORD dwCreatorID,
LPVOID lpvUser );
Parámetros
lpszTypeName
Puntero al nombre del tipo de variable.
dwTypeID
dwTypeID equivale a la identificación que GAPICreateType ha asignado para el tipo de
variable.
dwCreatorID
sistemas.

lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h
GAPIEnumTypes (Página 1811) Listar tipos de variables estructuradas
Ejemplos
Enumerate all structured types (Página 1858) "DM01.cpp"
Consulte también
GAPIEnumTypes (Página 1811)
Enumerate all structured types (Página 1858)

3.2.8 Funciones para procesar conexiones (RT Professional)
3.2.8.1 DMEnumConnectionData (RT Professional)
Utilización
La función determina los datos de una conexión lógica configurada.
Declaración
BOOL DMEnumConnectionData (
LPDM_CONNKEY lpdmConnKey,
DWORD dwItems,
DM_ENUM_CONNECTION_PROC lpfnCallback,
LPVOID lpvUser,
Parámetros
lpszProjectFile
lpdmConnKey
Puntero a la primera de las estructuras del tipo DM_CONNKEY (Página 1585). En estas
estructuras se especifican las conexiones lógicas cuyos datos se enumeran.
dwItems
Número de conexiones lógicas cuyos datos se listan.
Con el valor 0 se inicia una lista de todas las conexiones.
lpfnCallback
Puntero a la función Callback que recibe los datos de la conexión lógica.
lpvUser
lpdmError

Valor de retorno
TRUE
Datos listados.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_ENUM_CONNECTION_PROC (Pági‐ Listar datos de conexión (Callback)

na 1820)
Ejemplos
Enumerate all connections (Página 1860) "DM01.cpp"
OnTestEnumConnectionDataAll (Página 1865) "TESTCDoc.cpp"
Consulte también
DM_CONNKEY (Página 1585)
Enumerate all connections (Página 1860)
OnTestEnumConnectionDataAll (Página 1865)

3.2.8.2 DMEnumConnectionDataExStr (RT Professional)
Declaración
BOOL DMEnumConnectionDataExStr (
DM_ENUM_CONNECTION_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
LPDWORD lpdwConnectionCount,
Descripción
Con la función se determinan todas las conexiones lógicas configuradas.
Parámetros
lpszProjectFile
lpfnCallback
Puntero a la función Callback que recibe los datos de la conexión lógica.
lpvUser
lpdwConnectionCount
Puntero a un "DWORD" en el que se devuelve el número de conexiones existentes.
Con "lpfnCallback = NULL", primero se determina cuánta memoria se necesita para las
conexiones.
lpdmError
Valor de retorno
TRUE
Datos listados

FALSE
Error
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DM_ENUM_CONNECTION_PROC_EXSTR Listar datos de conexión (Callback)
3.2.8.3 DM_ENUM_CONNECTION_PROC (RT Professional)
Descripción
Para poder evaluar los datos de una conexión lógica listados en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_CONNECTION_PROC.
Declaración
BOOL ( * DM_ENUM_CONNECTION_PROC) (
LPDM_CONNECTION_DATA lpdmConData,
LPVOID lpvUser);
Parámetros
lpdmConData
Puntero a una estructura del tipo DM_CONNECTION_DATA (Página 1584) en la que están
guardados los datos de una combinación lógica.
lpvUser
función Callback.

Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h
DMEnumConnectionData (Página 1815) Listar datos de conexión
Ejemplos
Enumerate all connections (Página 1860) "DM01.cpp"
Consulte también
DM_CONNECTION_DATA (Página 1584)
Enumerate all connections (Página 1860)
3.2.9 Funciones de la plataforma de trabajo (RT Professional)
3.2.9.1 DMGetOSVersion (RT Professional)
Utilización
Determina el sistema operativo que se utiliza en el PC.

Declaración
DWORD DMGetOSVersion (
VOID);
Parámetros
Ninguno.
Valor de retorno
El valor de retorno identifica el sistema operativo utilizado:
DM_OS_UNKNOWN 0 Sistema operativo desconocido

DM_OS_NT 1 Windows NT
DM_OS_32S 2 Windows 3.x con Win 32s
DM_OS_CHICAGO 3 Windows 95
DM_OS_2000 4 Windows 2000
DM_OS_XP 5 Windows XP
DM_OS_2003 6 Windows 2003
DM_OS_VISTA_32 0x0600 Windows Vista 32 bits
1
DM_OS_VISTA_SP1_32 0x0601 Windows Vista 32 bits Service Pack 1
1
1
DM_OS_VISTA_64 0x9600 Windows Vista 64 bits
1
1
1
DM_OS_S2008_32 0x0600 Windows Server 2008 32 bits
3
DM_OS_S2008_SP1_32 0x0601 Windows Server 2008 32 bits Service Pack 1
3
3
3
3
3
DM_OS_W7_32 0x0610 Windows 7 32 bits
1

DM_OS_W7_SP1_32 0x0611 Windows 7 32 bits Service Pack 1

1
1
DM_OS_W7_SP1_64 0x9611 Windows 7 64 bits Service Pack 1
1
DM_OS_S2008R2_32 0x0610 Windows Server 2008 R2 32 bits
3
DM_OS_S2008R2_SP1_32 0x0611 Windows Server 2008 R2 32 bits Service Pack 1
3
3
DM_OS_S2008R2_SP1_64 0x9611 Windows Server 2008 R2 64 bits Service Pack 1
3
DM_OS_W8_32 0x0620 Windows 8 32 Bit
1
1
3
3
DM_OS_W81_32 0x0630 Windows 8.1 32 bits
1
DM_OS_W81_64 0x9630 Windows 8.1 64 bits
1
3
3
1
3
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.9.2 DMGetSystemLocale (RT Professional)
Utilización
Retorna el código del idioma de configuración que se está utilizando.

Declaración
BOOL DMGetSystemLocale (
LPDWORD lpdwLocaleID,
Parámetros
lpdwLocaleID
Puntero al código del idioma ajustado actualmente.
Los posibles valores de retorno son los códigos de idioma de:
Alemán 0x0407
Inglés 0x0409
Francés 0x040C
lpdmError
Valor de retorno
TRUE
Idioma de configuración ajustado actualmente determinado.
FALSE
Error
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestSystemLocale (Página 1871) "TESTCDoc.cpp"

Consulte también
OnTestSystemLocale (Página 1871)
3.2.9.3 DMSetLanguage (RT Professional)
Utilización
Inicia el cambio del idioma de configuración.
Declaración
BOOL DMSetLanguage (
DWORD dwLocaleID,
Parámetros
dwLocaleID
Puntero al código del idioma que debe ajustarse. Los posibles valores son los códigos de
idioma de:
Alemán 0x0407
Inglés 0x0409
Francés 0x040C
lpdmError
Valor de retorno
TRUE
Idioma cambiado.
FALSE
Error.
Mensajes de error
DM_E_NOT_SUPPORTED Servicio solicitado no disponible

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.9.4 DMShowLanguageDialog (RT Professional)
Utilización
La función abre un cuadro de diálogo para seleccionar el idioma.
Declaración
BOOL DMShowLanguageDialog (
HWND hwndParent,
DWORD dwFlags,
DWORD dwSetLocaleIDs[],
UINT uSetIDArraySize,
LPDWORD lpdwGetLocaleID,
Parámetros
hwndParent
dwFlags
dwFlags identifica los idiomas que se muestran en el cuadro de diálogo y que pueden
seleccionarse:
DM_LANGDLG_REMOVE activa Además de los idiomas de la matriz dwSetLocaleIDs, se mues‐

tran todos los idiomas que pueden detectarse con EnumSystem‐
Locales (LCID_SUPPORTED).
No activa Se muestran todos los idiomas de la matriz dwSetLocaleIDs.
DM_LANGDLG_ONLY_PRIMARY activa Se muestran sólo los idiomas principales (PRIMARY_LANGUA‐
GE).
No activa También se muestran idiomas secundarios.
DM_LANGDLG_NO_NOTIFY Al cerrar el cuadro de diálogo con "Aceptar" no se envía notifica‐
ción a las aplicaciones
dwSetLocaleIDs
Matriz con las IDs de los idiomas que deben mostrarse en el cuadro de diálogo.

uSetIDArraySize
Tamaño de la matriz dwSetLocaleIDs.
lpdwGetLocaleID
Puntero a un DWORD en el que debe depositarse la ID de idioma seleccionada.
lpdmError
Valor de retorno
TRUE
FALSE
Mensajes de error

de diálogo
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
3.2.10 Funciones para actualizar variables (RT Professional)
3.2.10.1 DMBeginStartVarUpdate (RT Professional)
Utilización
Iniciar solicitud de actualización. En esta función se asigna una ID de transacción que identifica
la transacción.

Declaración
BOOL DMBeginStartVarUpdate (
LPDWORD pdwTAID
LPCMN_ERROR lpdmError )
Parámetros
pdwTAID
lpdmError
Valor de retorno
TRUE
Asignar ID de transacción.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenBeginstartvarupdate (Página 1872) "TESTCDoc.cpp"
Consulte también
OnTestVariablenBeginstartvarupdate (Página 1872)
DMEndStartVarUpdate (Página 1829)
DMResumeVarUpdate (Página 1830)


DMStopVarUpdate (Página 1848)
DMSuspendVarUpdate (Página 1849)
3.2.10.2 DMEndStartVarUpdate (RT Professional)
Utilización
Tras una llamada correcta de la función, el administrador de datos aplica la actualización de
la variable y, si es necesario, transmite los nuevos valores a la aplicación.
Declaración
BOOL DMEndStartVarUpdate (
DWORD dwTAID,
Parámetros
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmError
Valor de retorno
TRUE
Actualización iniciada.
FALSE
Error.
Mensajes de error

DM_E_INVALID_TAID ID de transacción no válida

Archivos necesarios
dmclient.h
DMBeginStartVarUpdate (Página 1825) Iniciar solicitud de actualización

Ejemplos
OnTestVariablenEndstartvarupdate (Página 1873) "TESTCDoc.cpp"
Consulte también
OnTestVariablenEndstartvarupdate (Página 1873)
DMBeginStartVarUpdate (Página 1825)
3.2.10.3 DMResumeVarUpdate (RT Professional)
Utilización
Inicia la actualización de todas las variables definidas con la transacción si durante la llamada
el contador de referencias de la transacción alcanza el valor 0.
La función calcula el equivalente a DMSuspendVarUpdate y siempre debe ser llamada de dos
en dos con él.
Declaración
BOOL DMResumeVarUpdate (
DWORD dwTAID,
Parámetros
dwTAID
lpdmError

Valor de retorno
TRUE
Continuar la actualización.
FALSE
Error.
Comentario
Las transacciones disponen de un contador de referencias que se incrementa en cada llamada
de la función DMSuspendVarUpdate. Si la actualización de las variables debe continuarse,
DMResumeVarUpdate debe ser llamado varias veces hasta que el contador de referencias
vuelva a 0.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DMSuspendVarUpdate (Página 1849) Interrumpir la actualización de variables
Ejemplos
OnTestVariablenResumevarupdate (Página 1884) "TESTCDoc.cpp"
Consulte también
OnTestVariablenResumevarupdate (Página 1884)

3.2.10.4 DMStartVarUpdate (RT Professional)
Utilización
La función sirve para ajustar las variables que tiene que actualizar el administrador de datos.
En la función Callback, el administrador de datos transfiere, en caso de actualización, los
nuevos valores de variables a la aplicación.
DMStartVarUpdateEx es una función más avanzada en la que en la estructura
DM_VAR_UPDATE_STRUCTEX en el Callback DM_NOTIFY_VARIABLEEX_PROC se
proporciona además el QualityCode.
Declaración
BOOL DMStartVarUpdate (
DWORD dwTAID,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
Parámetros
dwTAID
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 1612) en las que se
especifican las variables que hay que actualizar.
dwItems
Número de variables que hay que actualizar en las estructuras DM_VARKEY transmitidas.
dwCycle
El ciclo de actualización determinado en dwCycle es válido para todas las variables ajustadas
con lpdmVarKey. El ciclo de actualización se define con el índice de las entradas de la lista
de ciclos de actualización.
"En caso de modificación" Acíclico Índice: 0

"250 ms" 250 Índice: 1
"500 ms" 500 Índice: 2
"1 s" 1000 Índice: 3
"2 s" 2000 Índice: 4
"5 s" 5000 Índice: 5
"10 s" 10000 Índice: 6

"1 min" 60000 Índice: 7

"5 min" 300000 Índice: 8
"10 min" 600000 Índice: 9
"1 h" 3600000 Índice: 10
"Ciclo de usuario 1" (p. ej., 2000) Índice: 11
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLE_PROC para transmitir datos a través
del administrador de datos.
Si lpfnVariable == NULL, la actualización en la memoria imagen de proceso del administrador
de datos se realiza al menos en el ciclo solicitado, siempre que sea posible físicamente por
la carga momentánea del sistema, el rendimiento del equipo, el medio de acoplamiento, etc.
No obstante, la determinación del valor correspondiente debe realizarse de forma
independiente llamando la función DMGetValue a través de la aplicación.
WinCC.
En algunos casos excepcionales sucede que Notify ya se ha entregado antes de que se
devuelva la llamada de función.
lpvUser
lpdmError
Valor de retorno
TRUE
Variables de actualización definidas.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll


DM_NOTIFY_VARIABLE_PROC (Página 1834) Definir variables de actualización (Callback)
Consulte también
3.2.10.5 DM_NOTIFY_VARIABLE_PROC (RT Professional)
Descripción
Para poder evaluar los datos determinados en el sistema, es preciso facilitar una función
Callback del tipo DM_NOTIFY_VARIABLE_PROC.
Declaración
BOOL ( * DM_NOTIFY_VARIABLE_PROC) (
DWORD dwTAID,
DWORD dwItems,
LPVOID lpvUser);
Parámetros
dwTAID
IDs de transacción que el administrador de datos ha asignado a la función que realiza la
llamada.
lpdmvus
Puntero a la primera de las estructuras del tipo DM_VAR_UPDATE_STRUCT (Página 1598)
que contienen los valores de las variables solicitadas.
dwItems
Número de estructuras transmitidas en lpdmvus (equivale al número de valores de variables
proporcionados).
lpvUser
función Callback.

Valor de retorno
Comentario
Nota
WinCC.
Archivos necesarios
dmclient.h
lización
Consulte también
3.2.10.6 DMStartVarUpdateEx (RT Professional)
Utilización

A diferencia de DMStartVarUpdate, en la estructura DM_VAR_UPDATE_STRUCTEX se

proporciona el Quality Code que se devuelve en el Callback
DM_NOTIFY_VARIABLEEX_PROC .
Declaración
BOOL DMStartVarUpdateEx (
DWORD dwTAID,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
Parámetros
dwTAID
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 1612) en las que se
especifican las variables que hay que actualizar.
dwItems
Número de variables que hay que actualizar en las estructuras DM_VARKEY transmitidas.
dwCycle
El ciclo de actualización determinado es válido para todas las variables ajustadas con
lpdmVarKey . El ciclo de actualización se define con el índice de las entradas de la lista de
ciclos de actualización.
"Al cambiar" Acíclico Índice: 0

"250 ms" 250 Índice: 1
"500 ms" 500 Índice: 2
"1 s" 1000 Índice: 3
"2 s" 2000 Índice: 4
"5 s" 5000 Índice: 5
"10 s" 10000 Índice: 6
"1 min" 60000 Índice: 7
"5 min" 300000 Índice: 8
"10 min" 600000 Índice: 9
"1 h" 3600000 Índice: 10


lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLEEX_PROC para transmitir datos a
través del administrador de datos.
Si lpfnVariable == NULL, la actualización en la memoria imagen de proceso del administrador
de datos se realiza al menos en el ciclo solicitado, siempre que sea posible físicamente por
la carga momentánea del sistema, el rendimiento del equipo, el medio de acoplamiento, etc.
No obstante, la determinación del valor correspondiente debe realizarse de forma
independiente llamando la función DMGetValue a través de la aplicación.
WinCC.
lpvUser
lpdmError
Valor de retorno
TRUE
Variables de actualización definidas.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DM_NOTIFY_VARIABLEEX_PROC (Pági‐ Definir variables de actualización (Callback)
na 1845)

Consulte también
3.2.10.7 DMStartVarUpdateExStr (RT Professional)
Declaración
BOOL DMStartVarUpdateExStr (
DWORD dwTAID,
DWORD dwFlags,
LPVARIANT lpvCookie,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
Descripción
Parámetros
dwTAID
Contiene la ID de transacción asignada al llamar la función "DMBeginStartVarUpdate".
dwFlags
"DM_VAR_UPDATE_STRUCT_EXSTR" de "DM_NOTIFY_VARIABLE_PROC_EXSTR" en
formato "VT_LPSTR", aquí puede especificarse el indicador
"DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKey
variables que identifica las variables que hay que modificar.
"VT_BSTR".

lpvCookie
Puntero a un VARIANT para una lista adicional de datos específicos de usuario para cada
variable.
Está pensado para sustituir "lpvUserData" del anterior "DM_VARKEY" y se devuelve también
en la estructura "DM_VAR_UPDATE_STRUCT_EXSTR" para cada variable.
dwCycle
El ciclo de actualización especificado es válido para todas las variables definidas con
"lpvdmVarKey". El ciclo de actualización se define con el índice de las entradas de la lista de
ciclos de actualización.
"Al cambiar" acíclico Índice: 0

"250 ms" 250 Índice: 1
"500 ms" 500 Índice: 2
"1 s" 1000 Índice: 3
"2 s" 2000 Índice: 4
"5 s" 5000 Índice: 5
"10 s" 10000 Índice: 6
"1 min" 60000 Índice: 7
"5 min" 300000 Índice: 8
"10 min" 600000 Índice: 9
"1 h" 3600000 Índice: 10
lpfnVariable
Puntero a la función Callback "DM_NOTIFY_VARIABLEEX_PROC" para transferir datos a
través del administrador de datos.
Si "lpfnVariable" == "NULL", la actualización en la memoria imagen de proceso del
administrador de datos se realiza al menos en el ciclo solicitado, siempre que sea posible
físicamente por la carga momentánea del sistema, el rendimiento del equipo, el medio de
acoplamiento, etc. No obstante, el valor correspondiente debe determinarlo el propio usuario
con una llamada de la función "DMGetValue" mediante la aplicación.
WinCC.
lpvUser

lpdmError
Valor de retorno
TRUE
Variables de actualización definidas
FALSE
Error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DMBeginStartVarUpdate Iniciar solicitud de actualización
Ejemplos
Ejemplo de script "Button DMStartVarUpdateExStr":
lpszPropertyName)
{
int cElements );
#pragma code()
extern BOOL DM_NOTIFY_VARIABLE_PROC_EXSTR

DM_NotifyVariableProcExStr_VarUpdate(
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT_EXSTRA lpdmvus,
DWORD dwItems,
LPVOID lpvUser);
VARIANT vVarKey;

VARIANT* pvElem;
SAFEARRAY* parrayKeys;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
long lInx;
DWORD dwTAID;
DWORD dwFlags;
DWORD dwCycle;
bRet = FALSE;
parrayKeys = NULL;
lInx = 0L;
//dwCycle = 3; /* 1sec*/
dwCycle = 0; /* on change*/
printf("\r\n\r\n########## enter Test with DMStartVarUpdateExStr

##########");
dwTAID = GetTagDWord("dwUpdTAID");
if (dwTAID)
{
printf("\r\nStartVarUpdate always running. Stop it before start
again!");
printf("\r\n########## exit Test with DMStartVarUpdateExStr
(nothing done) ##########\r\n");
return;
}
VariantInit(&vVarKey);
parrayKeys = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarKey.vt = VT_ARRAY | VT_VARIANT;
vVarKey.u.parray = parrayKeys;
SafeArrayLock(parrayKeys);
lInx = 0L;
lInx = 1L;
lInx = 2L;

lInx = 3L;
SafeArrayUnlock(parrayKeys);
bRet = DMBeginStartVarUpdate(&dwTAID, &err);

if (FALSE == bRet)
{
printf("\r\n error DMBeginStartVarUpdate, err=%ld,%ld,%ld,%ld,
%ld,[%s]",
err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMBeginStartVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
if (dwTAID)
{
SetTagDWord("dwUpdTAID",dwTAID);
bRet = DMStartVarUpdateExStr(dwTAID, dwFlags, &vVarKey, dwCycle,
DM_NotifyVariableProcExStr_VarUpdate,
NULL, &err);
if (FALSE == bRet)
{
printf("\r\n error DMStartVarUpdateExStr (dwTAID=%ld): err=
%ld,%ld,%ld,%ld,%ld,[%s]",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
}
else
{
printf("\r\n DMStartVarUpdateExStr (dwTAID=%ld) OK.",
dwTAID);
}
bRet = DMEndStartVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n error DMEndStartVarUpdate (dwTAID=%ld): err=
%ld,%ld,%ld,%ld,%ld,[%s]",
}
else
{
printf("\r\n DMEndStartVarUpdate (dwTAID=%ld) OK.", dwTAID);
}

}
else
{
printf("\r\n dwTAID == 0L ???");
}
printf("\r\n########## exit Test with DMStartVarUpdateExStr (dwTAID=

%ld) ##########\r\n", dwTAID);
Ejemplo de script "Project-Function DM_NotifyVariableProcExStr_VarUpdate":

#pragma code()
BOOL DM_NotifyVariableProcExStr_VarUpdate(
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT_EXSTRA lpdmvus,
DWORD dwItems,
LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
HRESULT hr = 0L;
printf("\r\n*** DM_NotifyVariableProcExStr_VarUpdate entry (dwTAID=

%ld) ***", dwTAID);

{
hr = VariantChangeType((VARIANTARG*)&(lpdmvus[i].vdmValue),
(VARIANTARG*)&(lpdmvus[i].vdmValue), 0,
VT_R8);
if (VT_LPSTR == lpdmvus[i].vdmVarKey.vt)
{
printf("\r\n [%d]:{VarKey=[%s]", i,
(LPCSTR)lpdmvus[i].vdmVarKey.u.pbVal);
}
else if (VT_I4 == lpdmvus[i].vdmVarKey.vt)
{
printf("\r\n [%d]:{VarKey=[%ld]", i,
lpdmvus[i].vdmVarKey.u.lVal);
}
else
{
printf("\r\n [%d]:{unexpected VarKey.vt=[%d]",
lpdmvus[i].vdmVarKey.vt);

}
printf(", dmValue=[%g]", lpdmvus[i].vdmValue.u.dblVal);
printf(", dwState=[%ld]", lpdmvus[i].dwState);
printf(", dwType=[%ld]", lpdmvus[i].dmTypeRef.dwType);
printf(", dwSize=[%ld]", lpdmvus[i].dmTypeRef.dwSize);
if (lpdmvus[i].dmTypeRef.lpszTypeName)
{
printf(", lpszTypeName=[%s]",
lpdmvus[i].dmTypeRef.lpszTypeName);
lpdmvus[i].dmTypeRef.dwNameCharCount);
}
else
{
printf(", lpszTypeName=[NULL]");
}
printf("}");
}
printf("\r\n*** DM_NotifyVariableProcExStr_VarUpdate exit (dwTAID=

%ld)***", dwTAID);
return bRet;
}
Ejemplo de script "Button DMStopVarUpdate":
lpszPropertyName)
{
DWORD dwTAID;
CMN_ERROR err;
BOOL bRet;
dwTAID = GetTagDWord("dwUpdTAID");
bRet = FALSE;
if (dwTAID)
{
bRet = DMStopVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n!!! error DMStopVarUpdate (dwTAID=%ld): err=%ld,
%ld,%ld,%ld,%ld,[%s] !!!\r\n",
bRet = DMStopAllUpdates(&err);
if (FALSE == bRet)
{

printf("\r\n!!! error DMStopAllUpdates (dwTAID=%ld):

err=%ld,%ld,%ld,%ld,%ld,[%s] !!!\r\n",
}
else
{
printf("\r\n DMStopAllUpdates OK.");
}
}
else
{
printf("\r\n DMStopVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
}
dwTAID = 0L;
SetTagDWord("dwUpdTAID",dwTAID);
}
3.2.10.8 DM_NOTIFY_VARIABLEEX_PROC (RT Professional)
Descripción
Para poder evaluar los datos determinados en el sistema, es preciso facilitar una función
Callback del tipo DM_NOTIFY_VARIABLEEX_PROC.
Declaración
BOOL ( * DM_NOTIFY_VARIABLEEX_PROC) (
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
DWORD dwItems,
LPVOID lpvUser);
Parámetros
dwTAID
IDs de transacción que el administrador de datos ha asignado a la función que realiza la
llamada.
lpdmvus
Puntero a la primera de las estructuras del tipo DM_VAR_UPDATE_STRUCTEX
(Página 1600) que contienen los valores de las variables solicitadas.

dwItems
Número de estructuras transmitidas en lpdmvus (equivale al número de valores de variables
proporcionados).
lpvUser
función Callback.
Valor de retorno
Comentario
Nota
WinCC.
Archivos necesarios
dmclient.h
DMGetValueWaitEx (Página 1727) Determinar los valores de las variables con actua‐
lización
DMStartVarUpdateEx (Página 1833) Definir variables de actualización
Consulte también

3.2.10.9 DMStopAllUpdates (RT Professional)
Utilización
Finaliza todas las actualizaciones de variables solicitadas por la aplicación. Es preferible
llamar esta función al finalizar el módulo correspondiente.
Declaración
BOOL DMStopAllUpdates (
Parámetros
lpdmError
Valor de retorno
TRUE
Actualización de variables finalizada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenStopallupdates (Página 1887) "TESTCDoc.cpp"
Consulte también
OnTestVariablenStopallupdates (Página 1887)

3.2.10.10 DMStopVarUpdate (RT Professional)
Utilización
Finaliza la actualización de variables de una transacción determinada.
Declaración
BOOL DMStopVarUpdate (
DWORD dwTAID,
Parámetros
dwTAID
lpdmError
Valor de retorno
TRUE
Actualización de las variables finalizada.
FALSE
Error.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

Ejemplos
OnTestVariablenStopvarupdate (Página 1887) "TESTCDoc.cpp"
Consulte también
OnTestVariablenStopvarupdate (Página 1887)
3.2.10.11 DMSuspendVarUpdate (RT Professional)
Utilización
Interrumpe la actualización de todas las variables definidas con la transacción.
Las variables se siguen actualizando dentro de la memoria imagen de proceso del
administrador de datos. No obstante, los valores actuales ya no se transfieren a la aplicación.
Declaración
BOOL DMSuspendVarUpdate (
DWORD dwTAID,
Parámetros
dwTAID
lpdmError
Valor de retorno
TRUE
Actualización interrumpida.
FALSE
Error.

Comentario
Las transacciones disponen de un contador de referencias de manera que la función
DMSuspendVarUpdate pueda ser llamada varias veces para una transacción. Si la
transacción ya tiene el estado "SUSPENDED", sólo se incrementa el contador de referencias.
Para seguir actualizando, DMResumeVarUpdate debe ser llamado varias veces hasta que el
contador de referencias vuelva a 0.
Mensajes de error

Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll

DMResumeVarUpdate (Página 1828) Continuar la actualización de variables
Ejemplos
OnTestVariablenSuspendvarupdate (Página 1888) "TESTCDoc.cpp"
Consulte también
OnTestVariablenSuspendvarupdate (Página 1888)

3.2.11 Ejemplos (RT Professional)
3.2.11.1 Connection to DM (RT Professional)
Ejemplo
// =====================================================================
// =====================================================================
// Desc. : Modul with examples for Data-Manager
// *********************************************************************
#include "stdafx.h" // if MFC classes
// #include "odkapi.h" // if console application
#include <time.h>
TCHAR g_szProjectFile[255] = {0};
TCHAR g_szDSNName[255] = {0};
#include "DM01.h"
//{{ODK_EXAMPLE}Connection to DM (MCP)}
//{{FUNCTION}DMGetConnectionState (MCP)}
//{{FUNCTION}DMConnect (MCP)}
//{{FUNCTION}DM_NOTIFY_PROC (MCP)}
//{{FUNCTION}DMDisConnect (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMConnect(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szAppName[255];
VOID* pvUser = AfxGetApp();
_tcsncpy_s(szAppName, _countof(szAppName), _T("MyODKApp_23"), _TRUNCATE);
memset(&Error, 0,sizeof(CMN_ERROR));
ret = DMGetConnectionState(&Error);
if(FALSE == ret) // not connected
{
ret = DMConnect(szAppName, MyDMNotifyCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMConnect"));
}
ODKTrace(szText);
}

else // already connected

{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMGetConnectionState: OK"));
}
{
ODKTrace(szText);
}
return(ret);
}
// IMPLEMENTATION
// =====================================================================
// Function: MyDMGetConnectionState(void) ODK DM CS
// =====================================================================
BOOL MyDMGetConnectionState(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szAppName[255];
_tcsncpy_s(szAppName, _countof(szAppName), _T("MyODKApp_23"), _TRUNCATE);
ret = DMGetConnectionState(&Error);
if(FALSE == ret) // not connected
{
ret = DMConnect(szAppName, MyDMNotifyCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMConnect"));
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
{
ODKTrace(szText);
}
return(ret);
}
// =====================================================================
// Function: MyDMDisConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMDisConnect(void)
{

CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
memset(&Error, 0, sizeof(CMN_ERROR));
ret = DMDisConnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMDisconnect"));
}
ODKTrace(szText);
return(ret);
}
// =====================================================================
// Function: MyDMNotifyCallback
// =====================================================================
BOOL MyDMNotifyCallback(DWORD dwNotifyClass, DWORD dwNotifyCode, LPBYTE lpbyData,
DWORD dwItems, LPVOID lpvUser)
{
lpvUser;
lpbyData;
TCHAR szText[255];
_sntprintf_s(szText ,_countof(szText), _TRUNCATE, _T("**DMNotifyCallback**"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" NotifyClass = 0x
%08X"),dwNotifyClass);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" NotifyCode = 0x%08X"),
dwNotifyCode);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Items = %d"), dwItems);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("********************"));
ODKTrace(szText);
return(TRUE);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMDisconnect (Página 1656)
DMGetConnectionState (Página 1668)

3.2.11.2 Enum Data of Tags (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enum Data of Tags (MCP)}

//{{FUNCTION}DMEnumVarData4 (MCP)}
//{{FUNCTION}DM_ENUM_VARIABLE_PROC4 (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMEnumVarData4(void) ODK DM CS
// =====================================================================
// Desc. :
//--------------------------------------------------------------------------------
BOOL MyDMEnumVariable4Callback(LPDM_VARKEY lpdmVarKey, LPDM_VARIABLE_DATA4 lpdmVarData,
LPVOID lpvUser)
{
lpvUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumVariableCallback"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...szName=%s dwVarProperty=0x
%04X"),lpdmVarKey->szName, lpdmVarData->dwVarProperty);
ODKTrace(szText);
return TRUE;
}
void MyDMEnumVarData4()
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
DM_VARKEY dmVarKey[2];
TCHAR szText[255];
CMN_ERROR Error;
VOID* pUser = NULL;
memset(&Error,0,sizeof(CMN_ERROR));
memset(&dmVarKey, 0,2 * sizeof(DM_VARKEY));
dmVarKey[0].dwKeyType = DM_VARKEY_NAME;
_tcsncpy_s(dmVarKey[0].szName, _countof(dmVarKey[0].szName), _T("INT_TEST_VAR"),
_TRUNCATE);
dmVarKey[1].dwKeyType = DM_VARKEY_NAME;
_tcsncpy_s(dmVarKey[1].szName, _countof(dmVarKey[1].szName), _T("EXT_TEST_VAR"),
_TRUNCATE);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
ret = DMEnumVarData4 (/*PROJ_PATH*/g_szProjectFile,
&dmVarKey[0],
2,
MyDMEnumVariable4Callback,
pUser,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMEnumVarData4: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);

}
}
Consulte también

3.2.11.3 Enum open projects (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enum open projects (MCP)}

//{{FUNCTION}DMEnumOpenedProjects (MCP)}
//{{FUNCTION}DM_ENUM_OPENED_PROJECTS_PROC (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMEnumOpenedProjects(void) ODK DM CS
// =====================================================================
// Desc. : Inquire project informations
// =====================================================================
BOOL MyDMEnumOpenProjectsCallback( LPDM_PROJECT_INFO lpInfo, LPVOID lpvUser )
{
lpvUser;
// this callback is only called once by every call of DMEnumOpenedProjects
// because, there can only opened one project at the same time
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**DMEnumOpenProjects**"));
ODKTrace(szText);
// copy the project file name to g_szProjectFile for global use
// many API-functions need this name to select the project database
_tcsncpy_s(g_szProjectFile, _countof(g_szProjectFile), lpInfo->szProjectFile,
_TRUNCATE);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ProjectFile = %s"),lpInfo-
>szProjectFile);
ODKTrace(szText);
_tcsncpy_s(g_szDSNName, _countof(g_szDSNName), lpInfo->szDSNName, _TRUNCATE);

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DSNName = %s"),lpInfo-
>szDSNName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DataLocale = 0x%08X"),lpInfo-
>dwDataLocale);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**********************"));
ODKTrace(szText);
return( TRUE ); // only 1. element
}
BOOL MyDMEnumOpenedProjects(void)
{
CMN_ERROR Error;
BOOL ret= FALSE;
DWORD dwItems;
TCHAR szText[255];
ret = MyDMConnect();
if(TRUE == ret)
{
ret = DMEnumOpenedProjects(&dwItems, MyDMEnumOpenProjectsCallback, pvUser, &Error);
if(FALSE == ret)

{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMEnumOpenedProjects: E1= 0x%08lx ; E2= 0x%08lx ; %s"), %s",
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumOpenedProjects"));
}
ODKTrace(szText);
}
return(ret);
}
Consulte también

3.2.11.4 Enumerate all structured types (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enumerate all structured types (MCP)}

//{{FUNCTION}GAPIEnumTypes (MCP)}
//{{FUNCTION}DM_ENUM_TYPES_PROC (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyGAPIEnumTypes(void) ODK DM CS
// =====================================================================
// Desc. :
//--------------------------------------------------------------------------------
BOOL MyDMEnumTypeCallback(LPCSTR lpszTypeName,DWORD dwTypeID,
DWORD dwCreatorID, LPVOID lpvUser )
{
lpvUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**DMEnumTypeCallback**"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TypeName = %s TypeID = 0x%08x
CreatorID = %d"),
lpszTypeName,dwTypeID,dwCreatorID);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**********************"));
ODKTrace(szText);
return TRUE;
}
void MyGAPIEnumTypes()
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[255];
VOID* pvUser = NULL;
ret = FALSE;
ret = MyDMGetConnectionState(); //check the connection state to DM
if(FALSE != ret)
{
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
ret = GAPIEnumTypes(szProjectFile,
MyDMEnumTypeCallback,
pvUser,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMEnumTypes: E1=
0x%08lx ; E2= 0x%08lx ; %s"),


}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMEnumTypes"));
}
ODKTrace(szText);
}
}
Consulte también
GAPIEnumTypes (Página 1811)
DM_ENUM_TYPES_PROC (Página 1813)

3.2.11.5 Enumerate all connections (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enumerate all connections (MCP)}

//{{FUNCTION}DMEnumConnectionData (MCP)}
//{{FUNCTION}DM_ENUM_CONNECTION_PROC (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMEnumConnectionData(void) ODK DM CS
// =====================================================================
// Desc. :
//--------------------------------------------------------------------------------
BOOL MyDMEnumConnectionCallback(LPDM_CONNECTION_DATA lpdmConData, LPVOID lpvUser)
{
lpvUser;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumConnectionCallback"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Connection = %s"),lpdmConData-
>szConnection);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...UnitName = %s"),lpdmConData-
>szUnitName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Common=%s"),lpdmConData-
>szCommon);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Specific=%s"),lpdmConData-
>szSpecific);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...VarNum=%d"),lpdmConData-
>dwVarNum);
ODKTrace(szText);
return TRUE;
}
void MyDMEnumConnectionData()
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
DWORD dwItems = 0;
TCHAR szProjectFile[255];
DM_CONNKEY ConnKey;
memset(&ConnKey,0,sizeof(ConnKey));
memset(&Error,0,sizeof(Error));
ret = MyDMGetConnectionState();
if(FALSE != ret)
{
_TRUNCATE);
ret = DMEnumConnectionData(szProjectFile,

&ConnKey,
dwItems,
MyDMEnumConnectionCallback,
NULL,
&Error);
if(FALSE == ret)
{
DMEnumConnectionData: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumConnectionData"));
}
ODKTrace(szText);
}
}
Consulte también

3.2.11.6 Inquire project informations (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Inquire project informations (MCP)}

//{{FUNCTION}DMGetProjectInformation (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: DMGetProjectInformation(void) ODK DM CS
// =====================================================================
// Desc. : Inquire project informations
// =====================================================================
void MyDMGetProjectInformation(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[_MAX_PATH +1];
DM_PROJECT_INFO Info;
memset(&Info, 0, sizeof(DM_PROJECT_INFO));
ret = MyDMGetConnectionState(); //check the connection state
if(FALSE != ret)
{
_TRUNCATE);
ret = DMGetProjectInformation(szProjectFile, &Info, &Error);
if(FALSE == ret)
{
DMGetProjectInformation: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("**DMGetProjectInformation:
%d**"), ret);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ProjectFile=
%s"),Info.szProjectFile);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DSNName=
%s"),Info.szDSNName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" DataLocale=0x
%08X"),Info.dwDataLocale);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("******************************"), ret);
ODKTrace(szText);

}
}
}
Consulte también
3.2.11.7 OnTestDeactivateRuntimeProject (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestDeactivateRuntimeProject (MCP)}
//{{FUNCTION}DMDeactivateRTProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestDeactivateRuntimeProject()
{
CCmnError cmnError;
if(!::DMDeactivateRTProject(cmnError))
{
cmnError.Show(__T("DMDeactivateRTProject failed\n"));
}
}
3.2.11.8 OnTestEnumGroupsAll (RT Professional)
Ejemplo
//{{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"));
}
}

Consulte también
3.2.11.9 OnTestEnumVariables (RT Professional)
Ejemplo
//{{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"));
}
}
Consulte también

3.2.11.10 OnTestEnumConnectionDataAll (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestEnumConnectionDataAll (MCP)}
//{{FUNCTION}DMEnumConnectionData (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumConnectionDataAll()
{
CCmnError Error;
if( !::DMEnumConnectionData( m_strProject, NULL, 0, EnumConnectionDataProc, this,
&Error))
{
Error.Show(__T("DMEnumConnectionData failed\n"));
}
}
Consulte también

3.2.11.11 OnTestMachines (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestMachines (MCP)}
//{{FUNCTION}DMGetMachineTable (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestMachines()
{
CMN_ERROR Error;
DM_MACHINE_TABLE dmMachineTable;
memset(&dmMachineTable, 0, sizeof(dmMachineTable));
if(!DMGetMachineTable(m_strProject, &dmMachineTable, &Error))
{
// Error.Show(__TEXT("DMGetMachineTable failed\n"));
// AfxMessageBox( strError );
}
else
{
for( int i = 0; i < dmmachinetable.nNumMachines; i++ )
{
CString strData;
strData.Format( _T( "Rechner : %s, Typ : %s, Standort : %s" ),
dmMachineTable.tm[i].szMachineName,
dmMachineTable.tm[i].fServer ? _T( "Server" ) : _T( "Client oder ES" ),
dmMachineTable.tm[i].fLocal ? _T( "local" ) : _T( "remote" ));
PutStr( strData);
}
}
}
Consulte también

3.2.11.12 OnTestProjectInfo (RT Professional)
Ejemplo
//{{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);
}
}
Consulte también

3.2.11.13 OnTestProjectPaths (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestProjectPaths (MCP)}
//{{FUNCTION}DMGetProjectDirectory (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestProjectPaths()
{
DM_DIRECTORY_INFO dmDirInfo;
CCmnError Error;
memset(&dmDirInfo, 0, sizeof(DM_DIRECTORY_INFO));
if(!DMGetProjectDirectory(m_strAppName, m_strProject,
&dmDirInfo, &Error))
{
Error.Show(__TEXT("DMGetProjectDirectory failed\n"));
}
else
{
CString strData;
strData.Format(_T("szProjectDir = %s"), dmDirInfo.szProjectDir);
PutStr(strData);
strData.Format(_T("szProjectAppDir = %s"), dmDirInfo.szProjectAppDir);
PutStr(strData);
strData.Format(_T("szProjectGlobalLibDir = %s"), dmDirInfo.szGlobalLibDir);
PutStr(strData);
strData.Format(_T("szProjectLibDir = %s"), dmDirInfo.szProjectLibDir);
PutStr(strData);
strData.Format(_T("szLokalProjectAppDir = %s"), dmDirInfo.szLokalProjectAppDir);
PutStr(strData);
}
}
Consulte también
DMGetProjectDirectory (Página 1679)

3.2.11.14 OnTestOpenProject (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestOpenProject (MCP)}
//{{FUNCTION}DMOpenProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProject()
{
#define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
TCHAR szProject[_MAX_PATH + 1];
CCmnError Error;
CTestCliView* pView = GetFirstView();
memset(szProject,0, sizeof(szProject)); // Delete projectname to call dialog
// Or set fixed projectname
strcpy( szProject, _T(PROJ_PATH) );
if(!DMOpenProject(pView->GetSafeHwnd(),
szProject, NELEM(szProject), &Error))
{
Error.Show(__TEXT("DMOpenProject failed.\n"));
}
else
{
AfxMessageBox(szProject);
m_strProject = szProject;
}
}
Consulte también
DMOpenProjectPlus (Página 1684)

3.2.11.15 OnTestOpenProjects (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestOpenProjects (MCP)}
//{{FUNCTION}DMEnumOpenedProjects (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProjects()
{
CCmnError Error;
if(!DMEnumOpenedProjects(NULL, OpenProjectsProc, this, &Error))
{
Error.Show(__TEXT("DMEnumOpenedProjects failed\n"));
}
}
Consulte también
3.2.11.16 OnTestRuntimeProject (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestRuntimeProject (MCP)}
//{{FUNCTION}DMGetRuntimeProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestRuntimeProject()
{
CCmnError Error;
TCHAR szBuffer[_MAX_PATH + 1];
if(!DMGetRuntimeProject(szBuffer, NELEM(szBuffer), &Error))
{
Error.Show(__TEXT("DMGetRuntimeProject failed\n"));
}
else
{
PutStr(szBuffer);
}
}
Consulte también

3.2.11.17 OnTestSystemLocale (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestSystemLocale (MCP)}
//{{FUNCTION}DMGetSystemLocale (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestSystemLocale()
{
CCmnError Error;
DWORD dwLocaleID = 0;
if(!DMGetSystemLocale(&dwLocaleID, &Error))
{
Error.Show(__TEXT("DMGetSystemLocale failed\n"));
}
else
{
CString strData;
strData.Format(_T("Systemlocale : %08X"), dwLocaleID);
PutStr(strData);
}
}
Consulte también
DMGetSystemLocale (Página 1821)
3.2.11.18 OnTestUpdateCycles (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestUpdateCycles (MCP)}
//{{FUNCTION}DMEnumUpdateCycles (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestUpdateCycles()
{
DWORD dwNumCalls = 0;
CCmnError Error;
if( !DMEnumUpdateCycles(m_strProject, &dwNumCalls,
EnumCyclesProc, this, &Error))
{
Error.Show(__TEXT("DMEnumUpdateCycles failed\n"));
}
}

Consulte también
DMEnumUpdateCycles (Página 1660)
3.2.11.19 OnTestVariablenBeginstartvarupdate (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenBeginstartvarupdate (MCP)}
//{{FUNCTION}DMBeginStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenBeginstartvarupdate()
{
CCmnError Error;
if(!DMBeginStartVarUpdate(&m_dwTAID, &Error))
{
Error.Show(_T("DMBeginStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMBeginStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
Consulte también

3.2.11.20 OnTestVariablenEndstartvarupdate (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenEndstartvarupdate (MCP)}
//{{FUNCTION}DMEndStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenEndstartvarupdate()
{
CCmnError Error;
if( !DMEndStartVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMEndStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMEndStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
Consulte también

3.2.11.21 OnTestVariablenGetvalue (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenGetvalue (MCP)}
//{{FUNCTION}DMGetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvalue()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
LPDM_VAR_UPDATE_STRUCT lpdmvus = new DM_VAR_UPDATE_STRUCT[nNum];

memset(lpdmvus, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
// the included VARIANT's in the DM_VAR_UPDATE_STRUCT's then initialized to VT_EMPTY
with the memset,
// don't do this later again, because VT_BSTR's can be present after DMGetValue(...)!
CCmnError Error;
memset(&Error, 0, sizeof(CCmnError));
if( !DMGetValue(lpdmVarKey, nNum, lpdmvus, &Error))

{
Error.Show(_T("DMGetValue failed\n"));
}
else
{
CString strData;
for( int i=0; i < nmum; i++)
{
LPDM_VAR_UPDATE_STRUCT lpdmvus2 = &lpdmvus[i];
switch( lpdmvus2->dmTypeRef.dwType )
{
case DM_VARTYPE_BIT:
if (lpdmvus2->dmValue.boolVal)
{
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = TRUE"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID);
}
else
{
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = FALSE"),
lpdmvus2->dmVarKey.dwID);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %u"),
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_SBYTE:

strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %d"),

lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_WORD:
lpdmvus2->dmValue.iVal);
break;
case DM_VARTYPE_SWORD:
lpdmvus2->dmValue.iVal);
break;
case DM_VARTYPE_DWORD:
lpdmvus2->dmValue.lVal);
break;
case DM_VARTYPE_SDWORD:
lpdmvus2->dmValue.lVal);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %f"),
lpdmvus2->dmValue.fltVal);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %f"),
lpdmvus2->dmValue.dblVal);
break;
case DM_VARTYPE_TEXT_8:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %s"),
lpdmvus2->dmValue.bstrVal);
break;
/*
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tWert = %s"),
lpdmvus2->dmValue.bstrVal);
break;
*/
default:

strData.Format(_T("Unbekannter Variablentyp !"));

}
PutStr(strData);
// clear the given VARIANT's in every array element, because a VT_BSTR's can be
present
// do not only delete the array later without clearing the Variants here because
of memory leak's
VariantClear(&(lpdmvus2->dmValue));
}
}
delete []lpdmVarKey;
delete []lpdmvus;
}
Consulte también

3.2.11.22 OnTestVariablenGetvaluewait (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenGetvaluewait (MCP)}
//{{FUNCTION}DMGetValueWait (MCP)}
//{{FUNCTION}(END)}
//-----< Notification-Callback für GetValueWait >-----------------------------
BOOL GetValueWaitNotify(DWORD dwTAID,
DWORD dwItems,
LPVOID lpvUser)
{
dwTAID;
CTestCliDoc* pDoc = (CTestCliDoc*)lpvUser;
for(DWORD i=0; i <dwitems; i++)
{
LPDM_VAR_UPDATE_STRUCT lpdmvus2 = &lpdmvus[i];
CString strData;
switch(lpdmvus2->dmTypeRef.dwType)
{
case DM_VARTYPE_BIT:
if (lpdmvus2->dmValue.boolVal)
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = TRUE,
Status=%04x"),
lpdmvus2->dwState);
}
else
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = FALSE,
Status=%04x"),
lpdmvus2->dwState);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %u, Status=
%04x"),
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SBYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %d, Status=
%04x"),
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);

break;
case DM_VARTYPE_WORD:
%04x"),
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SWORD:
%04x"),
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DWORD:
%04x"),
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SDWORD:
%04x"),
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %f, Status=
%04x"),
lpdmvus2->dmValue.fltVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %f, Status=
%04x"),
lpdmvus2->dmValue.dblVal,
lpdmvus2->dwState);
break;
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tWert = %s, Status=
%04x"),
lpdmvus2->dmValue.bstrVal,
lpdmvus2->dwState);

break;
case DM_VARTYPE_RAW:
{
LPBYTE pArray;
HRESULT hr;
hr = SafeArrayAccessData(lpdmvus2->dmValue.parray, (VOID **) &pArray);
if (! FAILED(hr))
{
strData.Format(_T("Var:%s: Type:Rohdatum\nValues:%02x %02x %02x %02x\n"),
pArray[0],
pArray[1],
pArray[2],
pArray[3]);
SafeArrayUnaccessData(lpdmvus2->dmValue.parray);
}
else
{
strData.Format(_T("SafeArrayAccessData fehlgeschlagen\n"));
}
break;
}
default:
strData.Format(_T("GetValueWait: Unbekannter Variablentyp !"));
}
pDoc->PutStr(strData);
}
return(TRUE);
}
//-----< OnTestVariablenGetvaluewait >------------------------------------------

void CTestCliDoc::OnTestVariablenGetvaluewait()
{
DWORD dwTAID = 5;
DWORD dwTimeOut = 5000;
CCmnError Error;
if(!DMGetValueWait(&dwTAID,
lpdmVarKey,
nNum,
FALSE,
dwTimeOut,
GetValueWaitNotify,
this,
&Error))
{
Error.Show(_T("DMGetValueWait (FALSE) failed\n"));
}
delete []lpdmvus;
}

//-----< OnTestVariablenGetvaluewait >------------------------------------------

void CTestCliDoc::OnTestVariablenGetvaluewaitTrue()
{
DWORD dwTAID = 5;
DWORD dwTimeOut = 5000;
CCmnError Error;
if( !DMGetValueWait(&dwTAID,
lpdmVarKey,
nNum,
TRUE,
dwTimeOut,
GetValueWaitNotify,
this,
&Error))
{
Error.Show(_T("DMGetValueWait (TRUE) failed\n"));
}
delete []lpdmvus;
}
Consulte también

3.2.11.23 OnTestVariablenGetVarInfo (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenGetVarInfo (MCP)}
//{{FUNCTION}DMGetVarInfo (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetVarInfo()
{
CCmnError Error;
if(!::DMGetVarInfo(m_strProject, lpdmVarKey, nNum, &Error))
{
Error.Show(_T("DMGetVarInfo failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarInfo: Variablenname: %s, VarID:%lu."),
lpdmVarKey[i].szName,
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
}
Consulte también
DMGetVarInfo (Página 1732)

3.2.11.24 OnTestVariablenGetvarlimits (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenGetvarlimits (MCP)}
//{{FUNCTION}DMGetVarLimits (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvarlimits()
{
LPDM_VARLIMIT lpdmVarLimit = new DM_VARLIMIT[nNum];
memset(lpdmVarLimit, 0, sizeof(DM_VARLIMIT) * nNum);
CCmnError Error;
if(!::DMGetVarLimits(m_strProject, lpdmVarKey, nNum,
lpdmVarLimit, &Error))
{
Error.Show(__T("DMGetVarLimits failed\n"));
}
else
{
CString strData;
{
strData.Format(_T("DMGetVarLimits: Var:%s, MaxRange:%lf, MinRange:%lf, MinLimit:
%lf, MaxLimit:%lf."),
lpdmVarLimit[i].dmMaxRange.dblVal,
lpdmVarLimit[i].dmMinRange.dblVal,
lpdmVarLimit[i].dmMaxLimit.dblVal,
lpdmVarLimit[i].dmMinLimit.dblVal);
PutStr(strData);
}
}
delete []lpdmVarLimit;
}
Consulte también

3.2.11.25 OnTestVariablenGetvartype (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenGetvartype (MCP)}
//{{FUNCTION}DMGetVarType (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvartype()
{
LPDM_TYPEREF lpdmTypeRef = new DM_TYPEREF[nNum];
memset(lpdmTypeRef, 0, sizeof(DM_TYPEREF) * nNum);
CCmnError Error;
if(!::DMGetVarType(m_strProject, lpdmVarKey, nNum,
lpdmTypeRef, &Error))
{
Error.Show(_T("DMGetVarType failed\n"));
}
else
{
CString strData;
{
strData.Format(_T("DMGetVarType: Var:%s, Size:%lu, Name:%s."),
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
}
Consulte también

3.2.11.26 OnTestVariablenResumevarupdate (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenResumevarupdate (MCP)}
//{{FUNCTION}DMResumeVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenResumevarupdate()
{
CCmnError Error;
if(!DMResumeVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMResumeVarUpdate failed.\n"));
}
else
{
CString strData;
strData.Format(_T("DMResumeVarUpdate ok."));
}
}
Consulte también

3.2.11.27 OnTestVariablenSetvalue (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenSetvalue (MCP)}
//{{FUNCTION}DMSetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvalue()
{
LPDWORD lpdmVarState = new DWORD[nNum];
INT i;
CString strData;
CCmnError cmnError;
for (i = 0; i < 1; i++)</p>
{
DWORD dwStart = GetTickCount();
DWORD dwEnd;
if (! DMSetValue(lpdmVarKey, nNum, m_varValues, lpdmVarState, cmnError))
{
break;
}
dwEnd = GetTickCount();
strData.Format("DMSetValue OK, Dauer %d ms", dwEnd - dwStart);
PutStr(strData);
}
delete []lpdmVarState;
}
Consulte también

3.2.11.28 OnTestVariablenSetvaluewait (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenSetvaluewait (MCP)}
//{{FUNCTION}DMSetValueWait (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvaluewait()
{
LPDWORD lpdmVarState = new DWORD[nNum];
DWORD dwTimeOut = 1000L;
CCmnError cmnError;
if(!::DMSetValueWait(&m_dwTAID, lpdmVarKey,nNum, m_varValues,dwTimeOut,
CompletionProc, this, cmnError))
{
cmnError.Show(_T("DMSetValueWait failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSetValueWait ok."));
}
delete []lpdmVarState;
}
Consulte también

3.2.11.29 OnTestVariablenStopallupdates (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenStopallupdates (MCP)}
//{{FUNCTION}DMStopAllUpdates (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopallupdates()
{
CCmnError Error;
if(!DMStopAllUpdates(&Error))
{
Error.Show(_T("DMStopAllUpdates failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopAllUpdates ok."));
}
}
Consulte también
DMStopAllUpdates (Página 1845)
3.2.11.30 OnTestVariablenStopvarupdate (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenStopvarupdate (MCP)}
//{{FUNCTION}DMStopVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopvarupdate()
{
CCmnError Error;
if( !DMStopVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMStopVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopVarUpdate: TAID:%lu."), m_dwTAID);
}
}

Consulte también
DMStopVarUpdate (Página 1846)
3.2.11.31 OnTestVariablenSuspendvarupdate (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenSuspendvarupdate (MCP)}
//{{FUNCTION}DMSuspendVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSuspendvarupdate()
{
CCmnError Error;
if(!DMSuspendVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMSuspendVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSuspendVarUpdate ok."));
}
}
Consulte también
3.2.11.32 OnTestWinCCShutdown (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestWinCCShutdown (MCP)}
//{{FUNCTION}DMExitWinCC (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestWinCCShutdown()
{
DMExitWinCC();
}
Consulte también
DMExitWinCC (Página 1663)

3.2.11.33 Open project by means of dialog (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Open projectby means of dialog (MCP)}

//{{FUNCTION}DMOpenProject (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMOpenProject(void) ODK DM CS
// =====================================================================
// Desc. : open project, give name through WinCC-Dialog-Box
// =====================================================================
void MyDMOpenProject(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwSize = 255;
HWND handle = NULL;
TCHAR szProjFile[255];
TCHAR szText[255];
_tcsncpy_s(szProjFile, _countof(szProjFile), _T("C:\\Siemens\\ODK\\Samples\\Projects\
\Demo\\odk.mcp"), _TRUNCATE);
memset(&Error, 0,sizeof( CMN_ERROR ));
ret = MyDMConnect(); // check connection to DataManager
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in MyDMConnect"));
ODKTrace(szText);
}
else
{
memset(&Error, 0,sizeof( CMN_ERROR ));
ret = DMOpenProject(handle, szProjFile, dwSize, &Error);
if(ret == FALSE)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMOpenProject (%s)"),
szProjFile);
}
ODKTrace(szText);
}
}
Consulte también
DMOpenProjectPlus (Página 1684)

3.2.11.34 Read tag (RT Professional)
Ejemplo
// =====================================================================
// =====================================================================
// short : Modul with examples to DataManager-API
// RUNTIME
// SC: PO = Projekt opened PG= Projekt closed
// *********************************************************************
//#include "odkapi.h" // if console application
#include <time.h>
#include "dm02.h"
// =====================================================================
// 2.1 Interface IMPORT
// =====================================================================
//extern void ODKTrace(LPCTSTR);
extern BOOL MyDMConnect (void); // Connect
extern BOOL MyDMGetConnectionState(void);
// =====================================================================
// 2.2 Interface EXPORT
// =====================================================================
// =====================================================================
// 2.3 Interface LOCAL
// =====================================================================
// =====================================================================
// 3. Definitions
// =====================================================================
//{{ODK_EXAMPLE}Read tag (MCP)}

//{{FUNCTION}DMGetValue (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMGetValue(void) ODK DM CS
// =====================================================================
// short : Read tag
// =====================================================================
void MyDMGetValue(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwSize = _MAX_PATH;
TCHAR szText[255];
TCHAR szProjFile[_MAX_PATH +1];
TCHAR BstrValue[255]; //
const short int nNum = 11; // tagcount
const short int nTextMax = 20; // textlenght
TCHAR TagNames[nNum][nTextMax]=
{
"VAR_1_BOOL", // boolVal; // VT_BOOL.

"VAR_2_BYTE", // bVal; // VT_UI1

"VAR_3_SBYTE", // iVal; // VT_I2
"VAR_4_WORD", // lVal // VT_I4
"VAR_5_SWORD", // iVal // VT_I2
"VAR_6_DWORD", // dblVal // VT_R8
"VAR_7_SDWORD", // lVal // VT_I4
"VAR_8_FLOAT", // fltVal // VT_R4
"VAR_9_DOUBLE", // dblVal // VT_R8
"VAR_A_TEXT8", // bstrVal // VT_BSTR
"VAR_B_TEXT16" // bstrVal // VT_BSTR
};
DM_VARKEY VarKey[nNum];
DM_VAR_UPDATE_STRUCT VarUp[nNum];
memset(&VarUp, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
// the included VARIANT's in the DM_VAR_UPDATE_STRUCT's then initialized to VT_EMPTY
with the memset,
// don't do this later again, because VT_BSTR's can be present after DMGetValue(...)!
memset(&VarKey,0, sizeof(DM_VARKEY) * nNum);

if(FALSE != ret)
{
// RunTime project
ret = DMGetRuntimeProject(szProjFile, dwSize, &Error);
if(FALSE != ret)
{
// fill out DM_VARKEY
for(int iRead = 0; iRead <nNum; iRead++)
{
VarKey[iRead].dwKeyType = DM_VARKEY_NAME;
VarKey[iRead].dwID = 0;
strcpy( VarKey[iRead].szName, &TagNames[iRead][0]);
VarKey[iRead].lpvUserData = (VOID *) iRead;
}
ret = DMGetValue(VarKey, nNum, VarUp, &Error);
if(FALSE != ret)
{
for(int iOut=0; iOut <nNum; iOut++)
{
switch(VarUp[iOut].dmTypeRef.dwType)
{
case DM_VARTYPE_BIT: //vt = 3 VT_I4 = 3
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.boolVal);
break;
}
case DM_VARTYPE_BYTE: //vt = 17 VT_UI1 = 17
{

VarUp[iOut].dmValue.bVal);
break;
}
case DM_VARTYPE_SBYTE: //vt = 2 VT_I2 = 2
{
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_WORD: //vt = 3 VT_I4 = 3
{
VarUp[iOut].dmValue.lVal);
break;
}
case DM_VARTYPE_SWORD: //vt = 2 VT_I2 = 2
{
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_DWORD: //vt = 5 VT_R8 = 5
{
VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_SDWORD: //vt = 3 VT_I4 = 3
{
VarUp[iOut].dmValue.lVal);
break;
}
case DM_VARTYPE_FLOAT: //vt = 4 VT_R4 = 4
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",
VarUp[iOut].dmValue.fltVal);
break;
}
case DM_VARTYPE_DOUBLE: //vt = 5 VT_R8 = 5
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",

VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_TEXT_8: //vt = 8 VT_BSTR = 8
{
ret = WideCharToMultiByte( CP_ACP,
(DWORD)0,VarUp[iOut].dmValue.bstrVal,
-1,(LPSTR)&BstrValue[0],128,NULL,NULL);
sprintf(szText, "Index=%d Name=%s ID=%d StrValue=%s",
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
case DM_VARTYPE_TEXT_16: // vt = 8 VT_BSTR = 8
{
ret = WideCharToMultiByte( CP_ACP,
(DWORD)0,VarUp[iOut].dmValue.bstrVal,
-1,(LPSTR)&BstrValue[0],128,NULL,NULL);
sprintf(szText, "Index=%d Name=%s ID=%d StrValue=%s",
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
default:
break;
}// end switch case
ODKTrace(szText);
VariantClear( &VarUp[iOut].dmValue );
}//end for
}
else
{
sprintf(szText, "Error in DMGetValue: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
}
else
{
sprintf(szText, "Error in DMGetRuntimeProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
}
else
{
sprintf(szText, "Error in MyDMGetConnectionState: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);

}
}
Consulte también

3.2.11.35 Write tag (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Write tag (MCP)}

//{{FUNCTION}DMSetValue (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMSetValue(void) ODK DM CS
// =====================================================================
// short : Write tag
// =====================================================================
void MyDMSetValue(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwSize = _MAX_PATH;
TCHAR szText[255];
TCHAR szProjFile[_MAX_PATH +1];
TCHAR szTextValue[255]; // for TEXT8 Values
const short int nNum = 11; // tagcount
const short int nTextMax = 20; // textlenght
TCHAR TagNames[nNum][nTextMax]=
{
"VAR_1_BOOL", // boolVal; // VT_BOOL.
"VAR_2_BYTE", // bVal; // VT_UI1
"VAR_3_SBYTE", // iVal; // VT_I2
"VAR_4_WORD", // lVal // VT_I4
"VAR_5_SWORD", // iVal // VT_I2
"VAR_6_DWORD", // dblVal // VT_R8
"VAR_7_SDWORD", // lVal // VT_I4
"VAR_8_FLOAT", // fltVal // VT_R4
"VAR_9_DOUBLE", // dblVal // VT_R8
"VAR_A_TEXT8", // bstrVal // VT_BSTR
"VAR_B_TEXT16" // bstrVal // VT_BSTR
};
DM_VARKEY VarKey[nNum];
DM_VAR_UPDATE_STRUCT VarUp[nNum];
VARIANT VarVal[nNum];
DWORD VarSta[nNum];
static short int Tmp[20];
BSTR bstrText1, bstrText2;
memset(&VarUp, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
memset(&VarKey,0, sizeof(DM_VARKEY) * nNum);
if(FALSE != ret)
{
// RunTime project
ret = DMGetRuntimeProject(szProjFile, dwSize, &Error);
if(FALSE != ret)
{
// read tag

for(int i = 0; i < nNum; i++)

{
VarKey[i].dwKeyType = DM_VARKEY_NAME;
VarKey[i].dwID = 0;
_tcsncpy_s(VarKey[i].szName, _countof(VarKey[i].szName), &TagNames[i][0],
_TRUNCATE);
VarKey[i].lpvUserData = (VOID *) i;
}
// init tag
//"VAR_1_BOOL",
VarVal[0].vt = VT_BOOL;
VarVal[0].boolVal = TRUE;
//"VAR_2_BYTE"
VarVal[1].vt = VT_UI1;
VarVal[1].bVal = 23;
//"VAR_3_SBYTE",
VarVal[2].vt = VT_I2;
VarVal[2].iVal = -23;
//"VAR_4_WORD",
VarVal[3].lVal = 89;
//"VAR_5_SWORD",
VarVal[4].iVal = -89;
//"VAR_6_DWORD",
VarVal[5].vt = VT_R8;
VarVal[5].dblVal = 1200;
//"VAR_7_SDWORD",
VarVal[6].lVal = -1200;
//"VAR_8_FLOAT",
VarVal[7].fltVal = (float)3.789;
//"VAR_9_DOUBLE",
VarVal[8].dblVal = (double)34.789;
//"VAR_A_TEXT8",
_tcsncpy_s(szTextValue, _countof(szTextValue), _T("VAR_A_TEXT8 Value"),
_TRUNCATE);
ret = MultiByteToWideChar(CP_ACP,(DWORD)0, (LPCSTR) &szTextValue,-1,
(LPWSTR)&Tmp[0],30);
// SysFreeString(pBSTR);
bstrText1 = SysAllocString((OLECHAR FAR*)&Tmp[0]);
VarVal[9].vt = VT_BSTR;
VarVal[9].bstrVal = bstrText1;
//"VAR_B_TEXT16"
_tcsncpy_s(szTextValue, _countof(szTextValue), _T("VAR_B_TEXT16 Value"),
_TRUNCATE);
ret = MultiByteToWideChar(CP_ACP,(DWORD)0, (LPCSTR)&szTextValue,-1,
(LPWSTR)&Tmp[0],30);
// SysFreeString(pB2);
bstrText2 = SysAllocString((OLECHAR FAR*)&Tmp[0]);
VarVal[10].vt = VT_BSTR;
VarVal[10].bstrVal = bstrText2;
// set tag

3.3 Funciones del sistema gráfico (RT Professional)
ret = DMSetValue(&VarKey[0], nNum, &VarVal[0], &VarSta[0], &Error);

if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMSetValue:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("write Value to WinCC"));
ODKTrace(szText);
}
SysFreeString(bstrText1);
SysFreeString(bstrText2);
}
}
}
Consulte también
Sinopsis
PDLRTShowApp (Página 1944) Mostrar sistema gráfico

PDLRT_CALLBACK (Pági‐ Función Callback de las funciones de runtime
na 1945)
PDLRTClosePicture (Pági‐ Cerrar imagen
na 1932)
PDLRTDisableClosePicture (Pá‐ Impedir cerrar imagen
gina 1934)
PDLRTEnableClosePicture (Pá‐ Habilitar imagen para cierre
gina 1936)
PDLRTGetCursorKeys (Pági‐ Consultar teclas de control del cursor
na 1947)

PDLRTGetDefPropEx (Pági‐ Consultar valores predeterminados de las propiedades del objeto

na 1956)
PDLRTGetPropEx (Pági‐ Consultar valores predeterminados de las propiedades del objeto
na 1958)
PDLRTGetFocus (Página 1949) Consultar foco de entrada
PDLRTGetLink (Página 1966) Consultar enlace entre propiedad de objeto y variable
PDLRTGotoPicture (Pági‐ Consultar memoria de imágenes
na 1937)
PDLRTInquireFreeArea (Pági‐ Determinar área libre de una ventana
na 1939)
PDLRTOpenPicture (Pági‐ Cambio de imagen raíz en runtime
na 1940)
PDLRTPictureNavigation (Pági‐ Activar y desactivar navegación por imágenes
na 1943)
PDLRTSetCursorKeys (Pági‐ Definir teclas de control del cursor
na 1951)
PDLRTSetFocus (Página 1953) Definir foco de entrada
PDLRTSetLink (Página 1968) Definir enlace entre propiedad de objeto y variable
PDLRTSetMultiLink (Pági‐ Definir enlace entre propiedad de objeto y variable (varias variables)
na 1970)
PDLRTSetPropEx (Pági‐ Definir propiedad del objeto
na 1961)
Sinopsis
FOCUSINFO (Pági‐ Datos de foco de entrada

na 1932)
LINKINFO (Página 1928) Enlaces de propiedades de objetos y variables
MULTILINK (Página 1930) Enlaces de propiedades de objetos y variables
MULTILINKINFO (Pági‐ Enlaces de propiedades de objetos y variables
na 1931)
Sinopsis
Las funciones API pueden devolver los siguientes avisos de error en la estructura de error
CMN_ERROR:
Configuración
PDLCS_ELIASES_NO_ERROR 0 No ha ocurrido ningún error

PDLCS_ERROR_NO_DISPATCH 5 La ejecución Ole-Automation No es posible

PDLCS_ERROR_NO_PROJECT 10 El proyecto No existe

PDLCS_ERROR_NO_PICTURE 15 La imagen No existe
PDLCS_ERROR_NO_OBJECT 20 El objeto No existe
PDLCS_ERROR_NO_PROPERTY 25 La propiedad No existe
PDLCS_ERROR_NO_OBJTYPE 30 El tipo de objeto No existe.
PDLCS_ERROR_NO_DYNAMIC 32 No hay ninguna dinámica
PDLCS_ERROR_ALREADY_OPEN 35 La imagen indicada ya está abierta
PDLCS_ERROR_WRITE_PROTECTED 40 La imagen indicada está protegida contra es‐
critura
PDLCS_ERROR_PICTURE_SAVE 45 La imagen indicada No se ha podido guardar
PDLCS_ERROR_PICTURE_SAVE_AS 50 La imagen indicada No se ha podido guardar
PDLCS_ERROR_PICTURE_CLOSE 55 La imagen indicada No se ha podido cerrar
PDLCS_ERROR_PICTURE_CLOSE_ALL 60 Las imágenes No se han podido cerrar
PDLCS_ERROR_PICTURE_IMPORT 65 Las imágenes No se han podido importar
PDLCS_ERROR_PICTURE_CREATE 70 Error general al generar la imagen.
PDLCS_ERROR_PICTURE_EXISTS 75 La imagen ya existe
PDLCS_ERROR_NEW_OBJECT_NAME 80 El nombre de objeto ya existe
PDLCS_ERROR_NEW_OBJECT 85 No se ha podido crear el objeto
PDLCS_ERROR_DELETE_OBJECT 90 No se ha podido borrar el objeto
PDLCS_ERROR_SET_PROPERTY 95 No se ha podido activar la propiedad
PDLCS_ERROR_GET_PROPERTY 96 No se ha podido leer la propiedad
PDLCS_ERROR_ENUM_OBJECTTYPE 100 Error en la enumeración de los tipos de objeto.
PDLCS_ERROR_ENUM_PROPERTY 105 Error en la enumeración de las propiedades
de objeto.
PDLCS_ERROR_CREATE_PROPERTY 110 No se ha podido definir la propiedad
PDLCS_ERROR_SET_LINK 115 No se ha podido establecer la conexión.
PDLCS_ERROR_REMOVE_LINK 120 No se ha podido borrar la conexión.
PDLCS_ERROR_SET_ACTION 125 No se ha podido guardar la acción.
PDLCS_ERROR_GET_ACTION 126 No se ha podido recoger la acción.
PDLCS_ERROR_ENUM_DYNAMICS 127 No se han podido enumerar dinámicas.
PDLCS_ERROR_SET_DIRECTCONNECT 128 No se ha podido guardar la conexión directa.
PDLCS_ERROR_AUTOMATION 130 Error en la transferencia
PDLCS_ERROR_MEMORY 200 No hay memoria
Runtime
PDLRT_OK 0 No ha ocurrido ningún error

PDLRT_APP_NOT_RUNNING 1 Aplicación PDL No iniciada
PDLRT_NO_TRANSFER 2 Aplicación PDL No accesible
PDLRT_NO_PIC 3 Imagen No seleccionada
PDLRT_NO_OBJ 4 Objeto No encontrado
PDLRT_NO_PROP 5 Propiedad No encontrada
PDLRT_NO_MET 6 Método No encontrado en el objeto
PDLRT_LINK_NOT_SET 7 La propiedad No pudo conectarse

PDLRT_WNAME_NOT_UNIQUE 8 El nombre de instancia de la nueva ventana No es

unívoco
PDLRT_WCREATION_FAILED 9 No se ha podido crear la ventana
PDLRT_PICTURE_NOT_LOADED 10 No se ha podido cargar el archivo de imagen
PDLRT_ILLEGAL_USERLEVEL 11 Nivel de autorización de operación insuficiente
PDLRT_NO_POSITION 12 El rectángulo No puede posicionarse.
PDLRT_POSITION_WITH_MODY 13 El rectángulo ha sido modificado
PDLRT_E_ALREADY_CONNECTED 14 Ya existe otra conexión con PDLRT
PDLRT_PICTURE_ALREADY_OPEN 15 La imagen ya está abierta
PDLRT_BAD_OLE_CONVERSION 16 Error al convertir con OLE Automation
PDLRT_NO_LINK 17 La propiedad No tiene dinámicas
PDLRT_IND_LINK_READ_ERR 18 Error al leer la variable indirecta
PDLRT_NO_IND_LINK 19 La propiedad No tiene dinámica indirecta
PDLRT_FAILURE_PARAM 20 Parámetro erróneo
3.3.1.4 constantes (RT Professional)
Modo de direccionamiento
PDLRT_AM_DEFAULT 0 El direccionamiento de la imagen y el objeto es relativo

PDLRT_AM_PICTABS 1 El direccionamiento de la imagen es absoluto
PDLRT_AM_OBJABS 2 El direccionamiento del objeto es absoluto
Los valores PDLRT_AM_PICTABS y PDLRT_AM_OBJABS se pueden combinar lógicamente

con O.
PDLRTInquireFreeArea
PDLRT_IQ_ONLY 0x01 Solo consulta con el resultado: ''corres‐

ponde/no corresponde''
PDLRT_IQ_MODY_POSX 0x02 La posición x del rectángulo puede modi‐
ficarse de tal forma que pueda posicio‐
narse.
PDLRT_IQ_MODY_POSY 0x04 La posición y del rectángulo puede modi‐
ficarse de tal forma que pueda posicio‐
narse.
PDLRT_IQ_MODY_HEIGHT 0x08 La altura del rectángulo puede modificar‐
se de tal forma que pueda posicionarse.
PDLRT_IQ_MODY_WIDTH 0x10 La anchura del rectángulo puede modifi‐
carse de tal forma que pueda posicionar‐
se.
PDLRTOpenPicture
PDLRT_WS_STYLE_FROM_PIC 0 Se aplican los atributos de visualización
de los datos de imagen
PDLRT_WS_BORDER WS_BORDER Ventana con borde
PDLRT_WS_CAPTION WS_CAPTION Ventana con título y borde

PDLRT_WS_THICKFRAME WS_THICKFRAME Ventana con borde grueso. Puede modi‐

ficarse su tamaño con el ratón.
PDLRT_WS_HSCROLL WS_HSCROLL Ventana con deslizador horizontal
PDLRT_WS_VSCROLL WS_VSCROLL Ventana con deslizador vertical
Ciclos de actualización
Nombre Índice
"Al cambiar" 0
"250 ms" 1
"500 ms" 2
"1 s" 3
"2 s" 4
"5 s" 5
"10 s" 6
"1 min" 7
"5 min" 8
"10 min" 9
"1 h" 10
"Ciclo de usuario 1" 11
"Ciclo de ventana" 235
"Ciclo de imagen" 255
3.3.1.5 Lista de las propiedades de objeto (A-K) (Graphics Designer) (RT Professional)
Resumen
Nota
En muchas funciones API del Graphics Designer es necesario asignar el parámetro
lpszPropName. En ese caso, hay que indicar el nombre inglés de una propiedad de objeto.
Las propiedades del tipo VT_USERDEFINED no pueden editarse con las funciones Get/Set-
Property.
No debe utilizarse VT_DISPATCH ni otras referencias, solo los tipos normales y como máximo
un VT_VARIANT para una propiedad de matriz de tipos simples.

Nombre OLE-Auto‐ Tipo de Nombre de Nombre de atri‐ Pertenencia a objeto

mation datos propiedad buto
"ActualPointLeft" VT_I4 Current Value Valor actual X Polígono
X
"ActualPointTop" VT_I4 Current Value Valor actual Y Polígono
Y
"AdaptBorder" VT_BOO Adapt Border Adaptación de Botón, texto estático,
L borde campo E/S, lista de tex‐
tos, casilla de verifica‐
ción, botón de opción,
"AdaptPicture" VT_BOO Adapt Picture Ajustar imagen Ventana de imagen,
L
"AdaptSize" VT_BOO Adapt Size Ajustar ventana Ventana de imagen,
L
"AdaptWidth"
"AlarmHigh" VT_R8 Limit AH Límite superior Barra,
AH
"AlarmLow" VT_R8 Limit AL Límite inferior AL Barra,
"Alignment" VT_BOO Alignment Alineación Barra,
L
"AlignmentLeft" VT_I4 X Alignment Alineación X Botón, texto estático,
campo E/S, indicador
de grupo, lista de tex‐
"AlignmentTop" VT_I4 Y Alignment Alineación Y Botón, texto estático,
"Analog" VT_BOO OCX Analog Analog DAClockCtrl,
L
"AngleAlpha" VT_I4 BPC Alpha Alpha Barra 3D,
"AngleBeta" VT_I4 BPC Beta Beta Barra 3D,
"AngleMax" VT_R8 OCX AngleMax AngleMax XGaugeCtrl,
"AngleMin" VT_R8 OCX AngleMin AngleMin XGaugeCtrl,
"Application" VT_BST WindowCon‐ Contenido de la Trabajo de impresión/
R tens ventana diagnóstico de script,
"ApplicationData‐
Path"
"Assignements" VT_BST Assignments Asignaciones Lista de textos,
R
"AssumeOnExit" VT_BOO Apply on Exit Aplicar al salir Campo E/S, lista de
L textos,
"AssumeOnFull" VT_BOO Apply on Full Aplicar con entra‐ Campo E/S,
L da completa
"AutoScroll" VT_BOO OCX AutoScroll AutoScroll CCAlgWinCtrl,
L
"AutoSize" VT_I4 OCX AutoSize AutoSize PButtonCtrl,

"Average" VT_BOO Average Value Valor medio Barra,

L
"Axe" VT_I4
"AxisSection" VT_R8 Axis Section Sección de eje Barra,
"BackBorderWidth" VT_I4 3D Border Ancho de borde Botón, indicador de
Weight 3D grupo, botón redondo,
objeto deslizante,
"BackColor" VT_I4 Background Color de fondo Botón, elipse, segmen‐
Color to de elipse, círculo,
segmento circular, po‐
lígono, rectángulo, rec‐
tángulo redondeado,
texto estático, barra
3D, campo E/S, barra,
objeto gráfico, indica‐
dor de grupo, lista de
textos, casilla de verifi‐
cación, botón de op‐
ción, botón redondo,
objeto deslizante,
"BackColor" VT_UI4 BackColor BackColor DAClockCtrl, XGau‐
geCtrl, PButtonCtrl, Sli‐
derCtrl,
"BackColor2" VT_I4 Bar Color Color de barra Barra,
"BackColor3" VT_I4 Bar Back‐ Color de fondo Barra,
ground Color de barra
"BackColorBottom" VT_I4 Low Limit Color de fondo in‐ Objeto deslizante,
Background ferior
Color
"BackColorTop" VT_I4 High Limit Color de fondo Objeto deslizante,
Background superior
Color
"BackFlashColorOff" VT_I4 Flashing Back‐ Color de fondo Botón, elipse, segmen‐
ground Color desactivado to de elipse, círculo,
Off segmento circular, po‐
texto estático, campo
E/S, barra, objeto grá‐
fico, lista de textos, ca‐
silla de verificación, bo‐
tón de opción, botón
redondo, objeto desli‐
zante,

"BackFlashColorOn" VT_I4 Flashing Back‐ Parpadeo de co‐ Botón, elipse, segmen‐

ground Color lor de fondo acti‐ to de elipse, círculo,
On vado segmento circular, po‐
zante,
"Background" VT_BOO Background Fondo Barra 3D,
L
"BackgroundPicture" VT_USE Background‐ BackgroundPic‐ XGaugeCtrl,
RDEFI‐ Picture ture
NED
"BarBackColor" VT_UI4 BarBackColor BarBackColor SliderCtrl,
"BarFillColor" VT_UI4 BarFillColor BarFillColor SliderCtrl,
"BarDepth" VT_I4 Bar Depth Profundidad de Barra 3D,
barra
"BarHeight" VT_I4 Bar Height Altura de barra Barra 3D,
"BarWidth" VT_I4 Bar Width Ancho de barra Barra 3D,
"BasePicReferen‐ VT_BOO Basic Picture Imagen raíz refe‐ Indicador de estado,
ced" L Referenced renciada
"BasePicTransColor" VT_I4 Basic Picture Color transpa‐ Indicador de estado,
Transparent rente de imagen
Color raíz
"BasePicture" VT_BST Basic Picture Imagen raíz Indicador de estado,
R
"BasePicUseTrans‐ VT_BOO Basic Picture Color transpa‐ Indicador de estado,
Color" L Transparent rente de imagen
Color On raíz activado
"BaseX" VT_I4 Base X Base X Barra 3D,
"BaseY" VT_I4 Base Y Base Y Barra 3D,
"Bevellner" VT_I4 Bevellner Bevellner SliderCtrl,
"BevelColorDown" VT_UI4 BevelColor‐ BevelColorDown SliderCtrl,
Down
"BevelColorUp" VT_UI4 BevelColorUp BevelColorUp SliderCtrl,
"BevelOuter" VT_I4 BevelOuter BevelOuter XGaugeCtrl,
"BevelWidth" VT_I4 BevelWidth BevelWidth XGaugeCtrl,
"BitNumber" VT_I4 Número de bit Indicador de estado,

"BorderBackColor" VT_I4 Border Back‐ Color de fondo Botón, elipse, arco

ground Color, de borde, color elíptico, segmento elíp‐
Line Back‐ de fondo de línea tico, círculo, arco circu‐
groundColor lar, segmento circular,
línea, polígono, polilí‐
nea, rectángulo, rec‐
fico, lista de textos, in‐
dicador de estado, ca‐
zante,
"BorderColor" VT_I4 Border Color, Color de borde, Botón, elipse, arco
Line Back‐ color de línea elíptico, segmento elíp‐
ground Color tico, círculo, arco circu‐
lar, segmento circular,
objeto gráfico, lista de
textos, indicador de es‐
tado, casilla de verifica‐
botón redondo, objeto
deslizante,
"BorderColorBottom" VT_I4 3D Shadow Color de borde Botón, botón redondo,
Color 3D abajo
"BorderColorTop" VT_I4 3D Border Co‐ Color de borde Botón, botón redondo,
lor 3D arriba
"BorderEndStyle" VT_UI4 Line End Style Finales de línea Línea, polilínea,
"BorderFlashColo‐ VT_I4 Flashing Bor‐ Parpadeo de co‐ Botón, elipse, arco
rOff" der Color Off, lor de borde de‐ elíptico, segmento elíp‐
Flashing Line sactivado, parpa‐ tico, círculo, arco circu‐
Color Off deo de color de lar, segmento circular,
línea desactiva‐ línea, polígono, polilí‐
do nea, rectángulo, rec‐
tón de opción, objeto
deslizante,

"BorderFlashColo‐ VT_I4 Flashing Bor‐ Parpadeo de co‐ Botón, elipse, arco

rOn" der Color On, lor de borde acti‐ elíptico, segmento elíp‐
Flashing Line vado, parpadeo tico, círculo, arco circu‐
Color On de color de línea lar, segmento circular,
activado línea, polígono, polilí‐
zante,
"BorderStyle" VT_UI4 Line Style Tipo de línea Botón, elipse, arco
elíptico, segmento elíp‐
tico, círculo, arco circu‐
3D, campo E/S, objeto
gráfico, lista de textos,
indicador de estado,
casilla de verificación,
botón de opción, botón
zante,
"BorderWidth" VT_I4 Line Weight Ancho de línea Botón, elipse, arco
objeto gráfico, lista de
deslizante,
"BorderWidth" VT_I4 OCX BorderWidth BorderWidth XGaugeCtrl,
"BoxAlignment" VT_BOO Box Alignment Alineación de Casilla de verificación,
L campo botón de opción,
"BoxCount" VT_I4 Number of Bo‐ Número de cam‐ Casilla de verificación,
xes pos botón de opción,
"BoxType" VT_I4 Field Type Tipo de campo Campo E/S, lista de
textos,
"Button1Width" VT_I4 Button 1 Width Ancho botón 1 Indicador de grupo,


(Error: Button1
Width 2)
(Error: Button
1 Width 3)
"ButtonColor" VT_I4 Button Color Color de botón Objeto deslizante,
"ButtonCommand" VT_I4 OCX ButtonCom‐ ButtonCommand CCAlgWinCtrl,
mand
"Caption" VT_BOO Title Título Trabajo de impresión/
L diagnóstico de script,
ventana de imagen,
"Caption" VT_BST OCX Caption Caption XGaugeCtrl, PBut‐
R tonCtrl, SliderCtrl,
"CaptionColor" VT_UI4 OCX CaptionColor CaptionColor XGaugeCtrl,
"CaptionFont" VT_USE OCX CaptionFont CaptionFont XGaugeCtrl,
RDEFI‐
NED
"CaptionOffset" VT_R8 OCX CaptionOffset CaptionOffset XGaugeCtrl,
"CellCut" VT_BOO OCX CellCut CellCut CCAlgWinCtrl,
L
"CenterColor" VT_UI4 OCX CenterColor CenterColor XGaugeCtrl,
"CenterScale" VT_R4 OCX CenterScale CenterScale XGaugeCtrl,
"CheckAlarmHigh" VT_BOO Monitoring AH Supervisión AH Barra,
L
"CheckAlarmLow" VT_BOO Monitoring AL Supervisión AL Barra,
L
"CheckLimitHigh4" VT_BOO Monitoring Supervisón RH4 Barra,
L RH4
"CheckLimitHigh5" VT_BOO Monitoring Supervisión RH5 Barra,
L RH5
"CheckLimitLow4" VT_BOO Monitoring RL4 Supervisión RL4 Barra,
L
"CheckLimitLow5" VT_BOO Monitoring RL5 Supervisión RL5 Barra,
L
"CheckToleran‐ VT_BOO Monitoring TH Supervisión TH Barra,
ceHigh" L
"CheckTolerance‐ VT_BOO Monitoring TL Supervisión TL Barra,
Low" L
"CheckWarningHigh" VT_BOO Monitoring WH Supervisión WH Barra,
L
"CheckWarningLow" VT_BOO Monitoring WL Supervisión WL Barra,
L
"ClearOnError" VT_BOO Clear on Inva‐ Borrar en caso Campo E/S,
L lid Input de entrada erró‐
nea
"ClearOnNew" VT_BOO Clear on New Borrar en caso Campo E/S,
L Input de nueva entrada

"CloseButton" VT_BOO Can be Closed Cerrable Trabajo de impresión/

L diagnóstico de script,
ventana de imagen,
"CollectValue" VT_UI4 Group Value Valor de grupo Indicador de grupo
"ColMove" VT_BOO OCX ColMove ColMove CCAlgWinCtrl,
L
"ColorAlarmHigh" VT_I4 Bar Color AH Color de barra Barra,
AH
"ColorAlarmLow" VT_I4 Bar Color AL Color de barra AL Barra,
"ColorBottom" VT_I4 Low Limit Color Color tope infe‐ Objeto deslizante,
rior
"ColorChangeType" VT_BOO Change Color Cambio de color Barra,
L
"ColorLimitHigh4" VT_I4 Bar Color RH4 Color de barra Barra,
RH4
"ColorLimitHigh5" VT_I4 Bar Color RH5 Color de barra Barra,
RH5
"ColorLimitLow4" VT_I4 Bar Color RL4 Color de barra Barra,
RL4
"ColorLimitLow5" VT_I4 Bar Color RL5 Color de barra Barra,
RL5
"ColorToleran‐ VT_I4 Bar Color TH Color de barra Barra,
ceHigh" TH
"ColorTolerance‐ VT_I4 Bar Color TL Color de barra TL Barra,
Low"
"ColorTop" VT_I4 High Limit Co‐ Color tope supe‐ Objeto deslizante,
lor rior
"ColorWarningHigh" VT_I4 Bar Color WH Color de barra Barra,
WH
"ColorWarningLow" VT_I4 Bar Color WL Color de barra Barra,
WL
"ColTitle" VT_BOO OCX ColTitle ColTitle CCAlgWinCtrl,
L
"ColWidth" VT_BOO OCX ColWidth ColWidth CCAlgWinCtrl,
L
"CursorControl" VT_BOO Cursor Control Control del cur‐ Campo E/S, lista de
L sor textos,
"CursorMode" VT_BOO
L
"Danger" VT_R4 OCX Danger Danger XGaugeCtrl,
"DangerColor" VT_UI4 OCX DangerColor DangerColor XGaugeCtrl,
"DataFormat" VT_I4 Data Format Formato de datos Campo E/S,
"DataLanguage" VT_I4 Configured Idiomas configu‐ Botón, texto estático,
Languages rados casilla de verificación,
botón de opción,
"Delta" VT_R4 Delta Delta XGaugeCtrl,
"DesignMode"
"DigitNumber"

"Direction" VT_I4 Bar Alignment Dirección de ba‐ Barra 3D, objeto desli‐
rra zante, barra,
"EditAtOnce" VT_BOO Immediate In‐ Entrada inmedia‐ Campo E/S, lista de
L put ta textos,
"EnableTime"
"EnableWriting"
"EndAngle" VT_I4 End Angle Ángulo final Arco elíptico, segmen‐
to de elipse, arco circu‐
"Exponent" VT_BOO Exponent Dis‐ Representación Barra,
L play exponencial
"ExtendedOperation" VT_BOO Extended Ope‐ Operación avan‐ Objeto deslizante,
L ration zada
"FillBackColor"
"FillColor" VT_I4 Fill Pattern Co‐ Color de patrón Botón, elipse, segmen‐
lor de relleno to de elipse, círculo,
zante,
"Filling" VT_BOO Dynamic Filling Relleno dinámico Botón, elipse, segmen‐
L to de elipse, círculo,
texto estático, objeto
gráfico, casilla de veri‐
ficación, botón de op‐
"FillingIndex VT_I4 Fill Level Nivel de llenado Botón, elipse, segmen‐
to de elipse, círculo,
texto estático, objeto
gráfico, casilla de veri‐
ficación, botón de op‐
objeto deslizante

"FillStyle" VT_UI4 Fill Pattern Patrón de relleno Botón, elipse, segmen‐

to de elipse, círculo,
zante,
"FillStyle2" VT_UI4 Bar Pattern Patrón de barra Barra,
"FlashBackColor" VT_BOO Flashing Back‐ Parpadeo de fon‐ Botón, elipse, segmen‐
L ground Active do activo to de elipse, círculo,
zante,
"FlashBorderColor" VT_BOO Flashing Line Parpadeo de bor‐ Botón, elipse, arco
L Active de activo elíptico, segmento elíp‐
zante,
"FlashBorderColo‐
rEx"
"FlashFlashPicture" VT_BOO Flashing Flash Parpadeo de Indicador de estado,
L Picture Active imagen intermi‐
tente activo
"FlashForeColor" VT_BOO Flashing Text Parpadeo de Botón, texto estático,
L Active fuente activo campo E/S, lista de tex‐
"FlashPicReferen‐ VT_BOO Flash Picture Imagen intemi‐ Indicador de estado,
ced" L Referenced tente referencia‐
da

"FlashPicTransCo‐ VT_I4 Flash Picture Imagen intermi‐ Indicador de estado,

lor" Transparent tente color trans‐
Color parente
"FlashPicture" VT_BST Flash Picture Imagen intermi‐ Indicador de estado,
R tente
"FlashPicUseTrans‐ Flash Picture Imagen intermi‐ Indicador de estado,
Color" Transparent tente color trans‐
Color On parente activada
"FlashRate" VT_I4 Flash Fre‐ Frecuencia de Indicador de grupo,
quency parpadeo
"FlashRateBackCo‐ VT_I4 Background Frecuencia de Botón, elipse, segmen‐
lor" Flash Fre‐ parpadeo fondo to de elipse, círculo,
quency segmento circular, po‐
zante,
"FlashRateBorder‐ VT_I4 Line Flash Fre‐ Frecuencia de Botón, elipse, arco
Color" quency parpadeo borde elíptico, segmento elíp‐
zante,
"FlashRateFlashPic" VT_I4 Flash Picture Frecuencia de Indicadores de estado
Flash Fre‐ parpadeo ima‐
quency gen intermitente
"FlashRateForeCo‐ VT_I4 Text Flash Fre‐ Frecuencia de Botón, texto estático,
lor" quency parpadeo de campo E/S, lista de tex‐
fuente tos, casilla de verifica‐
"Font" VT_USE OCX Font Font DAClockCtrl, PBut‐
RDEFI‐ tonCtrl, SliderCtrl,
NED
"FontBold" VT_BOO Bold Negrita Botón, texto estático,
L campo E/S, barra, indi‐
cador de grupo, lista
de textos, casilla de ve‐
rificación, botón de op‐
ción,

"FontBold" VT_BOO OCX FontBold FontBold PButtonCtrl,

L
"FontItalic" VT_BOO Italic Cursiva Botón, texto estático,
L campo E/S, indicador
"FontItalic" VT_BOO FontItalic FontItalic PButtonCtrl,
L
"FontName" VT_BST Font Juego de carac‐ Botón, texto estático,
R teres campo E/S, indicador
"FontName" VT_BST OCX FontName FontName PButtonCtrl,
R
"FontPosition" VT_USE OCX FontPosition FontPosition SliderCtrl
RDEFI‐
NED
"FontSize" VT_I4 Font Size Tamaño de ca‐ Botón, texto estático,
racteres campo E/S, indicador
"FontSize" VT_BST OCX FontSize Font Size PButtonCtrl,
R
"FontStrikeThru" VT_BOO OCX FontStrikeThru FontStrikeThru PButtonCtrl,
L
"FontUnderline" VT_BOO Underline Subrayado Botón, texto estático,
L campo E/S, indicador
"FontUnderline" VT_BOO OCX FontUnderline FontUnderline PButtonCtrl,
L
"ForceInput"
"ForeColor" VT_I4 Font Color Color de fuente Botón, texto estático,
"ForeColor" VT_UI4 OCX ForeColor ForeColor DAClockCtrl, PBut‐
tonCtrl, SliderCtrl,
"ForeFlashColorOff" VT_I4 Flashing Text Color de fuente Botón, texto estático,
Color Off intermitente de‐ campo E/S, indicador
sactivado de grupo, lista de tex‐

"ForeFlashColorOn" VT_I4 Flashing Text Color de fuente Botón, texto estático,

Color On intermitente acti‐ campo E/S, indicador
vado de grupo, lista de tex‐
"FrameColor" VT_UI4
"FrameColorDown" VT_UI4 OCX FrameColor‐ FrameColor‐ PButtonCtrl,
Down Down
"FrameColorUp" VT_UI4 OCX FrameColorUp FrameColorUp PButtonCtrl,
"FramePicture" VT_USE OCX FramePicture FramePicture XGaugeCtrl,
RDEFI‐
NED
"FrameScale" VT_R4 OCX FrameScale FrameScale XGaugeCtrl,
"FrameSize" OCX FrameSize FrameSize PButtonCtrl,
"FrameWidth" VT_I4 OCX FrameWidth FrameWidth PButtonCtrl,
"Freeze" VT_BOO Freeze Freeze WTVctrlCtrl,
L
"Grid" VT_BOO
L
"GridColor" VT_I4
"GridHeight" VT_I4
"GridLineHorz" VT_BOO OCX GridLineHorz GridLineHorz CCAlgWinCtrl,
L
"GridLineVert" VT_BOO OCX GridLineVert GridLineVert CCAlgWinCtrl,
L
"GridWidth" VT_I4
"Height" VT_I4 Height Altura Botón, elipse, arco
objeto gráfico, indica‐
dor de grupo, lista de
deslizante, DA‐
ClockCtrl, XGau‐
geCtrl, CCAlgWinCtrl,
PButtonCtrl, SliderCtrl,
WTVctrlCtrl,
"Height" VT_I4 Window Height Altura de ventana Trabajo de impresión/
diagnóstico de script,
ventana de imagen,
"HiddenInput" VT_BOO Hidden Input Entrada oculta Campo E/S,
L

"Hotkey" VT_UI4 Hot Key Hotkey Botón,

"HourNeedleHeight" VT_I4 HourNee‐ HourNee‐ DAClockCtrl,
dleHeight dleHeight
"HourNeedleWidth" VT_I4 HourNeedle‐ HourNeedle‐ DAClockCtrl,
Width Width
"Hysteresis" VT_BOO Hysteresis Histéresis Barra,
L
"HysteresisRange" VT_R8 Hysteresis Rango de histé‐ Barra,
Range resis
"Index" VT_I4 Index Index Polígono, polilínea, in‐
tón de opción,
"InnerBevelOffset" VT_I4 OCX InnerBevelOff‐ InnerBevelOffset SliderCtrl,
set
"InnerBevelStyle" VT_I4 OCX InnerBevelSty‐ InnerBevelStyle SliderCtrl,
le
"InnerBevelWidth" VT_I4 OCX InnerBevel‐ InnerBevelWidth SliderCtrl,
Width
"ItemBorderBackCo‐ VT_I4 Dividing Back‐ Color de fondo Lista de textos,
lor" ground Color de separador
"ItemBorderColor" VT_I4 Dividing Line Color de separa‐ Lista de textos,
Color dor
"ItemBorderStyle" VT_UI4 Dividing Line Tipo de separa‐ Lista de textos,
Style dor
3.3.1.6 Lista de las propiedades de objeto (L-Z) (Graphics Designer) (RT Professional)
Resumen
Nota
En muchas funciones API del Graphics Designer es necesario asignar el parámetro
lpszPropName. En ese caso, hay que indicar el nombre inglés de una propiedad de objeto.
Las propiedades del tipo VT_USERDEFINED no pueden editarse con las funciones Get/Set-
Property.
No debe utilizarse VT_DISPATCH ni otras referencias, solo los tipos normales y como máximo
un VT_VARIANT para una propiedad de matriz de tipos simples.
Nombre OLE-Au‐ Tipo de Nombre de Nombre de atri‐ Pertenencia a objeto

tomation datos propiedad buto
"LanguageS‐ VT_BOOL Language Cambio de Lista de textos,
witch" Switch idioma
"LastChange" VT_BSTR

"Layer" VT_I4 Layer Nivel Botón, elipse, arco elípti‐

co, segmento elíptico, cír‐
culo, arco circular, seg‐
mento circular, línea, polí‐
gono, polilínea, rectángu‐
lo, rectángulo redondea‐
do, texto estático, barra
3D, trabajo de impresión/
diagnóstico de script, ven‐
tana de imagen, campo E/
S, barra, objeto gráfico, in‐
dicador de grupo, lista de
textos, indicador de esta‐
do, casilla de verificación,
botón de opción, botón re‐
dondo, objeto deslizante,
XGaugeCtrl, CCAlg‐
WinCtrl, PButtonCtrl, Sli‐
derCtrl, WTVctrlCtrl,
"Layer00Che‐ VT_BOOL BPC Monitoring 0 Supervisión 0 Barra 3D,
cked"
cked"
cked"
cked"
cked"
cked"
cked"
cked"
cked"
cked"
cked"
"Layer00Color" VT_I4 BPC Bar Color 0 Color de barra Barra 3D,
0
1
2
3
4


5
6
7
8
9
10
"Layer00Value" VT_R8 BPC Limit 0 Límite 0 Barra 3D,
"Left" VT_I4 Position X Position X Botón, elipse, arco elípti‐
XGaugeCtrl, CCAlg‐
WinCtrl, PButtonCtrl, Sli‐
derCtrl, WTVctrlCtrl,
"LeftComma" VT_I4 Digits to the Posiciones de‐ Barra,
Left of the De‐ lante de la co‐
cimal Point ma
"LightEffect" VT_BOOL Light Effect Efecto lumino‐ Barra 3D,
so
"LimitHigh4" VT_R8 Limit RH4 Límite superior Barra,
RH4

"LimitHigh5" VT_R8 Limit RH5 Límite superior Barra,

RH5
"LimitLow4" VT_R8 Limit RL4 Límite superior Barra,
RL4
"LimitLow5" VT_R8 Limit RL5 Límite superior Barra,
RL5
"LimitMax" VT_R8
"LimitMin" VT_R8
" LineFont " VT_BOOL OCX LineFont LineFont CCAlgWinCtrl,
"LineHeight" VT_BOOL OCX LineHeight LineHeight CCAlgWinCtrl,
"LineTitle" VT_BOOL OCX LineTitle LineTitle CCAlgWinCtrl,
"ListType" VT_I4 List Type Tipo de lista Lista de textos,
"Locale"
"LockBackColor" VT_I4 Lock Back‐ Bloqueo de co‐ Indicador de grupo,
ground Color lor de fondo
"LockStatus" VT_BOOL Lock Display Bloquear pan‐ Indicador de grupo,
talla
"LockText" VT_BOOL Lock Display Bloquear texto Indicador de grupo,
Text visualizado
"LockTextColor" VT_I4 Lock Font Co‐ Bloquear color Indicador de grupo,
lor de fuente
"LongStrokes‐ VT_BOOL Long Axis Sec‐ Secciones lar‐ Barra,
Bold" tion gas
"LongStroke‐ VT_BOOL Only Long Axis Solo seccio‐ Barra,
sOnly" Section nes largas
"LongStrokesSi‐ VT_UI4 Length of Axis Longitud de Barra,
ze" Section sección
"LongStrokes‐ VT_UI4 Label Each Rotular cada Barra,
TextEach" uno
"Marker" VT_BOOL Limit Marker Marcador de lí‐ Barra,
mite
"Max" VT_R8 Maximum Va‐ Valor máximo Barra 3D, objeto deslizan‐
lue te, barra,
"MaximizeBut‐ VT_BOOL Can be Maxi‐ Maximizable Trabajo de impresión/diag‐
ton" mized nóstico de script, ventana
de imagen,
"MCGUBackCo‐ VT_I4 Went Out Saliente no Indicador de grupo,
lorOff" Unacknowled‐ acusado - co‐
ge- Back‐ lor de fondo de‐
ground Color sactivado
Off
"MCGUBackCo‐ VT_I4 Went Out Saliente no Indicador de grupo,
lorOn" Unacknowled‐ acusado - co‐
ge- Back‐ lor de fondo ac‐
ground Color tivado
On

"MCGUBack‐ VT_BOOL Went Out Saliente no Indicador de grupo,

Flash" Unacknowled‐ acusado - co‐
ge - Back‐ lor de fondo in‐
ground Flas‐ termitente
hing
"MCGUTextCo‐ VT_I4 Went Out Entrante - co‐ Indicador de grupo,
lorOff" Unacknowled‐ lor de fondo de‐
ge- Text Color sactivado
Off
"MCGUTextCo‐ VT_I4 Went Out Entrante - co‐ Indicador de grupo,
lorOn" Unacknowled‐ lor de fondo ac‐
ge- Text Color tivado
On
"MCGUText‐ VT_BOOL Went Out Saliente no Indicador de grupo,
Flash" Unacknowled‐ acusado - co‐
ge- Text Flas‐ lor de fondo in‐
hing termitente
"MCKOBackCo‐ VT_I4 Came In - Entrante - co‐ Indicador de grupo,
lorOff" Background lor de fondo de‐
Color Off sactivado
"MCKOBackCo‐ VT_I4 Came In - Entrante - co‐ Indicador de grupo,
lorOn" Background lor de fondo ac‐
Color On tivado
"MCKOBack‐ VT_BOOL Came In - Entrante - fon‐ Indicador de grupo,
Flash" Background do intermitente
Flashing
"MCKOTextCo‐ VT_I4 Came In - Text Entrante - co‐ Indicador de grupo,
lorOff" Color Off lor de fuente
desactivado
"MCKOTextCo‐ VT_I4 Came In - Text Entrante - co‐ Indicador de grupo,
lorOn" Color On lor de fuente
activado
"MCKOText‐ VT_BOOL Came In - Text Entrante - fuen‐ Indicador de grupo,
Flash" Flashing te intermitente
"MCKQBackCo‐ VT_I4 Came In Ack‐ Entrante acu‐ Indicador de grupo,
lorOff" nowledge - sado - color de
Background fondo desacti‐
Color Off vado
"MCKQBackCo‐ VT_I4 Came In Ack‐ Entrante acu‐ Indicador de grupo,
lorOn" nowledge - sado - color de
Background fondo activado
Color On
"MCKQBack‐ VT_BOOL Came In Ack‐ Entrante acu‐ Indicador de grupo,
Flash" nowledge - sado - fondo in‐
Background termitente
Flashing
"MCKQTextCo‐ VT_I4 Came In Ack‐ Entrante acu‐ Indicador de grupo,
lorOff" nowledge - sado - color de
Text Color Off fuente desacti‐
vado

"MCKQTextCo‐ VT_I4 Came In Ack‐ Entrante acu‐ Indicador de grupo,

lorOn" nowledge - sado - color de
Text Color On fuente activado
"MCKQText‐ VT_BOOL Came In Ack‐ Entrante acu‐ Indicador de grupo,
Flash" nowledge - sado - fuente
Text Flashing intermitente
"MCText" VT_BOOL Display Text Texto visuali‐ Indicador de grupo,
zado
"MessageClass" VT_I4 Message Type Tipo de aviso Indicador de grupo,
"Min" VT_R8 Minimum Va‐ Valor mínimo Indicador de grupo,
lue
"MinuteNee‐ VT_I4 OCX MinuteNee‐ MinuteNee‐ Indicador de grupo,
dleHeight" dleHeight dleHeight
"MinuteNeedle‐ VT_I4 OCX MinuteNeedle‐ MinuteNeedle‐ Indicador de grupo,
Width" Width Width
"MsgFilter" VT_BSTR OCX MsgFilter
"MsgFilter2" VT_BSTR OCX MsgFilter2
"Moveable" VT_BOOL Moveable Movible Trabajo de impresión/diag‐
nóstico de script, ventana
de imagen,
"NeedleColor" VT_UI4 OCX NeedleColor NeedleColor XGaugeCtrl,
"NormalColor" VT_UI4 OCX NormalColor NormalColor XGaugeCtrl,
"NumberLines" VT_I4 Number of visi‐ Número de lí‐ Lista de textos, casilla de
ble Lines neas visibles verificación, botón de op‐
ción,
"ObjectName" VT_BSTR Object Name Nombre del ob‐ Botón, elipse, arco elípti‐
jeto co, segmento elíptico, cír‐
diagnóstico de script, cam‐
po E/S, barra, barra, objeto
gráfico, indicador de gru‐
po, lista de textos, indica‐
dor de estado, casilla de
verificación, botón de op‐
ción, botón redondo, obje‐
to deslizante, DA‐
ClockCtrl, XGaugeCtrl,
CCAlgWinCtrl, PBut‐
WTVctrlCtrl,
"OffsetLeft" VT_I4 Picture Offset Offset de ima‐ Ventana de imagen,
X gen X
"OffsetTop" VT_I4 Picture Offset Offset de ima‐ Ventana de imagen,
Y gen Y
"OnTop" VT_BOOL Foreground Primer plano Trabajo de impresión/diag‐
de imagen,

"Operation" VT_BOOL Operator-Con‐ Habilitación de Botón, elipse, arco elípti‐

trol Enable operación co, segmento elíptico, cír‐
3D, campo E/S, barra, ob‐
jeto gráfico, indicador de
grupo, lista de textos, indi‐
cador de estado, casilla de
WTVctrlCtrl,
"OperationMes‐ VT_BOOL Operator Input Aviso de ope‐ Campo E/S, lista de textos,
sage" Message rador casilla de verificación, bo‐
tón de opción, objeto desli‐
zante
"OperationRe‐ VT_BOOL Operator Ac‐ Informe de Campo E/S, lista de textos,
port" tions Report operación objeto deslizante
"OperationSteps" Operation Pasos de ope‐ Objeto deslizante,
Steps ración
"Orientation" VT_BOOL Text Orienta‐ Sentido de es‐ Texto estático, campo E/S,
tion critura lista de textos, casilla de
ción,
"OuterBevelOff‐ VT_I4 OCX OuterBevelOff‐ OuterBevelOff‐ SliderCtrl,
set" set set
"OuterBevelSty‐ VT_I4 OCX OuterBe‐ OuterBe‐ SliderCtrl,
le" velStyle velStyle
"OuterBevel‐ VT_I4 OCX OuterBevel‐ OuterBevel‐ SliderCtrl,
Width" Width Width
"Outline" VT_BOOL OCX Outline Outline PButtonCtrl,
"OutputFormat" VT_BSTR Output Format Formato de sa‐ Campo E/S,
lida
"OutputValue" VT_R8 Output Value Valor de salida Campo E/S, lista de textos,

"PasswordLevel" VT_UI4 User Level Contraseña Botón, elipse, arco elípti‐

to deslizante,
"PicDeactRefe‐ VT_BOOL Picture Deact. Imagen de‐ Botón redondo,
renced" Referenced sact. Referen‐
ciado
"PicDeactTrans‐ VT_I4 Picture Deact. Imagen de‐ Botón redondo,
parent" Transparent sact. Color
Color transparente
"PicDeactUse‐ VT_BOOL Picture Deact. Imagen de‐ Botón redondo,
TransColor" Transparent sact. Color
Color On transparente
activado
"PicDownRefe‐ VT_BOOL Picture On Re‐ Imagen activa‐ Botón redondo,
renced" ferenced da referencia‐
da
"PicDownTrans‐ VT_I4 Picture On Imagen activa‐ Botón redondo,
parent" Transparent da color trans‐
Color parente
"PicDownUse‐ VT_BOOL Picture On Imagen activa‐ Botón redondo,
TransColor" Transparent da color trans‐
Color On parente activa‐
do
"PicReferenced" VT_BOOL Picture Refe‐ Imagen refe‐ Objeto gráfico,
renced renciada
"PicTransColor" VT_I4 Picture Trans‐ Imagen color Objeto gráfico,
parent Color transparente
"Picture" VT_USER OCX Picture Picture DAClockCtrl,
DEFINED
"PictureBack" VT_USER OCX PictureBack PictureBack SliderCtrl,
DEFINED
"PictureDeacti‐ VT_BSTR Picture Status Imagen estado Botón redondo,
vated" Deactivated desactivada
"PictureDown" VT_BSTR Picture Status Imagen estado Botón, botón redondo,
On activada
"PictureName" VT_BSTR Picture Name Nombre de Ventana de imágenes, ob‐
imagen jeto gráfico
"PictureSelec‐ VT_USER OCX PictureSelec‐ PictureSelec‐ PButtonCtrl,
ted" DEFINED ted ted
"PictureUnselec‐ VT_USER OCX Picture Unse‐ PictureUnse‐ PButtonCtrl,
ted" DEFINED lected lected

"PictureObject‐
Path"
"PictureThumb" VT_USER PictureThumb PictureThumb SliderCtrl,
DEFINED
"PictureUp" VT_BSTR Picture Status Imagen estado Botón, botón redondo,
Off desactivada
"PicUpReferen‐ VT_BOOL Picture Off Re‐ Imagen desac‐ Botón redondo,
ced" ferenced tivada referen‐
ciada
"PicUpTranspa‐ VT_I4 Picture Off Imagen desac‐ Botón redondo,
rent" Transparent tivada color
Color transparente
"PicUpUse‐ VT_BOOL Picture Off Imagen desac‐ Botón redondo,
TransColor" Transparent tivada color
Color On transparente
activado
"PicUseTrans‐ VT_BOOL Picture Trans‐ Color transpa‐ Objeto gráfico,
Color" parent Color rente activado
On
"PointCount" VT_I4 Number of Cor‐ Número de es‐ Polígono, polilínea,
ners quinas
"Position" VT_I4 OCX Positions Posición SliderCtrl,
"PredefinedAn‐ VT_I4 BPC Angle Settings Ajustes de án‐ Barra 3D
gles" gulo
"Pressed" VT_BOOL Pressed Pulsado Botón redondo,
"Process" VT_R8 Process Driver Conexión de Barra 3D, objeto deslizan‐
Connection proceso te, barra,
"Process" VT_R8 Selected Bo‐ Campos selec‐ Casilla de verificación, bo‐
xes cionados tón de opción
"ProfileName"
"ProjectName"
"ProjectPath" VT_BSTR OCX ProjectPath ProjectPath CCAlgWinCtrl,
"Radius" VT_I4 Radio Radio Círculo, arco circular, seg‐
mento circular, botón re‐
dondo,
"RadiusHeight" VT_I4 Radio Y Radio Y Elipse, arco elíptico, seg‐
mento elíptico,
"RadiusWidth" VT_I4 Radio X Radio X Elipse, arco elíptico, seg‐
mento elíptico,
"RangeMax" VT_I4 OCX RangeMax RangeMax SliderCtrl,
"RangeMin" VT_I4 OCX RangeMin RangeMin SliderCtrl,
"ReferenceMo‐
veLeft"
"ReferenceMo‐
veTop"
"ReferenceRota‐ VT_I4 Rotation Refe‐ Referencia de Línea, polígono, polilínea,
tionLeft" rence X rotación X
"ReferenceRota‐ VT_I4 Rotation Refe‐ Referencia de Línea, polígono, polilínea,
tionTop" rence Y rotación Y

"RefreshTimer‐ VT_I4 OCX RefreshTimer‐ RefreshTimer‐ WTVctrlCtrl,

Period" Period Period
"Relevant" VT_BOOL Group Rele‐ Relevante pa‐ Indicador de grupo,
vant ra grupo
"RightComma" VT_I4 Digits to the Decimales Barra,
Right of the De‐
cimal Point
"RotationAngle" VT_I4 Rotation Angle Ángulo de rota‐ Línea, polígono, polilínea,
ción
"RoundCorner‐ VT_I4 Corner Radius Esquina radio Rectángulo redondeado,
Height" Y Y
"RoundCorner‐ VT_I4 Corner Radius Esquina radio Rectángulo redondeado,
Width" X X
"SameSize" VT_BOOL Same Size Mismo tamaño Indicador de grupo,
"ScaleColor" VT_I4 Scale Color Color de escala Barra,
"ScaleTicks" VT_I4 Scale Marks Ajuste de esca‐ Barra,
la
"Scaling" VT_BOOL Scale Escala Barra,
"ScalingType" VT_I4 Bar Scalling Escala de ba‐ Barra,
rra
"ScrollBars" VT_BOOL Scroll Bar Barra deslizan‐ Ventana de imagen,
te
"SecondNee‐ VT_I4 OCX SecondNee‐ SecondNee‐ DAClockCtrl,
dleHeight" dleHeight dleHeight
"SecondNeedle‐ VT_I4 OCX SecondNee‐ SecondNee‐ DAClockCtrl,
Width" dleWidth dleWidth
"SelBGColor" VT_I4 Selection Color de fondo Lista de textos,
Background de selección
Color
"SelectionMode" VT_I2 OCX SelectionMode SelectionMode CCAlgWinCtrl,
"SelTextColor" VT_I4 Selection Font Color de fuen‐ Lista de textos,
Color te de selección
"ServerName" VT_BSTR Server Name Nombre de ser‐ DAClockCtrl, XGaugeCtrl,
vidor CCAlgWinCtrl, PBut‐
WTVctrlCtrl,
"Sign"
"Significant‐ VT_UI4 Bit Pattern Patrón de bits Indicador de grupo,
Mask" Group Display indicador de
grupo
"Sizeable" VT_BOOL Sizeable Tamaño modi‐ Trabajo de impresión/diag‐
ficable nóstico de script, ventana
de imagen
"ShowBar" VT_BOOL OCX ShowBar ShowBar SliderCtrl,
"ShowDanger" VT_BOOL OCX ShowDanger ShowDanger XGaugeCtrl,
"ShowDecimal‐ VT_BOOL OCX ShowDecimal‐ ShowDecimal‐ XGaugeCtrl,
Point" Point Point
"ShowNormal" VT_BOOL OCX ShowNormal ShowNormal XGaugeCtrl,
"ShowPeak" VT_BOOL OCX ShowPeak ShowPeak XGaugeCtrl,

"ShowPosition" VT_BOOL OCX ShowPosition ShowPosition SliderCtrl,

"ShowThumb" VT_BOOL OCX ShowThumb ShowThumb SliderCtrl,
"SmallWarning" VT_I4 SmallWarning Objeto deslizante,
"StartAngle" VT_I4 Start Angle Ángulo inicial Arco elíptico, segmento de
elipse, arco circular, seg‐
mento circular,
"TabOrderAlpha"
"TabOrderS‐
witch"
"Template" VT_BSTR Template Plantilla Trabajo de impresión/diag‐
nóstico de script,
"TemplateName" VT_BSTR OCX TemplateNa‐ TemplateNa‐ CCAlgWinCtrl,
me me
"Texto" VT_BSTR Texto Texto Botón, texto estático, casi‐
lla de verificación, botón
de opción,
"ThumbBackCo‐ VT_UI4 OCX ThumbBack‐ ThumbBack‐ SliderCtrl,
lor" Color Color
"TicColor" VT_UI4 OCX TicColor TicColor XGaugeCtrl,
"TicFont" VT_USER OCX TicFont TicFont XGaugeCtrl,
DEFINED
"Ticks" VT_BOOL OCX Ticks Ticks DAClockCtrl,
"TicksColor" VT_UI4 OCX TicksColor TicksColor DAClockCtrl,
"TickStyle" VT_I4 OCX TickStyle TickStyle SliderCtrl,
"TicOffset" VT_R8 OCX TicOffset TicOffset XGaugeCtrl,
"TicTextColor" VT_UI4 OCX TicTextColor TicTextColor XGaugeCtrl,
"TicTextOffset" VT_R8 OCX TicTextOffset TicTextOffset XGaugeCtrl,
"TicWidth" VT_R8 OCX TicWidth TicWidth XGaugeCtrl,
"TitleCut" VT_BOOL OCX TitleCut TitleCut CCAlgWinCtrl,
"Toggle" VT_BOOL Latch Down Encastrar Botón redondo,
"ToleranceHigh" VT_R8 Limit TH Límite superior Barra,
TH
"ToleranceLow" VT_R8 Limit TL Límite inferior Barra,
TL

"ToolTipText" VT_BSTR Tooltip Text Tooltiptext Botón, elipse, arco elípti‐

WTVctrlCtrl,
"Top" VT_I4 Position Y Position Y Botón, elipse, arco elípti‐
DAClockCtrl, XGaugeCtrl,
WTVctrlCtrl,
"Trend" VT_BOOL Trend Trend Barra,
"TrendColor" VT_I4 Trend Color Color de curva Barra,
"TypeAlarmHigh" VT_BOOL Type AH Art AH Barra,
"TypeAlarmLow" VT_BOOL Type AL Tipo AL Barra,
"TypeLimitHigh4" VT_BOOL Type RH4 Tipo RH4 Barra,
"TypeLimitHigh5" VT_BOOL Type RH5 Tipo RH5 Barra,
"TypeLimitLow4" VT_BOOL Type RL4 Tipo RL4 Barra,
"TypeLimitLow5" VT_BOOL Type RL5 Tipo RL5 Barra,
"TypeToleran‐ VT_BOOL Type TH Tipo TH Barra,
ceHigh"
"TypeTolerance‐ VT_BOOL Type TL Tipo TL Barra,
Low"
"TypeWarning‐ VT_BOOL Type WH Tipo WH Barra,
High"

"TypeWarnin‐ VT_UI4 Type WL Tipo WL Barra,

gLow"
"UnitColor" VT_USER OCX UnitColor UnitColor XGaugeCtrl,
DEFINED
"UnitFont" VT_BSTR OCX UnitFont UnitFont XGaugeCtrl,
"UnitText" VT_BSTR OCX UnitText UnitText XGaugeCtrl,
"UnitOffset" VT_R8 OCX UnitOffset UnitOffset XGaugeCtrl,
"UnselBGColor" VT_I4 List Back‐ Color de fondo Lista de textos,
ground Color de lista de se‐
lección
"UnselTextColor" VT_I4 List Font Color Color de fuen‐ Lista de textos,
te de lista de
selección
"UpdateCycle" VT_I4 Update Cycle Patrón de tiem‐ Ventana de imagen,
po de actuali‐
zación
"UseRefreshTi‐ VT_BOOL OCX UseRefreshTi‐ UpdateCycle WTVctrlCtrl,
mer" mer
"UserValue1" VT_UI4 User Value 1 Valor de usua‐ Indicador de grupo,
rio 1
rio 2
rio 3
rio 4
"Value" VT_R4 OCX Value Value XGaugeCtrl,
"ValueMax" VT_R4 OCX ValueMax ValueMax XGaugeCtrl,
"ValueMin" VT_R4 OCX ValueMin ValueMin XGaugeCtrl,
"VideoEnabled" VT_BOOL OCX VideoEnabled VideoEnabled WTVctrlCtrl,
"VideoSource" VT_I2 OCX VideoSource VideoSource WTVctrlCtrl,
"Visible" VT_BOOL Display Visualización Botón, elipse, arco elípti‐
WTVctrlCtrl,

"Warning" VT_R4 OCX Warning Warning XGaugeCtrl,

"WarningColor" VT_UI4 OCX WarningColor WarningColor XGaugeCtrl,
"WarningHigh" VT_R8 Limit WH Límite superior Barra,
WH
"WarningLow" VT_R8 Limit WL Límite inferior Barra,
WL
"Width" VT_I4 Width Ancho Botón, elipse, arco elípti‐
WTVctrlCtrl,
"WindowBorder" VT_BOOL Border Borde Trabajo de impresión/diag‐
de imagen,
"WindowsStyle" VT_BOOL Windows Style Estilo de Win‐ Botón, objeto deslizante,
dows
"WindowType" VT_I2 OCX WindowType WindowType CCAlgWinCtrl,
"WinTVInforma‐ VT_BSTR OCX WinTVInforma‐ WTVctrlCtrl,
tion" tion
"WithAxes" VT_BOOL OCX WithAxes WithAxes SliderCtrl,
"WithLabels" VT_BOOL OCX WithLabels WithLabels SliderCtrl,
"ZeroLeading"
"ZeroPoint" VT_UI4 Zero Point Punto cero Barra,
"ZeroPointValue" VT_R8 Zero Point Va‐ Valor de punto Barra 3D, barra,
lue cero
Zoom VT_I4 Scaling Factor Factor de esca‐ Ventana de imagen
la
3.3.1.7 Llamadas de API en los OCX (RT Professional)
Sinopsis
API ha sido desarrollado para aplicaciones que funcionan dentro de aplicaciones propias. No
obstante, las llamadas de API en OCX integradas en imágenes Graphics pueden causar
problemas e incluso interbloqueos (deadlocks).

Si es imperativo utilizar un OCX en una imagen Graphics, compruebe siempre si la tarea no

puede resolverse con IndustrialX. Ha sido desarrollado para tales fines.
En caso de que la tarea solo pueda resolverse con API, tenga en cuenta las siguientes
indicaciones:
Las funciones especialmente afectadas son las funciones API runtime para archivar avisos
(AlarmLogging) y archivar variables (TagLogging).
Una de las causas es que API solicita en runtime datos de programas WinCC a través de
Window-Message y espera la respuesta. Si OCX funciona precisamente en el contexto de un
programa WinCC de este tipo, no es posible procesar la petición, ya que está bloqueada en
la llamada de API.
Solución:
En este caso suele ser suficiente colocar la llamada de API en otro thread.
Sin embargo, esta solución solo debería utilizarse si realmente existe un problema. Otras
llamadas tienen problemas si no se encuentran en el thread principal.
3.3.2.1 LINKINFO (RT Professional)
Declaración
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Members
LinkType
Para el tipo LINKTYPE deben utilizarse los valores definidos en el archivo "trigger.h" para
enum LinkType.
enum LinkType Valor definido actualmente Operación lógica

BUBRT_LT_NOLINK 0 (valor inicial definido) Sin conexión
BUBRT_LT_VARIABLE_DIRECT 1 (siguiente) Variable directa
BUBRT_LT_VARIABLE_INDIRECT 2 (siguiente) Variable indirecta
BUBRT_LT_ACTION 3 (siguiente) Acción C
BUBRT_LT_ACTION_WIZARD 4 (siguiente) Dynamic Dialog

enum LinkType Valor definido actualmente Operación lógica

BUBRT_LT_DIRECT_CONNECTION 5 (siguiente) Conexión directa
BUBRT_LT_ACTION_WIZARD_INPROC 6 (siguiente) Dynamic Dialog
Cuando se utiliza en PDLRTSetLink sólo deben utilizarse BUBRT_LT_VARIABLE_DIRECT y

BUBRT_LT_VARIABLE_INDIRECT. En PDLRTGetLink pueden devolverse todos los tipos de
enlace.
Nota
En futuras ampliaciones de la definición enum LinkType en trigger.h siempre deben agregarse
nuevas constantes detrás ya que, de lo contrario, se modifica la valencia listada arriba. Por
eso en las enumeraciones siempre debe utilizarse la definición y no el valor.
dwCycle
Tiempo de ciclo de la actualización. dwCycle identifica el orden dentro de la lista de ciclos de
actualización.

"250 ms" Índice: 1
: :
"Ciclo de ventana" Índice: 235
"Ciclo de imagen" Índice: 255
szLinkName
Nombre de la conexión de variable
Archivos necesarios
pdlrtapi.h
trigger.h
Funciones API
PDLRTGetLink (Página 1966) Consultar enlace entre propiedad de objeto y variable

Consulte también
PDLRTGetLink (Página 1966)
PDLRTSetLink (Página 1968)

3.3.2.2 MULTILINK (RT Professional)
Declaración
typedef struct {
DWORD wArraySize;
LPMULTILINKINFO pLinkArray;
}
MULTILINK;
Members
wArraySize
Número de enlaces (número de estructuras del tipo MULTILINKINFO).
pLinkArray
Puntero a la primera de las estructuras wArraySize del tipo MULTILINKINFO (Página 1931)
con información sobre el enlace entre una propiedad de objeto y una variable.
Archivos necesarios
pdlrtapi.h
Funciones API
PDLRTSetMultiLink (Página 1970) Definir enlace entre propiedad de objeto y variable (varias va‐
riables)
Consulte también
PDLRTSetMultiLink (Página 1970)
MULTILINKINFO (Página 1931)

3.3.2.3 MULTILINKINFO (RT Professional)
Declaración
typedef struct {
char* pszObjectName,
char* pszPropertyName,
LINKTYPE LinkType;
DWORD dwCycle;
char* pszLinkName;
}
MULTILINKINFO;
Members
IpszObjectName
Puntero al nombre del objeto.
IpszPropertyName
Puntero al nombre de la propiedad de objeto que hay que enlazar.
LinkType
Identifica el tipo de conexión.
LT_VARIABLE_DIRECT Conectar propiedad de objeto y variable directamente

LT_VARIABLE_INDIRECT Conectar propiedad de objeto y variable indirectamente
dwCycle
Tiempo de ciclo de la actualización. dwCycle identifica el orden dentro de la lista de ciclos de
actualización.

"250 ms" Índice: 1
: :
pszLinkName
Puntero al nombre de la conexión
Observaciones
La estructura MULTILINKINFO forma parte de la estructura MULTILINK (Página 1928).
Archivos necesarios
pdlrtapi.h

Consulte también
MULTILINK (Página 1928)
3.3.2.4 FOCUSINFO (RT Professional)
Descripción
En la estructura se especifica qué objeto de una imagen tiene el cursor de runtime.
Declaración
typedef struct {
WCHAR szPicture[256];
WCHAR szObject[256];
}
FOCUSINFO;
Members
szPicture
Nombre de imagen
szObject
Nombre de objeto
Funciones API
Consulte también
PDLRTGetFocus (Página 1949)
3.3.3.1 PDLRTClosePicture (RT Professional)
Utilización
Cierra una imagen en modo runtime.

Declaración
BOOL PDLRTClosePicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszWName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetros
adrMode
por 0.
lpszPictureName
Puntero al nombre configurado de la imagen, sin ruta ni extensión.
Se diferencia entre mayúsculas y minúsculas.
lpszWName
Nombre del objeto de ventana que se cierra.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Valor de retorno
TRUE
Imagen cerrada.

FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRT_CALLBACK (Página 1945) Función Callback de las funciones de runtime
Consulte también
PDLRT_CALLBACK (Página 1945)
3.3.3.2 PDLRTDisableClosePicture (RT Professional)
Utilización
Bloquea el cierre de una imagen en modo runtime. Se pueden realizar llamadas múltiples. La
imagen sólo puede volver a cerrarse si también se han hecho muchas llamadas de la función
PDLRTEnableClosePicture.
Declaración
BOOL PDLRTDisableClosePicture(
ADRMODE adrMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
por 0.
lpszPictureName

pfn
o no.
pvUser
pError
Puntero a los datos de los mensajes de error ampliados en la estructura CMN_ERROR. En
caso de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función finalizada correctamente.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Consulte también

3.3.3.3 PDLRTEnableClosePicture (RT Professional)
Utilización
Autoriza el cierre de una imagen en modo runtime.
No obstante, la imagen sólo puede volver a cerrarse si también se han hecho muchas llamadas
de la función PDLRTEnableClosePicture, como previamente de la función
PDLRTDisableClosePicture.
Un PDLRTClosePicture que antes ha sido correcto se reserva y después se recupera tras el
último PDLRTEnableClosePicture.
Declaración
BOOL PDLRTEnableClosePicture(
ADRMODE adrMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
por 0.
lpszPictureName
pfn
o no.
pvUser

pError
Valor de retorno
TRUE
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Consulte también
3.3.3.4 PDLRTGotoPicture (RT Professional)
Utilización
Carga la imagen indicada.
Declaración
BOOL PDLRTGotoPicture (
PDLRTGotoPict nextPict,

Parámetros
nextPict
El parámetro controla la función de este método. Se permiten los siguientes valores:
PDLRTPictureHome Carga la imagen inicial.

PDLRTPictureNext Carga la siguiente imagen en la memoria de imágenes.
PDLRTPicturePrev Carga la imagen anterior en la memoria de imágenes.
PDLRTPictureStored Carga la imagen recordada en la memoria de imágenes.
PDLRTStorePicture Recuerda la imagen actual en la memoria de imágenes.
pError
Valor de retorno
TRUE
Cargar imagen.
FALSE
Error.
Mensajes de error
PDLRT_NO_PIC Imagen no seleccionada
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRTPictureNavigation (Pági‐ Activar y desactivar navegación por imágenes

na 1943)
Consulte también
PDLRTPictureNavigation (Página 1943)

3.3.3.5 PDLRTInquireFreeArea (RT Professional)
Utilización
Determina si se puede colocar un rectángulo predeterminado en la pantalla sin tapar un ‘’área
protegida‘’. "Áreas protegidas" son, por ejemplo, otras imágenes en primer plano.
Declaración
BOOL PDLRTInquireFreeArea(
LPRECT lpScreenRect,
DWORD dwModus,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
IpScreenRect
Puntero a una estructura específica de Windows del tipo RECT.
dwModus
Modo de consulta: Se ofrecen varias posibilidades de consulta que pueden combinarse
logicamente con cualquier operación O:
PDLRT_IQ_ONLY (Valor: 0x01) Sólo consultas con resultado ‘’concuerda/no con‐

cuerda’’
PDLRT_IQ_MODY_POSX (Valor: 0x02) Si el rectángulo predeterminado no se puede colocar,
la posición x del rectángulo debe ser modificada de
modo que pueda colocarse.
PDLRT_IQ_MODY_POSY (Valor: 0x04) Si el rectángulo predeterminado no se puede colocar,
la posición y del rectángulo debe ser modificada de
PDLRT_IQ_MODY_HEIGHT (Valor: 0x08) Si el rectángulo predeterminado no se puede colocar,
la altura del rectángulo debe ser modificada de modo
que pueda colocarse.
PDLRT_IQ_MODY_WIDTH (Valor: 0x10) Si el rectángulo predeterminado no se puede colocar,
la anchura del rectángulo debe ser modificada de
pfn
o no.

pvUser
pError
Valor de retorno
TRUE
El área de la ventana es libre.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Consulte también
3.3.3.6 PDLRTOpenPicture (RT Professional)
Utilización
La función ejecuta un cambio de imagen básica en runtime.

Declaración
BOOL PDLRTOpenPicture(
ADRMODE adrMode,
LPCSTR lpszWName,
LPCSTR lpszPictureFileName,
DWORD dwWinStyle,
LONG lxPos,
LONG lyPos,
LONG lWitdh,
LONG lHeight,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
lpszWName
El parámetro debe recibir actualmente el nombre de la imagen.
lpszPictureFileName
El parámetro debe recibir actualmente el nombre de la imagen.
dwWinStyle
por 0.
lxPos
por 0.
lyPos
por 0.
lWidth
por 0.
lHeigth
por 0.

pfn
o no.
pvUser
pError
Valor de retorno
TRUE
Cambio de imagen básica ejecutado.
FALSE
Error.
Mensajes de error
PDLRT_PICTURE_ALREADY_OPEN La imagen ya está abierta

PDLRT_BAD_OLE_CONVERSION Error al convertir con OLE Automation
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Consulte también
3.3.3.7 PDLRTPictureNavigation (RT Professional)
Utilización
Activa y desactiva la navegación por imágenes. Cuando está desactivada, al cambiar de
imagen no se incluyen más imágenes en la pila, sino que se congela el estado anterior.
Declaración
BOOL PDLRTPictureNavigation (
PDLRT_PNFLAGS flags,
Parámetros
flags
El parámetro controla la función. Se permiten los siguientes valores:
PDLRT_PNF_ENABLE Activa la navegación por imágenes.

PDLRT_PNF_DISABLE Desactiva la navegación por imágenes.
PDLRT_PNF_ENABLE_LOAD_LAST_PICTURE Activa la navegación por imágenes y carga la
última imagen en la memoria de imágenes.
pError
Valor de retorno
TRUE
FALSE
Error.
Causa: La navegación por imágenes ya está activada o desactivada.
Archivos necesarios
pdlrtapi.h

pdlrt_s.lib
pdlrtapi.dll
PDLRTGotoPicture (Página 1935) Cargar la imagen especificada
Consulte también
PDLRTGotoPicture (Página 1935)
3.3.3.8 PDLRTShowApp (RT Professional)
Utilización
Con la función, la ventana de runtime en segundo plano pasa a la superficie del escritorio.
Declaración
BOOL PDLRTShowApp (
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
pfn
o no.
pvUser

pError
Valor de retorno
TRUE
Ventana de runtime en primer plano.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRT_CALLBACK (Página 1945) Función Callback
Consulte también
3.3.3.9 PDLRT_CALLBACK (RT Professional)
Descripción
Si la ejecución de funciones AP debe notificarse asíncronamente a la aplicación en Runtime,
es preciso prever funciones Callback del tipo PDLRT_CALLBACK.
Esta función es utilizada por todas las funciones del PDLRT como función Callback.
Declaración
void ( * PDLRT_CALLBACK ) (
LPVOID pvUser,

Parámetros
pvUser
Puntero a datos específicos de la aplicación. Este puntero está disponible como parámetro
de la función API y en este caso se devuelve sin cambios.
pError
Valor de retorno
El Callback no tiene valor de retorno.
Observaciones
Si la función API se llama sin Callback, por tanto con pfn = NULL, la llamada es síncrona. La
aplicación que realiza la llamada se mantiene en espera hasta que PDLRT indica un error o
un éxito. Este tipo de llamada debe utilizarse preferiblemente para secuencias de llamadas
interdependientes.
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos. Sin
sincronización también existe el peligro de que la función asíncrona escriba datos a través
del puntero de datos que ya no es válido, si la ejecución que efectúa la llamada ya ha finalizado
o ha salido del ámbito de validez, lo que lleva al tratamiento de excepciones.
Nota
En algunos casos excepcionales puede ocurrir que se devuelva la función Callback antes de
que retorne la llamada de función.
Archivos necesarios
pdlrtapi.h
Consulte también
PDLRTClosePicture (Página 1930)
PDLRTDisableClosePicture (Página 1932)
PDLRTEnableClosePicture (Página 1934)

PDLRTInquireFreeArea (Página 1937)

PDLRTOpenPicture (Página 1938)
PDLRTShowApp (Página 1942)
PDLRTSetPropEx (Página 1961)
PDLRTGetPropEx (Página 1958)
PDLRTGetDefPropEx (Página 1956)
PDLRTSetFocus (Página 1953)
PDLRTSetCursorKeys (Página 1951)
PDLRTGetCursorKeys (Página 1947)
3.3.4 Funciones para influir en el cursor de runtime (RT Professional)
3.3.4.1 PDLRTGetCursorKeys (RT Professional)
Utilización
Con la función se consultan las teclas de control del cursor que se han activado con
PDLRTSetCursorKeys.
Declaración
BOOL PDLRTGetCursorKeys (
long* pKeyUp,
long* pKeyDown,
long* pKeyLeft,
long* pKeyRight,
long* pKeyState,
long* pTabMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,

Parámetros
KeyUp
Este puntero suministra el código de tecla virtual (VK_...) de la tecla que desplaza el cursor
hacia arriba.
pKeyDown
hacia abajo.
pKeyLeft
hacia la izquierda.
pKeyRight
hacia la derecha.
pKeyState
El puntero suministra los estados del teclado:
HOTKEYF_SHIFT (Valor: 0x01) Tecla "Mayús" pulsada

HOTKEYF_CONTROL (Valor: 0x02) Tecla "Ctrl" pulsada
HOTKEYF_ALT (Valor: 0x04) Tecla "Alt" pulsada
Los valores pueden combinarse lógicamente con cualquier operación O.
pTabMode
Con este puntero, TabMode suministra a qué objeto se salta la siguiente vez que se pulsa
una de las teclas de control del cursor:
O: xxBildxx
1: xxBildxx
10: xxBildxx
xxBildxx
pfn
o no.

pvUser
pError
Valor de retorno
TRUE
Teclas de control del cursor determinadas.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRTSetCursorKeys (Pági‐ Definir teclas de control del cursor

na 1951)
Consulte también
PDLRTSetCursorKeys (Página 1951)
3.3.4.2 PDLRTGetFocus (RT Professional)
Utilización
La función proporciona la imagen y el nombre del objeto que tiene el foco de entrada.

Declaración
BOOL PDLRTGetFocus(
ADRMODE adrMode,
LPFOCUSINFO pFocusInfo,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
PDLRT_AM_DEFAULT o El direccionamiento de la imagen y el objeto es

relativo

con la operación O.
pFocusInfo
Puntero a la estructura FOCUSINFO (Página 1930), en la que se guardan los resultados.
pfn
o no.
pvUser
pError

Valor de retorno
TRUE
Foco de entrada determinado.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRTSetFocus (Página 1953) Definir foco de entrada

Consulte también
FOCUSINFO (Página 1930)
PDLRTSetFocus (Página 1953)
3.3.4.3 PDLRTSetCursorKeys (RT Professional)
Utilización
Con la función se definen las teclas para controlar el cursor.
Declaración
BOOL PDLRTSetCursorKeys (
long KeyUp,
long KeyDown,
long KeyLeft,
long KeyRight,
long KeyState,
long TabMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,

Parámetros
KeyUp
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia arriba.
KeyDown
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia abajo.
KeyLeft
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia la izquierda.
KeyRight
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia la derecha.
KeyState
KeyState devuelve el estado del teclado:
HOTKEYF_SHIFT (Valor: 0x01) Tecla "Mayús" pulsada

HOTKEYF_CONTROL (Valor: 0x02) Tecla "Ctrl" pulsada
HOTKEYF_ALT (Valor: 0x04) Tecla "Alt" pulsada
Los valores pueden combinarse lógicamente con cualquier operación O.
TabMode
Con TabMode se define a qué objeto se salta la siguiente vez que se pulsa una de las teclas
de control del cursor:
0: xxBildxx
1: xxBildxx
10: xxBildxx
xxBildxx
pfn
o no.
pvUser

pError
Valor de retorno
TRUE
Teclas de control del cursor definidas.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRTGetCursorKeys (Pági‐ Consultar teclas de control del cursor

na 1945)
Consulte también
PDLRTGetCursorKeys (Página 1945)
3.3.4.4 PDLRTSetFocus (RT Professional)
Utilización
Con la función se establece el foco de entrada. El objeto se determina con lpszPictureName
y lpszObjectName.

Declaración
BOOL PDLRTSetFocus (
ADRMODE adrMode,
LPCSTR lpszObjectName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
que editar.
PDLRT_AM_DEFAULT o El direccionamiento de la imagen y el objeto es relativo


IpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode, sin extensión. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento definido
con adrMode.
pfn
o no.
pvUser

pError
Valor de retorno
TRUE
Foco de entrada activado
FALSE
Error
Mensajes de error

PDLRT_NO_OBJ Objeto no encontrado
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll

Consulte también

3.3.5 Funciones para editar propiedades de objeto (RT Professional)
3.3.5.1 PDLRTGetDefPropEx (RT Professional)
Utilización
Solicitar un valor de propiedad predeterminado. Si el tipo de datos solicitado no coincide con
el tipo de datos de las propiedades, el valor se convierte, si es posible, al formato solicitado
al transferirlo al búfer de usuario pvProp.
Declaración
BOOL PDLRTGetDefPropEx(
ADRMODE adrMode,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
Parámetros
adrMode
que editar.
PDLRT_AM_DEFAULT 0 El direccionamiento de la imagen y el objeto es relativo


lpszPictureName
definido con adrMode. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
con adrMode .

lpszPropName
Puntero al nombre de la propiedad del objeto configurado.
vt
Tipo de datos del valor transmitido con pvProp. Los tipos permitidos son definidos en los
archivos de inclusión "oaidl.h" y "wtypes.h" pertenecientes al compilador. Para scripts se
puede utilizar el archivo de inclusión de WinCC APLIB\Defines.h .
pvProp
Puntero a una variable en la que se almacena el valor de la propiedad. El tipo de datos del
valor se determina con vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
VT_xxxx pvProp debe apuntar a un búfer
En los tipos con búfer (p. ej., BSTR) el búfer es asignado por la función y debe volver a ser
liberado por la aplicación que realiza la llamada.
pfn
o no.
pvUser
dwFlags
por 0.
pData
pError

Valor de retorno
TRUE
Valores predeterminados de la propiedad del objeto determinados.
FALSE
Error.
Observaciones
Para volver a liberar áreas de memoria asignadas, utilice en el caso de VT_BSTR la función
API de Windows SysFreeString(...) y en el caso de VT_LPSTR y VT_LPWSTR la función API
de Windows LocalFree(...).
Mensajes de error
PDLRT_NO_PROP Propiedad no encontrada

Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Consulte también
3.3.5.2 PDLRTGetPropEx (RT Professional)
Utilización
Solicitan una valor actual de la propiedad. El origen se determina con lpszPictureName,
lpszObjectName y lpszPropName.
Si el tipo de datos solicitado no coincide con el tipo de datos de la propiedad, el valor se
convierte, si es posible, al formato solicitado al transferirlo al búfer de usuario pvProp.

Declaración
BOOL PDLRTGetPropEx(
ADRMODE adrMode,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
Parámetros
adrMode
que editar.
PDLRT_AM_DEFAULT 0 El direccionamiento de la imagen y el objeto es

relativo

lpszPictureName
lpszObjectName
con adrMode.
lpszPropName
vt

pvProp
Puntero a una variable en la que se almacena el valor de la propiedad. El tipo de datos del
valor se determina con vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
En los tipos con búfer (p. ej., BSTR) el búfer es asignado por la función y debe volver a ser
liberado por la aplicación que realiza la llamada.
pfn
o no.
pvUser
dwFlags
por 0.
pData
pError
Valor de retorno
TRUE
Propiedades de objeto determinadas.
FALSE
Error.

Observaciones
Para volver a liberar áreas de memoria asignadas, utilice en el caso de VT_BSTR la función
API de Windows SysFreeString(...) y en el caso de VT_LPSTR y VT_LPWSTR la función API
de Windows LocalFree(...).
No deben utilizarse VT_DISPATCH ni otras referencias, sólo los tipos normales y, como
máximo, un VT_VARIANT para una propiedad de matriz de tipo simple.
Mensajes de error

Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRTSetPropEx (Página 1961) Ajustar propiedad

Consulte también
PDLRTSetPropEx (Página 1961)
3.3.5.3 PDLRTSetPropEx (RT Professional)
Utilización
Ajustan una propiedad. El punto de destino se determina con lpszPictureName,
lpszObjectName y lpszPropName. Si el tipo de datos transmitido no coincide con el tipo de
datos de la propiedad, el valor se convierte, si es posible, al transferirlo a la propiedad.
Sólo se pueden establecer propiedades que también sean dinamizables.

Declaración
BOOL PDLRTSetPropEx(
ADRMODE adrMode,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
Parámetro
adrMode
que editar.
PDLRT_AM_DEFAULT 0 El direccionamiento de la imagen y el objeto es re‐

lativo

lpszPictureName
lpszObjectName
con adrMode.
lpszPropName
vt

pvProp
Puntero a un búfer en el que está almacenado el nuevo valor de la propiedad. El tipo de datos
del valor se determina con vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
pfn
o no.
pvUser
dwFlags
por 0.
pData
por NULL.
pError
Valor de retorno
TRUE
Propiedades de objeto activadas.
FALSE
Error.

Observaciones
No deben utilizarse VT_DISPATCH ni otras referencias, sólo los tipos normales y, como
máximo, un VT_VARIANT para una propiedad de matriz de tipo simple.
Mensajes de error

PDLRT_PICTURE_NOT_LOADED No se ha podido cargar el archivo de imagen
PDLRT_FAILURE_PARAM Parámetro erróneo
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
PDLRTGetPropEx (Página 1956) Consultar propiedad


Ejemplo
#pragma code("pdlrtapi.dll")
#define CP_ACP 0
#define MB_PRECOMPOSED 1
void ButtonRT(char* text)

{
DM_DIRECTORY_INFO dirInfo;
CMN_ERROR error;
BOOL bRet;
char szProjectFile[222] = "";
WCHAR wstring[99];
BSTR bstrval;
WORD *pw = NULL;
int i;
printf("Funktion 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");
}
Consulte también
PDLRTGetPropEx (Página 1956)

3.3.6 Funciones para editar dinámicas (RT Professional)
3.3.6.1 PDLRTGetLink (RT Professional)
Utilización
Pregunta a un enlace de una propiedad. Si la propiedad tiene una conexión de variable
indirecta, ésta se devuelve. Si en una conexión de variable indirecta se desea la conexión
directa actual, se puede solicitar indicando
LinkType = BUBRT_LT_VARIABLE_DIRECT en la estructura LINKINFO.
Declaración
BOOL PDLRTGetLink (
ADRMODE adrMode,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
que editar.
PDLRT_AM_DEFAULT o El direccionamiento de la imagen y el objeto es

relativo

lpszPictureName
lpszObjectName
con adrMode.
lpszPropName
Puntero al nombre de la propiedad del objeto.

pLink
Puntero a la estructura LINKINFO (Página 1926), en la que se almacena la información del
enlace.
pfn
o no.
pvUser
pError
Valor de retorno
TRUE
Enlace determinado.
FALSE
Error.
Mensajes de error
PDLRT_NO_LINK La propiedad no tiene dinamización
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll


Consulte también
LINKINFO (Página 1926)
3.3.6.2 PDLRTSetLink (RT Professional)
Utilización
Establece un enlace entre una propiedad y una variable.
Declaración
BOOL PDLRTSetLink (
ADRMODE adrMode,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
que editar.


lpszPictureName
lpszObjectName
con adrMode.

lpszPropName
Puntero al nombre de la propiedad del objeto.
pLink
Puntero a la estructura LINKINFO (Página 1926), en la que está almacenada la información
del enlace.
En LinkType sólo deben utilizarse BUBRT_LT_VARIABLE_DIRECT y
BUBRT_LT_VARIABLE_INDIRECT , ya que sólo se permiten enlaces con variables.
pfn
o no.
pvUser
pError
Valor de retorno
TRUE
Enlace activado
FALSE
Error
Mensajes de error
PDLRT_FAILURE_PARAM Parámetros erróneos

PDLRT_LINK_NOT_SET La propiedad no pudo conectarse
Archivos necesarios
pdlrtapi.h

pdlrt_s.lib
pdlrtapi.dll
PDLRTGetLink (Página 1964) Determinar enlace entre propiedad de objeto y variable

PDLRTSetMultiLink (Página 1970) Definir enlace entre propiedad de objeto y variable (varias va‐
riables)
Consulte también
LINKINFO (Página 1926)
3.3.6.3 PDLRTSetMultiLink (RT Professional)
Utilización
Establece varios enlaces entre una propiedad y variables.
Declaración
BOOL PDLRTSetMultiLink (
ADRMODE adrMode,
LPMULTILINK pMultiLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetros
adrMode
que editar.



lpszPictureName
pMultiLink
Puntero a la estructura MULTILINK (Página 1928), en la que está almacenado un campo con
información del enlace.
pfn
o no.
pvUser
Valor de retorno
TRUE
El valor de retorno TRUE sólo se proporciona si todos los enlaces han podido establecerse
correctamente. Si no ha podido establecerse solo un enlace, se devuelve FALSE.
FALSE
Error.
Mensajes de error
PDLRT_FAILURE_PARAM Parámetros erróneos

PDLRT_LINK_NOT_SET La propiedad no pudo conectarse
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib

3.4 Funciones del scripting (RT Professional)
pdlrtapi.dll

Consulte también
MULTILINK (Página 1928)
Sinopsis
AP_RT_PROC (Página 1988) Función de notificación de las funciones runtime

APActive (Página 1999) Activar acción
APCompile (Página 1991) Compilar código fuente
APCompileEx (Página 1993) Compilar código fuente
APConnect (Página 1983) Dar de alta aplicación
APDisconnect (Página 1985) Dar de baja aplicación
APEndAct (Página 2001) Dar de baja la acción del control de acciones
APFreeResultStruct (Página 2003) Habilitar memoria de resultados de acción
APInactive (Página 2004) Desactivar acciones
APSetLanguage (Página 1987) Definir el idioma de los textos de error
APStart (Página 2006) Iniciar acción
APTransact (Página 2008) Dar de alta acciones para su ejecución
GSCGenCompile (Página 1996) Compilar acción
GSCGenCompileUserFunctions (Pá‐ Compilar funciones de usuario
gina 1997)
GSCGenGetActionStream (Pági‐ Determinar stream de acción
na 1998)

Sinopsis
AP_ACT_KEY (Página 1977) Identificación de acción

AP_ACT_RESULT_STRUCT (Página 1979) Resultado de la acción
CREATE_USER_HEADER_FILE (Página 1980) Crear archivo de encabezado de funciones de
usuario
GENERATE_COMPILE (Página 1981) Crear acción
GET_ACTION_STREAM (Página 1982) Determinar stream de acción
Sinopsis
CMN_ERROR:
Mensajes de error generales
AP_ALREADY_CONNECTED 2 La aplicación ya se encuentra conectada al control

de acciones
AP_NO_CONNECTION 3 La aplicación no puede establecer ninguna cone‐
xión con el control de acciones.
AP_ERROR_IPC_SEND 4 Error en la comunicación con el control de accio‐
nes. No se ha podido lanzar la petición.
AP_FAILURE_UNKNOWN 5 Error sin descripción
AP_FAILURE_PARAM 6 Asignación incorrecta de parámetros
AP_NO_ACT_PROGRAM 7 No se ha podido iniciar el control de acciones
AP_TIMEOUT 8 Exceso de tiempo, por el momento no realizado.
AP_ACT_QUIT 9 Control de acciones finalizado
AP_INSTALL_SERV_ERROR 10 No se ha podido instalar el canal de servicio
AP_ENDACT_UNKNOWN_ORDER 11 Para EndAct se ha utilizado un número de petición
desconocido
AP_ACTION_FAILED 12 Una acción no se ha podido ejecutar sin errores.
Los datos de retorno no son válidos.
AP_FAILURE_IN_SERVER 13 El servidor notifica un error.
AP_TO_MANY_CLIENTS 14 Cantidad máxima de conexiones alcanzada. No se
pueden establecer conexiones nuevas.
AP_TRANSACTID_UNKNOWN 15 La ID de transacción no es válida. Se produce un
error en la llamada de AP_EndAct cuando se inten‐
ta finalizar una transacción que no se había dado
de alta antes.
AP_NO_MEMORY 16 No hay suficiente memoria disponible para esta
operación

AP_TRANSACT_ERROR 17 Se ha producido un error de acción en la transac‐

ción en dwerror de AP_ACT_KEY
AP_RESULT_TRANS_ERROR 18 Se ha producido un error en los resultados
AP_RESULT_START_ERROR 19 Se ha producido un error en los resultados
AP_NO_UPDATE_WRONG_FORMAT 50 Para el formato de datos no hay posibilidad de ac‐
tualización, la acción no contiene código de intér‐
prete.
AP_ERR_WRONG_FORMAT 202 La acción tiene un formato de datos erróneo.
AP_NO_VALID_FUNCTION_VALUE 203 El valor de retorno de la función no puede conver‐
tirse al tipo de datos VARIANT.
Error
que pueden producirse al ejecutar una acción
AP_CISS_ERR_EXIT_OVERFLOW 1001 En el intérprete de acciones se ha desbordado la

pila durante la ejecución. Se cancela la ejecución
de la acción.
AP_CISS_ERR_EXIT_DIVIDE0 1002 Al ejecutar una acción se ha producido una división
entre 0. La acción se cancela.
AP_CISS_ERR_EXIT_UNRESOLVED 1003 En la acción se ha referenciado un símbolo no exis‐
tente durante la ejecución.
AP_CISS_ERR_EXIT_GPF 1004 En la acción se ha accedido a una memoria no de‐
finida durante la ejecución.
AP_CISS_ERR_EXIT_BREAKPOINT 1005 El intérprete de acciones ha topado con un punto
de parada.
AP_CISS_ERR_EXIT_STEP 1006 El intérprete de acciones ha avanzado un paso de
ejecución en el depurador.
Avisos
del intérprete de acciones
AP_CISS_ERR_CREATE_PCH_FROM_PCH 8001 No es posible generar un archivo de

encabezado precompilado a partir
de otro archivo de encabezado pre‐
compilado.
AP_CISS_ERR_MODULE_IN_USE 8002 No es posible acceder a la acción. El
módulo se está utilizando en este
momento.
AP_CISS_ERR_INVALID_PROGRAM 8003 El programa no es válido.
AP_CISS_ERR_INVALID_MODULE 8004 La acción no es válida.
AP_CISS_ERR_CANNOT_CREATE_FILE 8005 El control de acciones no ha podido
crear el archivo.
AP_CISS_ERR_CANNOT_NO_MEMORY 8006 El intérprete de acciones no dispone
de suficiente memoria.
AP_CISS_ERR_INVALID_FILE_FORMAT 8007 El formato de archivo no es válido
para el control de acciones.

AP_CISS_ERR_CANNOT_OPEN_FILE 8008 El control de acciones no ha podido

abrir el archivo.
AP_CISS_ERR_PROGRAM_IS_LOCKED 8009 El programa está bloqueado en este
momento por el control de acciones.
AP_CISS_ERR_MODULE_ALREADY_INSERTED 8010 La acción ya ha sido entregada al
control de acciones para su procesa‐
miento.
AP_CISS_ERR_CONFLICT_WITH_OTHER 8011 En la acción se ha producido un con‐
flicto con otra acción.
AP_CISS_ERR_MODULE_NOT_FOUND 8013 El control de acciones no ha encon‐
trado la acción.
AP_CISS_ERR_FUNCTION_NOT_FOUND 8014 El control de acciones no ha encon‐
trado la función.
AP_CISS_ERR_INVALID_LINE 8015 La información de filas indicada no
es válida.
AP_CISS_ERR_INVALID_SCOPE 8016 El símbolo indicado se encuentra
fuera del rango de validez.
AP_CISS_ERR_BUFFER_TOO_SMALL 8017 La memoria transferida es demasia‐
do pequeña para el intérprete de ac‐
ciones.
AP_CISS_ERR_INVALID_TYPE 8018 El tipo indicado es desconocido para
el intérprete de acciones.
AP_CISS_ERR_SYMBOL_NOT_FOUND 8019 El símbolo indicado no se ha encon‐
trado.
Notify Codes
AP_NOTIFY_ERROR 0 Se ha producido un error al ejecutar la función.

AP_NOTIFY_DATA 1 No se ha producido ningún un error al ejecutar la
función.
AP_NOTIFY_CODE_TRANSACT 1 Confirmación de una llamada AP_TransAct
AP_NOTIFY_CODE_START 2 Confirmación de una llamada AP_Start
AP_NOTIFY_CODE_RESULT 3 Resultado de una acción
AP_NOTIFY_CODE_DISCONNECT 6 Confirmación de una llamada APDisconnect
AP_NOTIFY_CODE_ENDACT 7 Confirmación de una llamada AP_EndAct
AP_NOTIFY_CODE_ACTIVE 8 Confirmación de una llamada AP_Active
AP_NOTIFY_CODE_INACTIVE 9 Confirmación de una llamada AP_Inactive
AP_NOTIFY_ERROR_SERVER_QUITT 10 Notificación de que el control de acciones ha fina‐
lizado.
AP_NOTIFY_CODE_TRANSRESULT 11 Notificación de un resultado erróneo, llamada de
un APTransAct
AP_NOTIFY_CODE_STARTRESULT 12 Notificación de un resultado erróneo, llamada de
un APStart
AP_NOTIFY_CODE_RESULT_RT 13 Notificación de resultados cíclicos de una llamada
optimizada

Identificador de función o acción
GSC_AP_SFCT 0x00000011 Función estándar

GSC_AP_PFCT 0x00000012 Función de proyecto
GSC_AP_GSC 0x00000014 Acción GSC
Valores límite
AP_MAX_TRIG_NAME 21 Longitud máxima del nombre de un disparador
Tipos de encabezados
CMHF_APDEFAP 0x00000001 Encabezado de una definición de proyecto

CMHF_AP_PBIB 0x00000002 Encabezado de una función de proyecto
CMHF_AP_GLOB 0x00000004 Encabezado de una función estándar
CMHF_AP_ICF 0x00000008 Encabezado de una función interna
CMHF_AP_ALL CMHF_APDEFAP |
CMHF_AP_PBIB |
CMHF_AP_GLOB |
CMHF_AP_ICF
CMHF_AP_USER 0x00000010 Encabezado de una función de usuario
Tipos de disparadores
AP_TRIG_UNDEFINED 0 El disparador aún no está inicializado.

AP_TRIG_VAR 1 El disparador es una variable.
AP_TRIG_TIMER 2 El disparador es un temporizador.
AP_TRIG_UNKNOWN 3 El disparador es desconocido.
AP_TRIG_TRANSACT 4 El disparador se especifica con una llamada TransAct.
Tipos de ciclos
AP_TRIG_CYCLE 1 Cíclico
AP_TRIG_NCYCLE 2 Acíclico
Tiempos de ciclo
AP_TRIG_CYCLE_01 1 En el Control Center equivale al tiempo de ciclo de 250 ms

AP_TRIG_CYCLE_02 2 En el Control Center equivale al tiempo de ciclo de 500 ms
AP_TRIG_CYCLE_03 3 En el Control Center equivale al tiempo de ciclo de 1 s

AP_TRIG_CYCLE_05 5 En el Control Center equivale al tiempo de ciclo s

AP_TRIG_CYCLE_07 7 En el Control Center equivale al tiempo de ciclo 1 min
AP_TRIG_CYCLE_10 10 En el Control Center equivale al tiempo de ciclo de 1 h
AP_TRIG_CYCLE_11 11 En el Control Center equivale al tiempo de ciclo "Definido por usuario
1"
2"
3"
4"
5"
3.4.2.1 AP_ACT_KEY (RT Professional)
Declaración
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
El tipo de clave determina si la acción se direcciona a través de un nombre (szActionName)
o una ID (dwID).
AP_ID_TYPE 0 Identificación de la acción a través de su ID

AP_NAME_TYPE 1 Identificación de la acción a través de su nombre

Las funciones estándar y de proyecto ya existentes en el proyecto WinCC se identifican a

través del nombre. Las funciones definidas por el usuario que se notifican sólo con la función
APTransAct se identifican mediante ID.
dwID
La acción se inicia con dwID en combinación con dwKeyType = AP_ID_TYPE.
El Id de la acción se otorga al llamar la función APTransAct. Al llamar la función APTransAct
se debe preasignar dwID con 0.
szActionName
La acción se inicia mediante szActionName en combinación con dwKeyType =
AP_NAME_TYPE.
Se puede emplear al iniciar una acción con APStart.
dwCycle
Inicio cíclico de la acción cuando se direcciona por nombre. El ciclo de actualización se define
con el índice de las entradas de la lista de ciclos de actualización.
pVariant
Puntero al campo del tipo de datos VARIANT que describe los parámetros de la acción. Se
soportan los siguientes tipos de datos como 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
Las descripciones de parámetros de las acciones y del resultado de retorno sólo son posibles
en la forma del tipo de datos VARIANT.
No se permite una entrega como referencia.
dwVariantItem
Cantidad de tipos de datos VARIANT que la acción contiene a modo de parámetros.
dwerror
Número de error que puede surgir en el APTransAct.

lpvUser
Descripción
La estructura AP_ACT_KEY identifica la acción de manera unívoca. Con la llamada API
APTransAct se otorga esta clave como ID. La acción se inicia con esta clave.
Archivos necesarios
ap_def.h
Funciones API

Consulte también
APActive (Página 1999)
APInactive (Página 2004)
APStart (Página 2006)
APTransact (Página 2008)
3.4.2.2 AP_ACT_RESULT_STRUCT (RT Professional)
Declaración
typedef struct {
VARIANT *ap_result;
AP_ACT_KEY apActKey;
CMN_ERROR error;
DWORD dwreserved;
} AP_ACT_RESULT_STRUCT ;
Members
*ap_result
Resultado de retorno de la acción en forma de un tipo de datos VARIANT.

apActKey
Clave de la acción para identificación. AP_ACT_KEY representa la clave con la que se ha
iniciado la acción.
error
dwreserved
por 0.
Archivos necesarios
ap_def.h
Funciones API
APFreeResultStruct (Página 2003) Habilitar memoria de resultados de acción

Consulte también
APFreeResultStruct (Página 2003)
3.4.2.3 CREATE_USER_HEADER_FILE (RT Professional)
Declaración
typedef struct {
char* pszStartDir;
char* pszHeaderFileName;
BOOL bShowDlg;
char* pszWindowText;
} CREATE_USER_HEADER_FILE ;
Members
pszStartDir
Puntero al directorio de inicio, a partir del cual se buscan las funciones de usuario con
terminación "\"

pszHeaderFileName
Puntero al nombre del Header-File.
bShowDlg
Mostrar diálogo con indicación de progreso
pszWindowText
Puntero al título del diálogo. Default:BROWSER
Archivos necesarios
capigsc.h
Funciones API
GSCGenCompileUserFunctions (Página 1997) Compilar funciones de usuario
Consulte también
GSCGenCompileUserFunctions (Página 1997)
3.4.2.4 GENERATE_COMPILE (RT Professional)
Declaración
typedef struct {
char* pszProjectName;
LPACTION pAction;
} GENERATE_COMPILE ;
Members
pszProjectName
Puntero al nombre del proyecto
pAction
Puntero a stream de acción válido con source code
Archivos necesarios
capigsc.h

GSCGenCompile (Página 1996) Compilar acción
Consulte también
GSCGenCompile (Página 1996)
3.4.2.5 GET_ACTION_STREAM (RT Professional)
Declaración
typedef struct {
char* pszPathName;
DWORD dwType;
} GET_ACTION_STREAM, *LPGET_ACTION_STREAM ;
Members
pszPathName
Nombre completo del archivo de la función o acción.
dwType
Tipos admitidos:
GSC_AP_SFCT Función estándar

GSC_AP_PFCT Función de proyecto
GSC_AP_GSC Acción
Archivos necesarios
capigsc.h
Funciones API
GSCGenGetActionStream (Página 1998) Determinar stream de acción
Consulte también
GSCGenGetActionStream (Página 1998)

3.4.3.1 APConnect (RT Professional)
Descripción
La función notifica una aplicación en el control de la acción. Si se especifica en fpAppBack
una función callback, ésta se ejecuta de manera asíncrona, en fpAppBack == NULL la función
se ejecuta de manera sincrónica.
Declaración
BOOL APConnect (
LPCSTR lpszAppName,
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetros
lpszAppName
Nombre de la aplicación con la que se ha registrado en DMConnect. Por ello, no se requiere
un DMConnect previo. APConnect se ejecuta únicamente de manera sincrónica.
Si se llaman funciones de la programación script en acciones, se debe especificar para
lpszAppName el valor "AktSteu" (la sintaxis debe ser exacta), porque la tarea WinCC ha
ejecutado DMConnect con este nombre.
fpAppBack
Su función Callback, la cual recibe las notificaciones. Por ejemplo, la notificación de
finalización del controlador de la acción se notifica a través de esta función.
Si un programa notifica una rutina Notify, deberá vaciar periódicamente su Message Queue.
WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
lpvUser
Si no se utiliza lpvUser se deberá ocupar con NULL.

pError
Valor de retorno
TRUE
Aplicación registrada
FALSE
Error
Mensajes de error
AP_NO_ERROR No ha ocurrido ningún error

AP_NO_CONNECTION La aplicación no puede establecer ninguna conexión con el con‐
trol de la acción.
AP_ERROR_IPC_SEND Error en la comunicación con el controlador de la acción. No se
ha podido ejecutar la peticion.
AP_TIMEOUT Exceso de tiempo, parámetro no utilizado por el momento.
AP_ALREADY_CONNECTED La aplicación ya se encuentra conectada al controlador de la ac‐
ción
AP_FAILURE_PARAM Suministro incorrecto de parámetros
AP_TO_MANY_CLIENTS Cantidad máxima de conexiones alcanzada. No se pueden reali‐
zar conexiones nuevas.
AP_FAILURE_UNKNOWN Error sin descripción
AP_ACT_QUIT Controlador de la acción finalizado
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll

APDisconnect (Página 1985) Finalizar la conexión con el controlador de la ac‐
ción
APTransact (Página 2008) Registrar acción para su ejecución
AP_RT_PROC (Página 1988) Función Callback

Ejemplos
Establish connection to script programming (Página 2010) "AP01.cpp"
Consulte también
AP_RT_PROC (Página 1988)
APDisconnect (Página 1985)
Establish connection to script programming (Página 2010)
3.4.3.2 APDisconnect (RT Professional)
Descripción
La función da de baja una aplicación en el control de la acción.
Declaración
BOOL APDisconnect (
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetros
fpAppBack
Su función Callback, la cual recibe las notificaciones. Cuando se utiliza una función Callback,
la petición se realiza de forma asíncrona. Con fpAppBack == NULL se realizar de forma
sincrónica.
Si un programa registra una rutina Notify, deberá vaciar periódicamente su Message Queue.
WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica,

lpvUser
pError
Valor de retorno
TRUE
Aplicación dada de baja.
FALSE
Error
Comentario
Nota
La llamada no puede utilizarse en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a los mecanismos específicos de Microsoft puede producirse eventualmente un bloqueo de
la llamada y, en consecuencia, del programa.
Mensajes de error
AP_NO_ERROR No ha ocurrido ningún error

AP_NO_CONNECTION La aplicación no puede establecer ninguna conexión con el con‐
trol de la acción.
AP_ERROR_IPC_SEND Error en la comunicación con el controlador de la acción. No se
ha podido ejecutar la peticion.
AP_TIMEOUT Exceso de tiempo, parámetro no utilizado por el momento.
AP_ALREADY_CONNECTED La aplicación ya se encuentra conectada al controlador de la ac‐
ción
AP_FAILURE_PARAM Suministro incorrecto de parámetros
AP_TO_MANY_CLIENTS Cantidad máxima de conexiones alcanzada. No se pueden reali‐
zar conexiones nuevas.
AP_FAILURE_UNKNOWN Error sin descripción
AP_ACT_QUIT Controlador de la acción finalizado
Archivos necesarios
ap_def.h
apcli_S.lib

apclient.dll
APConnect (Página 1981) Establecer la conexión con el controlador de la

acción
APTransact (Página 2008) Registrar acción para su ejecución
Ejemplos
Consulte también
3.4.3.3 APSetLanguage (RT Professional)
Descripción
Esta función permite predeterminar el idioma en que se emiten los textos de error.
Declaración
BOOL APSetLanguage (
const DWORD dwLanguageID )
Parámetros
dwLanguageID
ID del idioma conforme al ajuste de idioma de Windows. Los textos de error se devuelven
conforme al idioma nuevamente ajustado. Si no se soporta el idioma se utilizará un idioma
por defecto.

Valor de retorno
TRUE
Idioma de los textos de error modificado
FALSE
Error
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll
Consulte también
3.4.3.4 AP_RT_PROC (RT Professional)
Descripción
Si la ejecución de funciones AP debe notificarse asíncronamente a la aplicación en Runtime,
es preciso prever funciones Callback del tipo AP_RT_PROC.
Esta función es utilizada por todas las funciones de la programación de acciones a modo de
función Callback.
Declaración
BOOL ( * AP_RT_PROC) (
DWORD dwAP_Notify,
WORD dwAP_NotifyCode,
DWORD dwError,
LPVOID lpvData,
DWORD dwItems,
DWORD dwOrderId,
LPVOID lpvUser );
Parámetros
dwAP_Notify
Describe el tipo de la función Callback. Valores posibles son AP_NOTIFY_ERROR y
AP_NOTIFY_DATA.

dwAP_NotifyCode
Si dwAP_Notify == AP_NOTIFY_ERROR, entonces lpvData señala a una estructura de tipo
CMN_ERROR con la descripción de error, y dwAP_NotifyCode es NULL.
Si dwAP_Notify == AP_NOTIFY_DATA, entonces dwAP_NotifyCode contiene una
especificación más detallada de la función Callback:
AP_NOTIFY_CODE_TRANSACT Confirmación de una llamada mediante APTransAct

AP_NOTIFY_CODE_START Confirmación de una llamada mediante APStart
AP_NOTIFY_CODE_RESULT Resultado de una acción
dwError
Número de error
lpvData
Puntero a datos puestos a disposición. La estructura de datos depende de dwAP_Notify y
dwAP_NotifyCode.
dwItems
Número de entradas en lpvData.
dwOrderId
Número de petición otorgado al llamar la función API.
lpvUser
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error

Comentario
Nota
En algunos casos excepcionales puede ocurrir que se devuelva la función Callback antes de
que retorne la llamada de función.
Archivos necesarios
ap_def.h

APConnect (Página 1981) Dar de alta aplicación
APDisconnect (Página 1983) Dar de baja aplicación
APEndAct (Página 2001) Dar de baja la acción del control de acciones
Ejemplos
Consulte también
APEndAct (Página 2001)


3.4.4 Funciones para editar Source Code (RT Professional)
3.4.4.1 APCompile (RT Professional)
Descripción
Se compila un código fuente guardado en lpvScode y se guarda como P-Code en lpvPcode.
La aplicación debe proporcionar la memoria para el P-Code.
Declaración
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 )
Parámetros
szProjectName
Cadena de caracteres que contiene una ruta de proyecto válida. A través de la ruta de proyecto
se decide qué Include y Precompiled Header deben utilizarse para la compilación.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. El número de petición debe ser
proporcionado por la instancia llamante.
lpvScode
Puntero al código fuente que compilar.
dwScodeSize
Tamaño del código fuente en bytes

lpvPcode
Dirección de un puntero que contiene el P-Code tras una compilación realizada con éxito. La
memoria es creada por la función APCompile y debe ser habilitada de nuevo por la instancia
llamante con la función APFreePCode.
dwPcodeSize
Después de la compilación contiene el tamaño del P-Code en bytes.
hwndLog
Handle de ventana, a través del cual se pueden emitir los mensajes de error. El handle de
ventana también puede ser NULL. Cuando se utiliza una ventana para salidas, se emite un
mensaje a través de la función de Windows WM_COPYDATA.
dwDebugFlag
Este Flag establece si el P-Code debe suministrar informaciones Debug (Bit1 = 1 ) o si no se
debe suministrar ninguna información Debug (Bit1 = 0 ). Normalmente se debe seleccionar
"0" por cuestiones de rendimiento.
Bit2 = 1: Utilizar los ajustes del servidor para Includes
Bit2 = 0: Utilizar ajustes locales para Includes
nErrors
Cantidad de errores producidos. En nErrors > 0 no se devuelve ningún P-Code.
nWarnings
Cantidad de advertencias producidas. En nWarnings > 0 también se genera el P-Code.
lpvUser
que vuelve a estar disponible en la función Callback-Funktion.
pError
Valor de retorno
TRUE
Código fuente compilado con éxito
FALSE
Error
Archivos necesarios
ap_def.h
apcli_S.lib

apclient.dll
APCompileEx (Página 1993) Compilar código fuente

APFreePCode Habilitar memoria de código fuente
Consulte también
APCompileEx (Página 1993)
3.4.4.2 APCompileEx (RT Professional)
Descripción
A diferencia de lo que ocurre con la función APCompile, el código fuente a compilar se
encuentra subdividido en secciones.
En el código fuente void function {instrucciones} se subdivide en
void function { Inicio de la instrucción

Instrucciones Tronco
} Fin la instrucción
Se compila un código fuente en las secciones lpvScodeProlog, lpvScodeBase y

lpvScodeEpilog y se guarda como P-Code en lpvPcode. La aplicación debe proporcionar la
memoria para el P-Code.
Declaración
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 )

Parámetros
szProjectName
pdwOrderId
szProjectName
pdwOrderId
lpvScodeProlog
Puntero al Prolog del código fuente que se va a compilar.
dwScodePrologSize
Tamaño del Prolog en bytes
lpvScodeBase
Puntero al tronco del código fuente que se va a compilar.
dwScodeBaseSize
Tamaño del tronco en bytes.
lpvScodeEpilog
Puntero al Epilog del código fuente que se va a compilar.
dwScodeEpilogSize
Tamaño del Epilog en bytes
lpvPcode
Dirección de un puntero que contiene el P-Code tras una compilación realizada con éxito. La
memoria es creada por la función APCompile y debe ser habilitada de nuevo por la instancia
llamante con la función APFreePCode.
dwPcodeSize
Después de la compilación contiene el tamaño del P-Code en bytes.
hwndLog
Handle de ventana, a través del cual se pueden emitir los mensajes de error. El handle de
ventana también puede ser NULL. Cuando se utiliza una ventana para salidas, se emite un
mensaje a través de la función de Windows WM_COPYDATA.

dwDebugFlag
Este Flag establece si el P-Code debe suministrar informaciones Debug (Bit1 = 1 ) o si no se
debe suministrar ninguna información Debug (Bit1 = 0 ). Normalmente se debe seleccionar
"0" por cuestiones de rendimiento.
Bit2 = 1: Utilizar los ajustes del servidor para Includes
Bit2 = 0: Utilizar ajustes locales para Includes
nErrors
Cantidad de errores producidos. En nErrors > 0 no se devuelve ningún P-Code.
nWarnings
Cantidad de advertencias producidas. En nWarnings > 0 también se genera el P-Code.
lpvUser
que vuelve a estar disponible en la función Callback-Funktion.
pError
Valor de retorno
TRUE
Código fuente compilado con éxito
FALSE
Error
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll
APCompile (Página 1989) Compilar código fuente

APFreePCode Habilitar memoria de código fuente
Consulte también
APCompile (Página 1989)

3.4.4.3 GSCGenCompile (RT Professional)
Descripción
La función compila una acción.
Declaración
LPACTION GSCGenCompile(
LPGENERATE_COMPILE lpGenCompile,
HWND hWndParent,
unsigned long* plErrors,
unsigned long* plWarnings,
AllocAppMem lpfnAllocAppMem,
LPCMN_ERROR lpdmError)
Parámetros
lpGenCompile
Puntero a la estructura GENERATE_COMPILE (Página 1979).
hWndParent
Handle en la ventana donde se ejecutarán las salidas de estado.
plErrors
Puntero a la variable para retorno del número de errores
plWarnings
Puntero a la variable para retorno del número de advertencias
lpfnAllocAppMem
Puntero a una función con la cual se asigna memoria en la aplicación llamante.
lpdmError
Valor de retorno
Puntero al stream de acción compilado. También se genera un stream de acción si la
compilación es defectuosa. La realización de la llamada se debe verificar a través del número
de errores y advertencias.
Comentario
La acción compilada está disponible después de iniciar nuevamente Runtime.

Archivos necesarios
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
GENERATE_COMPILE (Página 1979)
3.4.4.4 GSCGenCompileUserFunctions (RT Professional)
Descripción
La función compila nuevamente todas las funciones especiales de usuario.
Declaración
BOOL GSCGenCompileUserFunctions (
LPCREATE_USER_HEADER_FILE pGenCUHF,
HWND hWndParent,
Parámetros
pGenCUHF
Puntero a la estructura CREATE_USER_HEADER_FILE (Página 1978).
hWndParent
Handle en la ventana donde se ejecutarán las salidas de estado.
lpdmError
Valor de retorno
TRUE
Funciones de usuario compiladas
FALSE
Error

Comentario
Por motivos internos, esta función siempre devuelve FALSE sin mensaje de error, a pesar de
que se generan las funciones.
Las funciones de usuario compiladas están disponible después de iniciar nuevamente
Runtime.
Archivos necesarios
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
CREATE_USER_HEADER_FILE (Página 1978)
3.4.5 Funciones para editar acciones (RT Professional)
3.4.5.1 GSCGenGetActionStream (RT Professional)
Descripción
La función determina el stream de acción para una función de proyecto, una función estándar
o una acción.
Declaración
LPACTION GSCGenGetActionStream(
LPGET_ACTION_STREAM pGenGAS,
AllocAppMem lpfnAllocAppMem,
Parámetros
pGenGAS
Puntero en una estructura de tipo GET_ACTION_STREAM (Página 1980), mediante la que
se especifica la función o acción.
lpfnAllocAppMem
Puntero a una función con la cual se asigna memoria en la aplicación llamante.

lpdmError
Valor de retorno
Puntero al stream de acción.
Archivos necesarios
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
GET_ACTION_STREAM (Página 1980)
3.4.6 Funciones de la programación de acción (RT Professional)
3.4.6.1 APActive (RT Professional)
Descripción
Las acciones desactivadas con APInactive se pueden volver a activar con esta función, es
decir, los disparadores correspondientes se vuelven a supervisar o se pueden volver a iniciar
con APStart.
Declaración
BOOL APActive (
PAP_ACT_KEY lpapActKey,
const DWORD dwItems,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )

Parámetros
lpapActKey
Puntero a una estructura de datos con la siguiente estructura:
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ
La estructura de datos debe ser proporcionada por la aplicación llamante.

Las acciones se deben registrar previamente con APTransAct. El ID en AP_ACT_KEY decide
si se debe iniciar la acción a través del ID o el nombre.
dwItems
Número de acciones, es decir, de estructuras AP_ACT_KEY (Página 1975).
fpAppBack
Su función Callback para la llamada asíncrona. Cuando se utiliza con NULL, la llamada se
ejecuta de forma sincrónica.
WinCC.
pdwOrderId
lpvUser
pError
Valor de retorno
TRUE
Acción activada.

FALSE
Error.
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll

APTransact (Página 2008) Registrar una acción para su ejecución
Consulte también
AP_ACT_KEY (Página 1975)
3.4.6.2 APEndAct (RT Professional)
Descripción
La acción registrada para su ejecución se da de baja en el controlador de acción.
Declaración
BOOL APEndAct (
PDWORD pdwOrderId,
const PDWORD pdwOrderEnd,
LPCVOID lpvUser,
PCMN_ERROR pError )

Parámetros
fpAppBack
WinCC.
pdwOrderId
pdwOrderEnd
Número de petición de la transacción que se debe finalizar.
lpvUser
pError
Valor de retorno
TRUE
Acción dada de baja.
FALSE
Error.
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll


Consulte también
3.4.6.3 APFreeResultStruct (RT Professional)
Descripción
En la llamada sincrónica de la función APStart los resultados de acción se asignan en forma
de Array de estructuras tipo AP_ACT_RESULT_STRUCT. La memoria asignada por APStart
se debe habilitar nuevamente con la funciónAPFreeResultStruct.
Declaración
BOOL APFreeResultStruct (
PAP_ACT_RESULT_STRUCT *lpapars,
const DWORD dwItems )
Parámetros
lpvPcode
Puntero a la primera de las estructuras dwItem del tipo AP_ACT_RESULT_STRUCT
(Página 1977).
dwItems
Número de estructuras AP_ACT_RESULT_STRUCT.
Valor de retorno
TRUE
Memoria habilitada.
FALSE
Error.
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll

APStart (Página 2006) Ejecución de la acción iniciada
Consulte también
AP_ACT_RESULT_STRUCT (Página 1977)
3.4.6.4 APInactive (RT Professional)
Descripción
Las acciones registradas con APTransAct se pueden desactivar con APInactive. Los
disparadores correspondientes se dejan de supervisar y las acciones no se pueden iniciar con
APStart. Las acciones se pueden activar nuevamente con APActive.
Declaración
BOOL APInactive (
PAP_ACT_KEY lpActKey,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetros
lpapActKey
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ


dwItems
fpAppBack
WinCC.
pdwOrderId
lpvUser
pError
Valor de retorno
TRUE
Acción desactivada.
FALSE
Error.
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll
APActive (Página 1997) Activar acciones


Consulte también
3.4.6.5 APStart (RT Professional)
Descripción
Las acciones se inician para su ejecución. Es posible ejecutar varias acciones
simultáneamente. Las acciones se describen en la estructura AP_ACT_KEY.
Declaración
BOOL APStart (
AP_ACT_KEY lpapActKey,
AP_RT_PROC fpAppResult,
PDWORD pdwOrderId,
PAP_ACT_RESULT_STRUCT *lpapars,
LPCVOID lpUser,
PCMN_ERROR pError )
Parámetros
lpapActKey
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ


dwItems
fpAppBack
WinCC.
fAppResult
Su función Callback para resultados de acción de ejecución cíclica. En la función Callback se
devuelven las estructuras del tipo AP_ACT_RESULT_STRUCT (Página 1977). En una
llamada sincrónica, lpapars se ocupa con el resultado.
pdwOrderId
lpapars
Puntero al resultado de acción en una llamada sincrónica. Conforme al número de acciones
iniciadas se devuelve una matriz de estructuras del tipo AP_ACT_RESULT_STRUCT
(Página 1977). La memoria es asignada por la función y se debe habilitar nuevamente con
APFreeResultStruct.
En una utilización asíncrona es lpapars = NULL
lpvUser
pError
Valor de retorno
TRUE
Acción iniciada
FALSE
Error.

Comentario
Con APStart se pueden iniciar únicamente acciones no desactivadas previamente con
APInactive.
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll
APFreeResultStruct (Página 2001) Liberar memoria

Consulte también
APFreeResultStruct (Página 2001)
AP_ACT_RESULT_STRUCT (Página 1977)
3.4.6.6 APTransact (RT Professional)
Utilización
Declaración
Parámetro
xxx
xxx

lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
Valor de retorno
TRUE
.
FALSE
Error.
Observación
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Ejemplos
Auto-Hotspot "DM01.cpp"
Consulte también
APEndAct (Página 1999)

3.4.7.1 Establish connection to script programming (RT Professional)
Vista general

// =====================================================================
// Filename:.......... ap01.c
// =====================================================================
// : Modul with examples of AP_API
// *********************************************************************
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
// *********************************************************************
#include "stdafx.h"
#include "ap01.h" // if console application
//{{ODK_EXAMPLE}Establish connection to script programming (AP)}

//{{FUNCTION}APConnect (AP)}
//{{FUNCTION}APDisconnect (AP)}
//{{FUNCTION}AP_RT_PROC (AP)}
//{{FUNCTION}(END)}
// Establish connection to script programming (AP)
// =====================================================================
// Function: AprConnect(void) ODK AP CS
// =====================================================================
// short : Establish connection to script programming
// :
// =====================================================================
BOOL MyAPRTCallback(DWORD dwAP_Notify, DWORD dwAP_NotifyCode, DWORD dwError,
LPVOID lpvData, DWORD dwItems, DWORD dwOrderID, LPVOID lpvUser)
{
lpvUser;
dwOrderID;
lpvData;
TCHAR szText[255];
_sntprintf_s( szText,_countof(szText), _TRUNCATE, _T("AprNotCon:: AP= %d ;
dwAP_Notify, dwAP_NotifyCode, dwError, dwItems);
ODKTrace(szText);
return(TRUE );
}
void MyApConnect(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret= FALSE;
DWORD dwOrderID = 0;
TCHAR szApp[255];
VOID* pUser = NULL;
_tcsncpy_s(szApp, _countof(szApp), _T("MyODKApp_23"), _TRUNCATE); // must be the same
AppName as by DMConnect
ret = APConnect(szApp, MyAPRTCallback, &dwOrderID, pUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in APConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{

3.5 Funciones de la administración de usuarios (RT Professional)
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("APConnect"));

}
ODKTrace(szText);
//printf("%s\r\n"szText);
void MyAPDisconnect()
VOID* pUser = NULL;
CMN_ERROR Error;
TCHAR szText[255];
BOOL ret = FALSE;
DWORD dwOrderID = 0;
ret = APDisconnect(NULL, &dwOrderID, pUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in APDisconnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("APDisconnect"));
}
ODKTrace(szText);
}
// --------------------------------------------------------------------
Consulte también
Sinopsis
PWGEN_ENUM_GROUPS_CALLBACK (Pági‐ Listar grupos de usuarios (Callback)

na 2034)
PWGEN_ENUM_LEVELS_CALLBACK (Pági‐ Listar niveles de autorización (Callback)
na 2041)

PWGEN_ENUM_USERS_CALLBACK (Pági‐ Listar usuarios (Callback)

na 2030)
PWGENAddGroup (Página 2031) Crear un grupo de usuarios
PWGENAddPermLevel (Página 2036) Crear nivel de autorización
PWGENAddUser (Página 2021) Crear un usuario
PWGENAddUserEx (Página 2022) Crear un usuario
PWGENChangePassword (Página 2024) Cambiar la contraseña
PWGENCheckPermission (Página 2037) Comprobar las autorizaciones de un usuario
PWGENCheckUser (Página 2026) Comprobar usuario
PWGENConnect (Página 2018) Establecer conexión con la base de datos
PWGENDeletePermLevel (Página 2038) Borrar nivel de autorización
PWGENDeleteUser (Página 2027) Borrar usuario o grupo de usuarios
PWGENDisconnect (Página 2019) Deshacer conexión con la base de datos
PWGENEnumGroups (Página 2033) Listar grupos de usuarios
PWGENEnumPermLevels (Página 2040) Listar niveles de autorización
PWGENEnumUsers (Página 2028) Listar usuarios
PWGENReadUserPerm (Página 2042) Determinar autorizaciones de usuario
PWRTCheckPermission (Página 2044) Comprobar autorización de área
PWRTCheckPermissionOnPicture (Página 2045) Comprobar nivel de autorización
PWRTGetCurrentUser (Página 2049) Determinar nombre de usuario
PWRTGetLoginPriority (Página 2050) GetLoginPriority
PWRTIsLoggedInByCard (Página 2051) Inicio de sesión con tarjeta inteligente
PWRTLogin (Página 2052) Inicio de sesión con diálogo
PWRTLogout (Página 2054) Cerrar sesión
PWRTLogoutEx (Página 2055) Cerrar sesión
PWRTPermissionLevelDialog (Página 2046) Seleccionar nivel de autorización
PWRTPermissionLevelDialogEx (Página 2047) Seleccionar nivel de autorización
PWRTPermissionToString (Página 2048) Determinar descripción textual del nivel de autori‐
zación
PWRTSilentLogin (Página 2056) Inicio de sesión
PWRTSilentLoginEx (Página 2057) Inicio de sesión
Sinopsis
PWGEN_GROUPINFO (Página 2015) Información de grupos de usuarios

PWGEN_LEVELINFO (Página 2016) Información de niveles de autorización
PWGEN_USERINFO (Página 2017) Información de usuarios

Sinopsis
CMN_ERROR:
Mensajes de error para RT:
PWRT_CAP_SHMERROR 1 Error de memoria compartida

PWRT_CAP_NOLOGIN 2 Ningún usuario ha iniciado sesión.
PWRT_CAP_NOPERM 3 El usuario no dispone de autorización.
PWRT_CAP_NOAREA 4 No se ha podido encontrar el área.
PWRT_GPA_SHMERROR 1 Error de memoria compartida
PWRT_GPA_NOLOGIN 2 Ningún usuario ha iniciado sesión.
Mensajes de error para CS a partir de V5.0:
PWGEN_API_ERR_SUPPLY 0x10000001L Ha ocurrido un error no especificado con

exactitud.
PWGEN_API_NO_MEMORY 0x10000001L No hay suficiente memoria disponible.
PWGEN_API_NOT_SUPPORTED 0x10000003L Esta función no es soportada.
PWGEN_API_INVALID_PARAM 0x10000004L No coincide o falta un parámetro de función.
PWGEN_API_NO_INTERFACE 0x10000005L No hay conexión con UserAdminASO-Inter‐
face.
PWGEN_API_I_ENUM 0x10000006L Error al enumerar
PWGEN_API_I_READ 0x10000007L Error al leer
PWGEN_API_I_CREATE 0x10000008L Error al crear nuevos datos
PWGEN_API_I_MODIFY 0x10000009L Error al modificar datos
PWGEN_API_I_DELETE 0x1000000AL Error al borrar datos
PWGEN_API_TERMINATED 0x1000000FL La ejecución se ha interrumpido antes de
tiempo.
PWGEN_API_NO_CONNECTION 0x10000010L No se ha realizado ningún PWGENConnect.
PWGEN_API_IS_CONNECTED 0x10000011L Ya se ha realizado PWGENConnect.
PWGEN_API_NO_USER 0x10000020L No se ha encontrado el usuario
PWGEN_API_MAX_USER 0x10000021L Se ha alcanzado el número máximo de
usuarios (~ 128).
PWGEN_API_EXIST_USER 0x10000022L El usuario seleccionado ya existe.
PWGEN_API_NO_GROUP 0x10000030L No se ha encontrado el grupo de usuarios.
PWGEN_API_MAX_GROUP 0x10000031L Se ha alcanzado el número máximo de gru‐
pos de usuarios (~ 10).
PWGEN_API_EXIST_GROUP 0x10000032L El grupo de usuarios seleccionado ya existe.
PWGEN_API_NO_LEVEL 0x10000040L No se ha encontrado el nivel de autoriza‐
ción.

PWGEN_API_MAX_LEVEL 0x10000041L Se ha alcanzado el número máximo de ni‐

veles de autorización (~ 1000).
PWGEN_API_EXIST_LEVEL 0x10000042L El nivel de autorización seleccionado ya
existe.
PWGEN_API_NO_PERM 0x10000050L No se ha asignado ninguna autorización.
PWGEN_API_MAX_PERM 0x10000051L Se ha alcanzado el número máximo de per‐
misos.
PWGEN_API_EXIST_PERM 0x10000052L La autorización ya existe.
PWGEN_API_NO_AREA 0x10000060L No se ha asignado ningún área.
PWGEN_API_MAX_AREA 0x10000061L Se ha alcanzado el número máximo de
áreas (~ 32).
PWGEN_API_EXIST_AREA 0x10000062L El área ya existe.
PWGEN_API_NO_PASSWORD 0x10000070L No hay contraseña o no es válida.
PWGEN_API_MAX_PASSWORD 0x10000071L Se ha alcanzado el número máximo de con‐
traseñas.
PWGEN_API_EXIST_PASSWORD 0x10000072L La contraseña ya está asignada.
Tamaños de cadena y matriz
MAX_LOGIN 25
MAX_PASS 25
MAX_LEVEL 70
3.5.2.1 PWGEN_GROUPINFO (RT Professional)
Declaración
typedef struct {
TCHAR name[MAX_LOGIN];
int expiration_time;
}
PWGEN_GROUPINFO;
Members
name
Nombre del grupo de usuarios

expiration_time
Tiempo de cierre de sesión automático en minutos
Archivos necesarios
usegenap.h
Funciones API
PWGEN_ENUM_GROUPS_CALLBACK (Pági‐ Listar grupos de usuarios

na 2034)
Consulte también
PWGEN_ENUM_GROUPS_CALLBACK (Página 2034)
3.5.2.2 PWGEN_LEVELINFO (RT Professional)
Declaración
typedef struct {
int levelNumber;
DWORD dwTextID;
}
PWGEN_LEVELINFO;
Members
levelNumber
Número de la autorización
dwTextID
ID con la que se identifica la descripción de la autorización.
Archivos necesarios
usegenap.h
Funciones API
PWGEN_ENUM_LEVELS_CALLBACK (Pági‐ Listar niveles de autorización

na 2041)

Consulte también
PWGEN_ENUM_LEVELS_CALLBACK (Página 2041)
3.5.2.3 PWGEN_USERINFO (RT Professional)
Declaración
typedef struct {
TCHAR login[MAX_LOGIN];
TCHAR group[MAX_LOGIN];
int expiration_time;
}
PWGEN_USERINFO;
Members
login
Nombre de inicio de sesión del usuario
group
Nombre del grupo al que pertenece el usuario
expiration_time
Tiempo de cierre de sesión automático en minutos
Archivos necesarios
usegenap.h
Funciones API
PWGEN_ENUM_USERS_CALLBACK (Pági‐ Listar usuarios

na 2030)
Consulte también
PWGEN_ENUM_USERS_CALLBACK (Página 2030)

3.5.3.1 PWGENConnect (RT Professional)
Descripción
La función registra la conexión con la base de datos del proyecto abierto actualmente.
Declaración
BOOL PWGENConnect (
LPCTSTR DSNName,
LPCMN_ERROR err)
Parámetros
DSNName
Nombre de fuente de datos del proyecto. El parámetro DSNName no se evaluará. Se puede
transmitir una cadena vacía, pero no CERO. Se utiliza siempre la base de datos del proyecto
abierto actualmente.
err
Valor de retorno
TRUE
Conexión registrada
FALSE
Errores
Comentario
Cada aplicación sólo puede ejecutar un Connect. En el caso de un Connect repetido se
devuelve el mensaje de error PWGEN_API_IS_CONNECTED.
Mensajes de error
PWGEN_API_INVALID_PARAM No coincide o falta un parámetro de función.

PWGEN_API_ERR_SUPPLY Ha ocurrido un error no especificado con exactitud.
PWGEN_API_NO_INTERFACE Sin conexión con la interfaz UserAdminASO.

PWGEN_API_NO_CONNECTION No se ha realizado ningún PWGENConnect.

PWGEN_API_IS_CONNECTED Ya se ha realizado PWGENConnect.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
PWGENDisconnect (Página 2019) Deshacer conexión con la base de datos
Consulte también
PWGENDisconnect (Página 2019)
3.5.3.2 PWGENDisconnect (RT Professional)
Descripción
La conexión con la base de datos del proyecto abierto actualmente se deshace de nuevo.
Declaración
BOOL PWGENDisconnect (
LPCMN_ERROR err)
Parámetros
err
Valor de retorno
TRUE
Conexión interrumpida

FALSE
Errores
Comentario
Antes de cerrar la aplicación se debe realizar un PWGENDisconnect, de lo contrario no se
autorizan más las interfaces UserAdminASO utilizadas internamente.
Nota
La llamada no se debe usar en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a mecanismos específicos de Microsoft esto puede llevar, si se diera el caso, al bloqueo de
la llamada y con ello al del programa.
Mensajes de error

Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
PWGENConnect (Página 2016) Registrar conexión con la base de datos.
Consulte también
PWGENConnect (Página 2016)

3.5.4 Funciones para editar usuarios (RT Professional)
3.5.4.1 PWGENAddUser (RT Professional)
Descripción
La función crea un nuevo usuario incluyendo una matriz de autorización de usuario vacía. Con
la función PWGENAddUserEx se pueden transmitir las autorizaciones del grupo al usuario
que va a crearse.
Declaración
BOOL PWGENAddUser (
LPCTSTR username,
LPCTSTR password,
LPCTSTR group,
int expiration_time,
LPCMN_ERROR error )
Parámetros
username
Nombre de inicio de sesión del nuevo usuario
password
Contraseña del usuario
group
Grupo en el que se debe añadir al usuario
expiration_time
Tiempo de cierre de sesión automático en minutos Si el expiration_time seleccionado está
fuera del rango admisible, se le asignará un 0.
error
Valor de retorno
TRUE
Usuario creado

FALSE
Errores
Mensajes de error

PWGEN_API_NO_MEMORY No hay suficiente memoria disponible.
PWGEN_API_I_ENUM Error al enumerar.
PWGEN_API_EXIST_USER El usuario seleccionado ya existe.
PWGEN_API_MAX_USER Se ha alcanzado el número máximo de usuarios (~ 128).
PWGEN_API_NO_GROUP No se ha encontrado el grupo de usuarios.
PWGEN_API_I_CREATE Error al crear nuevos datos.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
PWGENAddUserEx (Página 2022) Crear un usuario
Consulte también
PWGENAddUserEx (Página 2022)
3.5.4.2 PWGENAddUserEx (RT Professional)
Descripción
La función crea un nuevo usuario. En función del parámetro copy_group_protection se pueden
transmitir las autorizaciones del grupo al usuario que va a crearse.

Declaración
BOOL PWGENAddUserEx (
LPCTSTR username,
LPCTSTR password,
LPCTSTR group,
BOOL copy_group_permissions,
LPCMN_ERROR error )
Parámetros
username
Nombre de inicio de sesión del nuevo usuario
password
group
Grupo en el que se debe añadir al usuario
expiration_time
Tiempo de cierre de sesión automático en minutos Si el expiration_time seleccionado está
fuera del rango admisible, se le asignará un 0.
copy_group_permissions
Si copy_group_permission = TRUE, se transmitirán las autorizaciones de usuario del grupo
al nuevo usuario que va a crearse.
error
Valor de retorno
TRUE
Usuario creado
FALSE
Errores
Mensajes de error



PWGEN_API_MAX_USER Se ha alcanzado el número máximo de usuarios (~ 128).
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
PWGENAddUser (Página 2019) Crear un usuario
Consulte también
PWGENAddUser (Página 2019)
3.5.4.3 PWGENChangePassword (RT Professional)
Descripción
Con esta función se puede modificar la contraseña del usuario especificado con username.
Declaración
BOOL PWGENChangePassword (
LPCTSTR username,
LPCTSTR oldpassword,
LPCTSTR newpassword,
LPCMN_ERROR error )
Parámetros
username
Nombre de inicio de sesión del usuario

oldpassword
Contraseña antigua del usuario
newpassword
Contraseña nueva del usuario
error
Valor de retorno
TRUE
Contraseña modificada
FALSE
Errores
Mensajes de error

PWGEN_API_NO_PASSWORD No hay contraseña o no es válida.
PWGEN_API_NO_USER No se ha encontrado el usuario.
PWGEN_API_I_READ Error durante la lectura.
PWGEN_API_I_MODIFY Error al modificar datos.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también

3.5.4.4 PWGENCheckUser (RT Professional)
Descripción
Se comprueba si el usuario indicado existe en el proyecto WinCC actual y si la contraseña
facilitada es correcta.
Declaración
BOOL PWGENCheckUser (
LPCTSTR username,
LPCTSTR password,
LPCMN_ERROR error )
Parámetros
username
Nombre del usuario.
password
La contraseña que pertenece al usuario indicado.
error
Valor de retorno
TRUE
El usuario existe y la contraseña es correcta.
FALSE
Errores
Mensajes de error

PWGEN_API_NO_PASSWORD No hay contraseña o no es válida.

Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
3.5.4.5 PWGENDeleteUser (RT Professional)
Descripción
El usuario o grupo de usuarios indicado se borra incluyendo los datos de autorización.
Declaración
BOOL PWGENDeleteUser (
LPCTSTR username,
BOOL is_user,
LPCMN_ERROR error )
Parámetros
username
Nombre del usuario que debe borrarse.
is_user
El parámetro is_user sirve para diferenciar si debe borrarse un usuario o un grupo de usuarios.
TRUE Debe borrarse un usuario.

FALSE Debe borrarse un grupo de usuarios.
error
Valor de retorno
TRUE
Usuario o grupo de usuarios borrado

FALSE
Errores
Comentario
Cuando se intenta borrar el administrador, la función envía el error
PWGEN_API_EXIST_USER.
Mensajes de error

PWGEN_API_I_DELETE Error al borrar datos.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
3.5.4.6 PWGENEnumUsers (RT Professional)
Descripción
La función lee los usuarios configurados, para cada usuario llama a la función Callback y
devuelve el número de usuarios en dwCount.

Declaración
BOOL PWGENEnumUsers (
LPDWORD dwCount,
PWGEN_ENUM_USERS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error )
Parámetros
dwCount
Puntero a la posición de memoria en la que se debe almacenar el número de usuarios.
cfn
Su función Callback que acepta la información. Cuando cfn == NULL, sólo se cuentan los
usuarios.
userdata
error
Valor de retorno
TRUE
Listado de los usuarios
FALSE
Errores
Mensajes de error

Archivos necesarios
usegenap.h

usegen.lib
usegen.dll
PWGEN_ENUM_USERS_CALLBACK (Pági‐ Listar usuarios (Callback)

na 2030)
Consulte también
PWGEN_ENUM_USERS_CALLBACK (Página 2030)
3.5.4.7 PWGEN_ENUM_USERS_CALLBACK (RT Professional)
Descripción
Para poder evaluar la información de usuario listada por el sistema, es necesario preparar
una función Callback del tipo PWGEN_ENUM_USERS_CALLBACK.
Declaración
BOOL ( * PWGEN_ENUM_USERS_CALLBACK) (
LPWGEN_USERINFO lpUserInfo,
PVOID lpUser);
Parámetros
lpUserInfo
Puntero a una estructura del tipo PWGEN_USERINFO (Página 2015) con los datos de un
usuario.
lpUser
función Callback.
Valor de retorno
TRUE
Listado de los usuarios

FALSE
Error
Nota
Archivos necesarios
usegenap.h
PWGENEnumUsers (Página 2026) Listar usuarios
Consulte también
PWGENEnumUsers (Página 2026)
PWGEN_USERINFO (Página 2015)
3.5.5 Funciones para editar grupos de usuarios (RT Professional)
3.5.5.1 PWGENAddGroup (RT Professional)
Descripción
La función crea un nuevo grupo de usuarios incluyendo una matriz de autorización de usuario
vacía.
Declaración
BOOL PWGENAddGroup (
LPCTSTR username,
LPCMN_ERROR error )

Parámetros
username
Nombre del grupo que va a crearse
expiration_time
Tiempo de cierre de sesión automático. Si el expiration_time seleccionado está fuera del rango
admisible, se le asignará un 0.
error
Valor de retorno
TRUE
Grupo de usuarios creado
FALSE
El grupo de usuarios ya existe
Comentario
Para borrar un grupo de usuarios existente, utilice la función PWGENDeleteUser.
Mensajes de error

PWGEN_API_EXIST_GROUP El grupo de usuarios seleccionado ya existe.
PWGEN_API_MAX_GROUP Se ha alcanzado el número máximo de grupos de usuarios (~
10).
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll

PWGENDeleteUser (Página 2025) Crear un usuario
Consulte también
PWGENDeleteUser (Página 2025)
3.5.5.2 PWGENEnumGroups (RT Professional)
Descripción
La función lee los grupos de usuarios configurados, para cada grupo llama a la función
Callback y devuelve el número de grupos en dwCount.
Declaración
BOOL PWGENEnumGroups (
LPDWORD dwCount,
PWGEN_ENUM_GROUPS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error )
Parámetros
dwCount
Puntero a la posición de memoria en la que se debe almacenar el número de grupos de
usuarios.
cfn
Su función Callback que acepta la información. Cuando cfn == NULL, sólo se cuentan los
grupos de usuarios.
userdata
error

Valor de retorno
TRUE
Listado de los grupos de usuarios
FALSE
Errores
Mensajes de error

Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
PWGEN_ENUM_GROUPS_CALLBACK (Pági‐ Listar grupos de usuarios (Callback)

na 2034)
Consulte también
PWGEN_ENUM_GROUPS_CALLBACK (Página 2034)
3.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK (RT Professional)
Descripción
Para poder evaluar la información de grupos de usuarios listada por el sistema, es necesario
preparar una función Callback del tipo PWGEN_ENUM_GROUPS_CALLBACK.

Declaración
BOOL ( * PWGEN_ENUM_GROUPS_CALLBACK) (
LPWGEN_GROUPINFO lpGroupInfo,
PVOID lpUser);
Parámetros
lpUserInfo
Puntero a una estructura del tipo PWGEN_GROUPINFO (Página 2013) con los datos de un
usuario.
lpUser
función Callback.
Valor de retorno
TRUE
Listado de los grupos de usuarios
FALSE
Error
Nota
Archivos necesarios
usegenap.h
PWGENEnumGroups (Página 2031) Listar grupos de usuarios

Consulte también
PWGENEnumGroups (Página 2031)
PWGEN_GROUPINFO (Página 2013)
3.5.6 Funciones para editar autorizaciones (RT Professional)
3.5.6.1 PWGENAddPermLevel (RT Professional)
Descripción
Crea una nueva autorización para todos los usuarios.
Declaración
BOOL PWGENAddPermLevel (
DWORD txtID,
int number,
LPCMN_ERROR error )
Parámetros
txtID
ID del texto para la autorización.
number
Número de la autorización que va a crearse
error
Valor de retorno
TRUE
Nivel de autorización creado
FALSE
Errores

Mensajes de error

PWGEN_API_MAX_LEVEL Se ha alcanzado el número máximo de niveles de autorización
(1000).
PWGEN_API_EXIST_LEVEL El nivel de autorización seleccionado ya existe.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
3.5.6.2 PWGENCheckPermission (RT Professional)
Descripción
Con esta función se comprueba si el usuario posee las autorizaciones de uso para el nivel de
autorización indicado.
Declaración
BOOL PWGENCheckPermission(
LPCTSTR username,
DWORD permlevel,
LPCMN_ERROR error)
Parámetros
username
Nombre del usuario

permlevel
Número de la autorización que hay que comprobar
error
Valor de retorno
TRUE
La autorización de uso para el nivel de autorización del usuario existe.
FALSE
Errores
Mensajes de error

PWGEN_API_NO_LEVEL No se ha encontrado el nivel de autorización.
PWGEN_API_I_READ Error durante la lectura.
PWGEN_API_NO_PERM No se ha asignado ninguna autorización.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
3.5.6.3 PWGENDeletePermLevel (RT Professional)
Descripción
Borra de las matrices de autorización de usuario el nivel de autorización especificado con
levelNumber.

Declaración
BOOL PWGENDeletePermLevel (
int levelNumber,
LPCMN_ERROR error )
Parámetros
levelNumber
Número de la autorización que hay que borrar
error
Valor de retorno
TRUE
Nivel de autorización borrado
FALSE
Errores
Mensajes de error

PWGEN_API_NO_LEVEL No se ha encontrado el nivel de autorización.
PWGEN_API_I_DELETE Error al borrar datos.
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también

3.5.6.4 PWGENEnumPermLevels (RT Professional)
Descripción
La función lee los niveles de autorización configurados, llama a la función Callback para cada
nivel y devuelve el número de niveles de autorización en dwCount.
Declaración
BOOL PWGENEnumPermLevels (
LPDWORD dwCount,
PWGEN_ENUM_LEVELS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error )
Parámetros
dwCount
Puntero a la posición de memoria en el que se almacena el número de niveles de
autorizaciones.
cfn
Su función Callback que acepta la información. Cuando cfn == NULL, sólo se cuentan las
autorizaciones.
userdata
error
Valor de retorno
TRUE
Listado de niveles de autorización
FALSE
Errores

Mensajes de error

Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
PWGEN_ENUM_LEVELS_CALLBACK (Pági‐ Listar autorizaciones (Callback)

na 2041)
Consulte también
PWGEN_ENUM_LEVELS_CALLBACK (Página 2041)
3.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK (RT Professional)
Descripción
Para poder evaluar los niveles de autorización listados por el sistema, es necesario preparar
una función Callback del tipo PWGEN_ENUM_LEVELS_CALLBACK.
Declaración
BOOL ( * PWGEN_ENUM_LEVELS_CALLBACK) (
LPWGEN_LEVELINFO lpLevelInfo,
PVOID lpUser);
Parámetros
lpLevelInfo
Puntero a una estructura del tipo PWGEN_LEVELINFO (Página 2014) con los datos del nivel
de autorización.

lpUser
función Callback.
Valor de retorno
TRUE
Listado de niveles de autorización
FALSE
Error
Nota
Archivos necesarios
usegenap.h
PWGENEnumPermLevels (Página 2038) Listar niveles de autorización
Consulte también
PWGENEnumPermLevels (Página 2038)
PWGEN_LEVELINFO (Página 2014)
3.5.6.6 PWGENReadUserPerm (RT Professional)
Descripción
Con esta función se determinan las áreas para las que un usuario necesita autorizaciones de
uso en un determinado nivel de autorización.

Declaración
BOOL PWGENReadUserPerm(
LPCTSTR username,
BOOL is_user,
int levelnumber,
LPBYTE freigabe,
LPDWORD areaperms )
Parámetros
username
Nombre del usuario o del grupo de usuarios
is_user
is_user indica si username se trata de un usuario o de un grupo de usuarios.
TRUE Usuarios
FALSE Grupo de usuarios
levelnumber
Número de la autorización que hay que leer
freigabe
Si freigabe = 1, entonces el usuario posee la autorización de uso para todas las áreas en este
nivel de autorización.
areaperms
Con los 32 bit de areaperm se caracterizan las áreas. Si un usuario posee la autorización para
un área, entonces se activa el correspondiente bit. En este sentido, el bit de valor más bajo
corresponde con la primera área.
Valor de retorno
TRUE
Autorizaciones de uso determinadas
FALSE
Error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll

Consulte también
3.5.6.7 PWRTCheckPermission (RT Professional)
Descripción
Comprueba si el usuario registrado tiene la autorización de uso para la autorización facilitada.
Declaración
BOOL PWRTCheckPermission (
DWORD permlevel,
DWORD suppress_messagebox )
Parámetros
permlevel
Número del nivel de autorización que hay que comprobar.
suppress_messagebox
Con suppress_messagebox != 0 no se muestra ningún diálogo.
Valor de retorno
TRUE
Autorización asignada
FALSE
Autorización no asignada
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
PWRT check permission (Página 2059) "PWRTBunch.cpp"

Consulte también
PWRT check permission (Página 2059)
3.5.6.8 PWRTCheckPermissionOnPicture (RT Professional)
Descripción
Comprueba si el usuario registrado tiene la autorización de uso para la autorización facilitada.
Declaración
BOOL PWRTCheckPermissionOnPicture (
DWORD permlevel,
LPCTSTR picture_name,
DWORD suppress_messagebox,
LPCMN_ERROR lperr )
Parámetros
permlevel
Número de la autorización que hay que comprobar.
picture_name
Nombre de la imagen en la que está el objeto que hay que probar.
suppress_messagebox
Con suppress_messagebox != 0 no se muestra ningún diálogo.
lperr
Valor de retorno
TRUE
Autorización asignada
FALSE
Autorización no asignada

Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Checks admission of a certain level for a picture (Página 2060) "PWRTBunch.cpp"
Consulte también
Checks admission of a certain level for a picture (Página 2060)
3.5.6.9 PWRTPermissionLevelDialog (RT Professional)
Descripción
Es necesario abrir el diálogo para seleccionar la autorización con la función
PWRTPermisssionLevelDialogEx, ya que al mover la ventana de diálogo se realiza un
redibujado.
Declaración
LONG PWRTPermissionLevelDialog (
)
Parámetros
Ninguno
PWRTPermissionLevelDialogEx (Página 2047) Seleccionar autorización a través del diálogo
Ejemplos
Permission level query through a dialog with specifying a possible error (Página 2062)
"PWRTBunch.cpp"

Consulte también
PWRTPermissionLevelDialogEx (Página 2047)
PWRTPermissionToString (Página 2048)
3.5.6.10 PWRTPermissionLevelDialogEx (RT Professional)
Descripción
La protección de la manejabilidad de objetos se realiza en WinCC con un diálogo para la
selección de una autorización. PWRTPermissionLevelDialogEx abre el correspondiente
diálogo en el que se ofrecen las autorizaciones disponibles para su selección.
Declaración
LONG PWRTPermissionLevelDialogEx (
HWND hParentWnd,
CMN_ERROR *lpErr)
Parámetros
hParentWnd
Handle en la ventana principal del diálogo.
lpErr
Valor de retorno
0-999: Nivel de autorización
-1: El diálogo se ha finalizado con Cancelar.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll

Ejemplo
"PWRTBunch.cpp"
Consulte también
PWRTPermissionLevelDialog (Página 2044)
3.5.6.11 PWRTPermissionToString (RT Professional)
Descripción
Determina la descripción correspondiente a un nivel de autorización.
Declaración
BOOL PWRTPermissionToString (
LONG perm,
LPTSTR string,
int bufsize)
Parámetros
perm
Nivel de autorización cuya descripción debe determinarse.
string
Puntero al búfer que recoge la descripción
bufsize
Tamaño del búfer
Valor de retorno
TRUE
Descripción transferida correctamente.
FALSE
No se ha podido determinar la descripción.

Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
PWRTPermissionLevelDialog (Página 2044) Seleccionar nivel de autorización
Ejemplos
Gets a string associated with the permission number (Página 2061). "PWRTBunch.cpp"
Consulte también
Gets a string associated with the permission number (Página 2061)
3.5.7 Funciones para iniciar y cerrar sesión (RT Professional)
3.5.7.1 PWRTGetCurrentUser (RT Professional)
Descripción
Determina el nombre del usuario del usuario registrado actualmente.
Declaración
BOOL PWRTGetCurrentUser (
LPTSTR dest,
int bufsize )
Parámetros
dest
Búfer de datos para recibir el nombre de usuario
bufsize
Tamaño del búfer de datos bytes

Valor de retorno
TRUE
Nombre del usuario transferido correctamente
FALSE
No se ha registrado ningún usuario
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Return the name of the current user (Página 2063) "PWRTBunch.cpp"
Consulte también
Return the name of the current user (Página 2063)
3.5.7.2 PWRTGetLoginPriority (RT Professional)
Descripción
Comprobación del inicio de sesión sin diálogo.
Declaración
LONG PWRTGetLoginPriority (
)
Parámetros
Ninguno

Valor de retorno
Nivel de prioridad:
LOGIN_STANDARD (Valor: 0)
LOGIN_CARD (Valor: 1)
LOGIN_KEYSWITCH (Valor: 2)
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Queries the current login priority (Página 2064) "PWRTBunch.cpp"
Consulte también
Queries the current login priority (Página 2064)
3.5.7.3 PWRTIsLoggedInByCard (RT Professional)
Descripción
Determina si el usuario se ha registrado a través de tarjeta chip.
Declaración
BOOL PWRTIsLoggedInByCard (
)
Parámetros
Ninguno
Valor de retorno
TRUE
Usuario dado de alta con tarjeta chip

FALSE
Usuario no dado de alta con tarjeta chip o no dado de alta
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Checks for the user has been logged on by card (Página 2064) "PWRTBunch.cpp"
Consulte también
Checks for the user has been logged on by card (Página 2064)
3.5.7.4 PWRTLogin (RT Professional)
Descripción
Abre el diálogo de inicio de sesión y carga los datos de usuario en la memoria compartida en
caso de inicio de sesión correcto.
Declaración
BOOL PWRTLogin (
TCHAR monitor )

Parámetros
monitor
Pantalla en la que se abre el diálogo. El valor no se indica numéricamente, sino en formato
TCHAR, por lo tanto '1' para la pantalla 1.
Valor de retorno
TRUE
Diálogo abierto. La función no espera a la finalización del diálogo.
FALSE
Diálogo no abierto
Comentario
Además de la introducción manual de los datos de inicio de sesión, también es posible iniciar
la sesión con una tarjeta chip. El lector de tarjetas está conectado directamente al sistema
operativo. Si al ejecutar la función hay conectada una tarjeta válida, el diálogo de inicio de
sesión se oculta automáticamente.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
PWRTSilentLogin (Página 2056) Login
Ejemplos
PWRT login - dialog provided by WinCC itself (Página 2066) "PWRTBunch.cpp"
Consulte también
PWRTSilentLogin (Página 2056)
PWRT login - dialog provided by WinCC itself (Página 2066)
PWRTSilentLoginEx (Página 2057)

3.5.7.5 PWRTLogout (RT Professional)
Descripción
Esta función provoca que en la memoria compartida se active un indicador cuando la sesión
está cerrada.
Declaración
BOOL PWRTLogout (
)
Parámetros
Ninguno
Valor de retorno
TRUE
Cierre de sesión transmitido correctamente a PassDBRT.
FALSE
Cierre de sesión rechazado (por ejemplo: PassDBRT no disponible, ServiceMode, ...).
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
PWRTLogoutEx (Página 2055) Cerrar sesión de usuario con nivel de prioridad
Ejemplos
PWRT logout (Página 2067) "PWRTBunch.cpp"
Consulte también
PWRT logout (Página 2067)
PWRTLogoutEx (Página 2055)

3.5.7.6 PWRTLogoutEx (RT Professional)
Descripción
Esta función provoca que en la memoria compartida se active un indicador cuando la sesión
está cerrada, siempre que el nivel de prioridad indicado no sea demasiado bajo.
Declaración
BOOL PWRTLogoutEx (
int nLevel
)
Parámetros
nLevel
Nivel de prioridad del usuario.
Valor de retorno
TRUE
Cierre de sesión transmitido correctamente a PassDBRT.
FALSE
Cierre de sesión rechazado (por ejemplo: PassDBRT no disponible, ServiceMode, ...).
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
PWRTLogout (Página 2052) Cerrar una sesión de usuario
Ejemplos
Silent logout with priority level (Página 2068) "PWRTBunch.cpp"

Consulte también
Silent logout with priority level (Página 2068)
PWRTLogout (Página 2052)
3.5.7.7 PWRTSilentLogin (RT Professional)
Descripción
A diferencia de PWRTLogin el inicio de sesión no se realiza con un diálogo. Los datos del
usuario, nombre de usuario y contraseña se transmiten directamente a la función.
Declaración
BOOL PWRTSilentLogin (
LPCTSTR login,
LPCTSTR password )
Parámetros
login
Nombre del usuario.
password
Valor de retorno
TRUE
Inicio de sesión correcto
FALSE
Inicio de sesión rechazado
Comentario
Si al ejecutar la función hay conectada una tarjeta chip válida, se rechaza el inicio de sesión.
Archivos necesarios
pwrt_api.h
pass_s.lib

useadmin.dll

PWRTSilentLoginEx (Página 2057) Inicio de sesión con nivel de prioridad
Ejemplos
Login without using a dialog (Página 2069) "PWRTBunch.cpp"
Consulte también
PWRTLogin (Página 2050)
Login without using a dialog (Página 2069)
3.5.7.8 PWRTSilentLoginEx (RT Professional)
Descripción
A diferencia de PWRTLogin el inicio de sesión no se realiza con un diálogo. Los datos del
usuario (nombre de usuario, contraseña y nivel de prioridad) se transmiten directamente a la
función.
Declaración
BOOL PWRTSilentLoginEx (
LPCTSTR login,
LPCTSTR password,
int nLevel)
Parámetros
login
Nombre del usuario.
password
nLevel
Nivel de prioridad del usuario

Valor de retorno
TRUE
Inicio de sesión correcto
FALSE
Inicio de sesión rechazado
Comentario
Si al ejecutar la función hay conectada una tarjeta chip válida, se rechaza el inicio de sesión.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll

PWRTSilentLogin (Página 2054) Inicio de sesión sin diálogo
Ejemplos
Silent login with priority level (Página 2070) "PWRTBunch.cpp"
Consulte también
Silent login with priority level (Página 2070)

3.5.8.1 PWRT check permission (RT Professional)
Ejemplo
//{{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);
}
}
}

Consulte también
PWRTCheckPermission (Página 2042)
3.5.8.2 Checks admission of a certain level for a picture (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Checks admission of a certain level for a picture. (USE)}

//{{FUNCTION}PWRTCheckPermissionOnPicture (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtcheckpermissiononpicture()
{
BOOL bRet;
CMN_ERROR err;
CString csOut;
CGetText l_PermissionLevel("Enter the permission level:");
CGetText l_PictureName("Enter the picture name:", FALSE);
if(l_PermissionLevel.DoModal()==IDCANCEL)
{
return;
}
if(l_PictureName.DoModal()==IDCANCEL)
{
return;
}
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTCheckPermissionOnPicture(l_PermissionLevel.m_lNumber, l_PictureName.m_csText,
0, &err);
///////////////////////////////////////////////////////////////////////////////////////
//
if(bRet)
{
csOut.Format("Picture: \"%s\"\nLevel = %ld\n",
l_PictureName.m_csText,
l_PermissionLevel.m_lNumber);
m_pView->Print("PWRTCheckPermissionOnPicture\n", FSIZE_FUNCMARK, TRUE);
}
else
{
m_pView->PrintError(&err, "PWRTCheckPermissionOnPicture");
m_pView->PrintError("Access denied", "PWRTCheckPermissionOnPicture");
}
}

Consulte también
PWRTCheckPermissionOnPicture (Página 2043)
3.5.8.3 Gets a string associated with the permission number (RT Professional)
Vista general
//{{ODK_EXAMPLE}Gets a string associated with the permission number. (USE)}

//{{FUNCTION}PWRTPermissionToString (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtpermissiontostring()
{
BOOL bRet;
CString csOut;
CString csPermLevName;
CGetText l_PermissionLevel("Insert the permission level number:");
if(l_PermissionLevel.DoModal()==IDOK)
{
///////////////////////////////////////////////////////////////////////////////////
//////
bRet=PWRTPermissionToString(l_PermissionLevel.m_lNumber,
csPermLevName.GetBuffer(1024), 1024);
///////////////////////////////////////////////////////////////////////////////////
//////
if(!bRet)
{
m_pView->Print("ERROR: ", FSIZE_FUNCMARK);
m_pView->Print("PWRTPermissionToString.\n", FSIZE_PARAMMARK, FALSE, TRUE);
return;
}
csOut.Format("PWRTPermissionToString( %ld, buffer )\n",
l_PermissionLevel.m_lNumber);
m_pView->Print(csOut, FSIZE_FUNCMARK, TRUE);
m_pView->Print("Permission level name:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("buffer = \"%s\"\n", csPermLevName);
}
}
Consulte también
PWRTPermissionToString (Página 2046)

3.5.8.4 Permission level query through a dialog with specifying a possible error (RT Professional)
Ejemplo
//{{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);
}
}
Consulte también
PWRTPermissionLevelDialogEx (Página 2045)

3.5.8.5 Return the name of the current user (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Return the name of the current user. (USE)}

//{{FUNCTION}PWRTGetCurrentUser (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtgetcurrentuser()
{
BOOL bRet;
CString csUsername;
CString csOut;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTGetCurrentUser(csUsername.GetBuffer(1024), 1023);
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->Print("ERROR: ", FSIZE_FUNCMARK, TRUE);
m_pView->Print("PWRTGetCurrentUser.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("Failed to get current user's name.\n", FSIZE_SUBMARK);
return;
}
m_pView->Print("PWRTGetCurrentUser\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Current user's name:\n", FSIZE_PARAMMARK, FALSE, TRUE);
csOut.Format("Name = \"%s\"\n", csUsername);
}
Consulte también
PWRTGetCurrentUser (Página 2047)

3.5.8.6 Queries the current login priority (RT Professional)
Ejemplo
//{{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]);
}
}
Consulte también
PWRTGetLoginPriority (Página 2048)
3.5.8.7 Checks for the user has been logged on by card (RT Professional)
Vista general

//{{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()"));
}
}
Consulte también
PWRTIsLoggedInByCard (Página 2049)

3.5.8.8 PWRT login - dialog provided by WinCC itself (RT Professional)
Ejemplo
//{{ODK_EXAMPLE} PWRT login - dialog provided by WinCC intself. (USE)}

//{{FUNCTION}PWRTLogin (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::PWRTxLogin()
{
BOOL bRet;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTLogin(_T('1')); // it always appears on the first screen
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->Print("PWRTLogin.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("General function failure.\n", FSIZE_SUBMARK);
return;
}
m_pView->Print("PWRTLogin\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging on...\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
Consulte también

3.5.8.9 PWRT logout (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}PWRT logout. (USE)}

//{{FUNCTION}PWRTLogout (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtlogout()
{
BOOL bRet;
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTLogout(); // it appears on the first screen
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->Print("PWRTLogout.\n", FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("General function failure.\n", FSIZE_SUBMARK);
return;
}
m_pView->Print("PWRTLogout\n", FSIZE_FUNCMARK, TRUE);
m_pView->Print("Logging out...\n", FSIZE_PARAMMARK, FALSE, TRUE);
}
Consulte también
PWRTLogout (Página 2052)

3.5.8.10 Silent logout with priority level (RT Professional)
Ejemplo
//{{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);
}
}
Consulte también
PWRTLogoutEx (Página 2053)

3.5.8.11 Login without using a dialog (RT Professional)
Ejemplo
//{{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);
}
}
Consulte también

3.5.8.12 Silent login with priority level (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Silent login with priority level. (USE)}

//{{FUNCTION}PWRTSilentLoginEx (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtsilentloginex()
{
BOOL bRet;
CString csOut;
CPassdlg l_Password("Enter name and password:");
CGetText l_PriorityLevel("Enter priority level:");
if(l_Password.DoModal()==IDCANCEL)
{
return;
}
if(l_PriorityLevel.DoModal()==IDCANCEL)
{
return;
}
///////////////////////////////////////////////////////////////////////////////////////
//
bRet=PWRTSilentLoginEx(l_Password.m_csUsername, l_Password.m_csPassword,
l_PriorityLevel.m_lNumber);
///////////////////////////////////////////////////////////////////////////////////////
//
if(!bRet)
{
m_pView->PrintError( _T("Access denied or no Runtime project open."),
_T("PWRTSilentLogin"));
}
else
{
m_pView->Print("PWRTSilentLogin\n", FSIZE_FUNCMARK, TRUE);
csOut.Format("Priority level = %ld\n", l_PriorityLevel.m_lNumber);
}
}
Consulte también

3.6 Funciones del sistema de texto (RT Professional)
Declaración
TXT_ENUM_INFOTEXTS_PROC (Página 2083) Listar textos informativos (Callback)

TXT_ENUM_LANGUAGES_PROC (Página 2091) Listar idiomas configurados (Callback)
TXTCloseProject (Página 2074) Cerrar librería de textos
TXTEnumInfoText (Página 2081) Listar textos informativos
TXTEnumLanguages (Página 2089) Listar idiomas configurados
TXTGetFont (Página 2092) Determinar el juego de caracteres de un idioma
TXTGetMaxTextID (Página 2076) Determinar ID de texto (máximo)
TXTOpenProject (Página 2077) Abrir librería de textos
TXTRTConnect (Página 2079) Mantener la conexión con el servidor de textos
TXTRTDisconnect (Página 2080) Autorizar la conexión con el servidor de textos
TXTRTGetInfoText (Página 2086) Leer textos informativos
TXTRTGetInfoTextMC (Página 2087) Leer textos informativos del servidor de textos
TXTRTGetLanguageID (Página 2095) Determinar idiomas activados
TXTRTSetLanguage (Página 2097) Cambio de idioma de los textos de mensajes de
error
TXTShowLanguagesDialog (Página 2094) Mostrar idiomas (instalados)
TXTUpdateRuntime (Página 2084) Actualizar textos informativos en runtime
Sinopsis
CMN_ERROR:
TXT_SYS_ERROR (Valor: 0x10000000) Si en dwError1 de la estructura

de error CMN_ERROR está acti‐
vado este bit, dwError2 contiene
el código de error de sistema.
TXT_OK (Valor: 0x00000000) No ha ocurrido ningún error.
TXT_NO_CONNECT (Valor: 0x00000001) La base de datos todavía no se
ha abierto.
TXT_CONNECT (Valor: 0x00000002) Error al enlazar con la base de
datos.

TXT_UPDATE (Valor: 0x00000003) Error al escribir en la base de da‐

tos.
TXT_CREATE_KEY (Valor: 0x00000004) No se ha podido generar la ID de
texto.
TXT_KEY_NOT_FOUND (Valor: 0x00000005) No se ha podido encontrar el ID
del texto indicado.
TXT_LANGUA‐ (Valor: 0x00000006) No se ha podido encontrar el
GE_NOT_FOUND idioma indicado.
TXT_NO_NEW_RECORD (Valor: 0x00000007) No se ha podido crear ningún re‐
gistro nuevo (AddRecord ha ge‐
nerado un error)
TXT_FONT_NOT_FOUND (Valor: 0x00000008) No se ha encontrado la fuente
TXT_TABLE_NOT_FOUND (Valor: 0x00000009) No se ha encontrado una tabla
de base de datos. El campo dwE‐
rror2 contiene información más
detallada:
TXTVERSIONINFO (Valor: 0x00000001) No se ha encontrado la tabla de
información de versión.
TXTLANGUAGES (Valor: 0x00000002) No se ha encontrado la tabla de
idiomas.
TXTTABLE (Valor: 0x00000003) No se ha encontrado la tabla de
textos.
TXT_WRONG_PROJECT (Valor: 0x00000010) Nombre de proyecto erróneo
TXT_OPEN (Valor: 0x00000011) No se ha podido cargar la base
de datos.
TXT_PARAM (Valor: 0x00000012) Parámetro no válido
TXT_DISCONNECT (Valor: 0x00000013) Error al salir de la base de datos
TXT_CALLBACK (Valor: 0x00000014) Callback ha devuelto FALSE
TXT_ALREADY_FOUND (Valor: 0x00000015) El texto ya existe
TXT_CREATE (Valor: 0x00000016) No se han podido crear tablas de
la base de datos.
TXT_UPDATE_RUNTIME (Valor: 0x00000017) No se ha encontrado runtime o
SendMessage ha devuelto
NULL.
TXT_ALREADY_EXIST (Valor: 0x00000018) El idioma ya existe
TXT_NO_LANGUAGE (Valor: 0x00000019) El idioma indicado no es válido
TXT_TEXT_LIBRARY_RUN‐ (Valor: 0x00000020) TEXTBIB.EXE ya se está ejecu‐
NING tando; no se puede abrir
TXT_TABLES_AL‐ (Valor: 0x00000021) Las tablas de base de datos ya
READY_EXIST existen. No está permitido crear
más.
Text Library RT
TXT_RT_OK (Valor: 0x00000000) Ningún error

TXT_RT_OPEN_MMF (Valor: 0x00000001) Error al abrir el archivo asignado
en memoria

TXT_RT_CREATE_SERVI‐ (Valor: 0x00000002) Error al crear la ventana de Ser‐

CE_WINDOW vicio
TXT_RT_KEY_NOT_FOUND (Valor: 0x00000003) No se ha encontrado TextID
TXT_RT_NO_READ_ACCESS (Valor: 0x00000004) Rechazado el acceso en lectura
al archivo asignado en memoria
TXT_RT_NO_LANGUA‐ (Valor: 0x00000005) No se ha encontrado ningún idio‐
GE_FOUND ma
TXT_RT_LANGUA‐ (Valor: 0x00000006) Idioma no encontrado
GE_NOT_FOUND
TXT_RT_INTERNAL_ERROR (Valor: 0x00000007) Error interno
TXT_RT_INVALIDPARAM (Valor: 0x00000008) Parámetro error
TXT_RT_NODEFAULTSERVER (Valor: 0x00000011) No hay ningún servidor estándar
configurado
TXT_RT_NOLOCALSERVER (Valor: 0x00000012) No hay ningún servidor local dis‐
ponible
TXT_RT_NOSERVER (Valor: 0x00000013) No hay ningún servidor estándar
configurado ni ningún servidor
local disponible
TXT_RT_NOMC (Valor: 0x00000014) No es un proyecto multicliente
(aquí no se utiliza)
TXT_RT_NOMCDEFAULTSER‐ (Valor: 0x00000015) No es un proyecto multicliente,
VER pero se ha indicado "@default"
como prefijo de servidor
3.6.1.3 Códigos de idioma (RT Professional)
Código de idioma del sistema de texto

WinCC solo soporta los idiomas SUBLANG_DEFAULT de Windows. Por ello, al parámetro
dwLocaleID de las funciones API se pueden asignar los siguientes valores del sistema de
textos:
LANG_ARABIC 0x0401
LANG_BASQUE 0x042D
LANG_BELARUSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0804
LANG_CZECH 0x0405
LANG_DANISH 0x0406
LANG_DUTCH 0x0413
LANG_ENGLISH 0x0409

LANG_FARSI 0x0429
LANG_FINNISH 0x040B
LANG_FRENCH 0x040C
LANG_GERMAN 0x0407
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E
LANG_ICELANDIC 0x040F
LANG_ITALIAN 0x0410
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_NORWEGIAN 0x0414
LANG_POLISH 0x0415
LANG_PORTUGUESE 0x0416
LANG_RUSSIAN 0x0419
LANG_SLOVAK 0x041B
LANG_SPANISH 0x040A
LANG_SWEDISH 0x041D
LANG_THAI 0x041E
LANG_TURKISH 0x041F
Los 4 bytes superiores (0x04..) identifican el idioma como idioma SUBLANG_DEFAULT
3.6.2.1 TXTCloseProject (RT Professional)
Descripción
Cierra la base de datos del proyecto en caso de ejecución correcta.

Declaración
BOOL TXTCloseProject (
Parámetros
lpszProjectFile
Puntero al nombre del proyecto incluidas ruta y extensión.
lpdmError
Valor de retorno
TRUE
Librería de textos cerrada.
FALSE
Errores
Comentario
La función TXTOpenProject incrementa con cada llamada un contador de referencia interno.
Cada llamada de TXTCloseProject disminuye de nuevo este contador. Sólo cuando el
contador de referencia está de nuevo a 0 se cierra también la librería de textos.
Por este motivo se debe llamar siempre la misma cantidad de TXTCloseProject, ya que de lo
contrario se puede producir un error de excepción al finalizar la aplicación.
Nota
Mensajes de error
TXT_DISCONNECT Error al salir de la base de datos
Archivos necesarios
text_cs.h

text_cs.lib
text_cs.dll
TXTOpenProject (Página 2077) Abre la librería de textos
Ejemplos
Obtener texto de ayuda (Página 2098) "TX01.cpp"
Enumerar textos de ayuda (Página 2100) "TX01.cpp"
Consulte también
TXTOpenProject (Página 2077)
Obtener texto de ayuda (Página 2098)
Enumerar textos de ayuda (Página 2100)
3.6.2.2 TXTGetMaxTextID (RT Professional)
Descripción
Determina el mayor ID de texto que se lleva a la DLL.
Declaración
BOOL TXTGetMaxTextID (
LPLONG lplMaxTextID,
Parámetros
lplMaxTextID
Puntero al búfer en el que se debe depositar la ID de texto.
lpdmError

Valor de retorno
TRUE
ID de texto máximo determinado
FALSE
Errores
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también
3.6.2.3 TXTOpenProject (RT Professional)
Descripción
Abre la base de datos en caso de ejecución correcta.
Declaración
BOOL TXTOpenProject (
LPCTSTR lpszDSNName,
BOOL fExclusive,
Parámetros
lpszProjectFile
lpszDSNName
Puntero al nombre de la fuente de datos.
fExclusive
Si TRUE, no se puede iniciar TEXTBIB.EXE porque, por ejemplo, otro programa tiene acceso
a la Text Library. Si TEXTBIB.EXE ya ha arrancado, se rechaza la llamada

lpdmError
Valor de retorno
TRUE
Base de datos abierta
FALSE
Errores
Comentario
Si no se dispone de tablas de librería de textos, se generan de nuevo.
En cada llamada de la función se aumenta un contador de referencia. Para finalizar se debe
llamar la misma cantidad de TXTCloseProject. De lo contrario se puede producir un error de
excepción al finalizar la aplicación.
Mensajes de error
TXT_CONNECT Error al enlazar con la base de datos.

TXT_TABLE_NOT_FOUND No se ha encontrado una tabla de base de datos. El campo
dwError2 contiene información más detallada:
TXT_TEXT_LIBRARY_RUNNING TEXTBIB.EXE ya se ha iniciado
TXT_WRONG_PROJECT Nombre de proyecto erróneo
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
TXTCloseProject (Página 2072) Cierra la librería de textos
Ejemplos

Consulte también
TXTCloseProject (Página 2072)
3.6.2.4 TXTRTConnect (RT Professional)
Descripción
Establece una conexión con el servidor de texto. Esta función acelera la ejecución de las
funciones TXTRT. Entonces la conexión con el servidor de texto no se establece en cada
llamada ni luego se vuelve a deshacer.
Declaración
BOOL TXTRTConnect ( );
Parámetros
Ninguno
Valor de retorno
TRUE
Conexión con el servidor de texto establecida
FALSE
Errores
Comentario
Antes de finalizar la aplicación se debe deshacer sin falta la conexión de nuevo con
TXTRTDisconnect para evitar las consiguientes funciones de error en el sistema.
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll

TXTRTDisconnect (Página 2080) Autorizar la conexión con el servidor de texto
Consulte también
TXTRTDisconnect (Página 2080)
3.6.2.5 TXTRTDisconnect (RT Professional)
Descripción
Deshace una conexión con conexión configurada TXTRTConnect con el servidor de texto.
Declaración
BOOL TXTRTDisconnect ( );
Parámetros
Ninguno
Valor de retorno
TRUE
Conexión con el servidor de texto establecida
Comentario
Esta función finaliza la aceleración de las funciones TXTRT y devuelve siempre TRUE.
Las siguientes funciones TXTRT llamadas vuelven a establecer de nuevo con cada llamada
la conexión con el servidor de texto y la vuelven a deshacer.
Si se ha utilizado TXTRTConnect y no se ejecuta ningún TXTRTDisconnect antes de finalizar
la aplicación, se pueden producir a continuación funciones de error en el sistema.
Nota

Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
TXTRTConnect (Página 2077) Mantener la conexión con el servidor de texto
Consulte también
TXTRTConnect (Página 2077)
3.6.3 Funciones para la edición de textos de ayuda (RT Professional)
3.6.3.1 TXTEnumInfoText (RT Professional)
Descripción
Se muestran en una lista todos los textos de ayuda que corresponden con el criterio de filtro
en lpszFilter.
Declaración
BOOL TXTEnumInfoText (
DWORD dwLocale,
LPDWORD lpdwItems,
LPCTSTR lpszFilter,
TXT_ENUM_INFOTEXTS_PROC lpfnEnum,
LPVOID lpvUser,
Parámetros
lpszProjectFile
dwLocale
Código del idioma cuyos textos informativos deben enumerarse.

lpdwItems
Puntero a una variable de palabra doble de la aplicación que contiene la cantidad de textos
informativos enumerados después de la llamada.
lpszFilter
Puntero a la condición de una instrucción SQL para el operador LIKE.
lpfnEnum
Su función Callback que acepta los textos informativos.
lpvUser
lpdmError
Valor de retorno
TRUE
Listado de textos informativos
FALSE
Errores
Comentario
Si lpszFilter == NULL o se transmite una cadena vacía, se enumeran todos los textos
informativos del idioma. En este caso también se enumeran los textos informativos vacíos no
ocupados y se cuentan con lpdwItems.
Mensajes de error
TXT_CALLBACK Callback ha devuelto FALSE

TXT_LANGUAGE_NOT_FOUND No se ha podido encontrar el idioma indicado.
TXT_NO_CONNECT La base de datos todavía no se ha abierto.
TXT_NO_LANGUAGE El idioma indicado no es válido
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll

TXT_ENUM_INFOTEXTS_PROC (Página 2083) Listar textos informativos (Callback)
Ejemplos
Consulte también
TXT_ENUM_INFOTEXTS_PROC (Página 2083)
3.6.3.2 TXT_ENUM_INFOTEXTS_PROC (RT Professional)
Descripción
Para poder evaluar los tooltips listados, es necesario poner a disposición una función Callback
del tipo TXT_ENUM_INFOTEXTS_PROC.
Declaración
BOOL ( * TXT_ENUM_INFOTEXTS_PROC) (
DWORD dwTextID,
LPCTSTR lpszInfoText,
LPVOID lpvUser );
Parámetros
dwTextID
ID del texto al que remite lpszInfotext.
lpszInfoText
Puntero al tooltip transmitido por la función que efectúa la llamada.
lpvUser
función Callback.

Valor de retorno
TRUE
FALSE
La enumeración se cancela
Comentario
Nota
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
TXTEnumInfoText (Página 2079) Listar textos informativos
Ejemplos
Consulte también
TXTEnumInfoText (Página 2079)
3.6.3.3 TXTUpdateRuntime (RT Professional)
Descripción
En Runtime se cargan de nuevo los textos de la librería de textos.

Declaración
BOOL TXTUpdateRuntime (
HWND hwndParent,
Parámetros
lpszProjectFile
hwndParent
Handle en la ventana principal
lpdmError
Valor de retorno
TRUE
Textos informativos actualizados
Comentario
En variables de referencia de texto no se realiza ninguna actualización. La función devuelve
siempre TRUE.
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también

3.6.3.4 TXTRTGetInfoText (RT Professional)
Descripción
En caso de ejecución correcta, llena el búfer transmitido en lpszBuffer con el texto descrito
mediante dwTextID. Si el búfer transmitido es menor que la longitud del texto (longitud del
búfer en caracteres en pdwSize), el texto se reduce de forma correspondiente. El valor de
retorno sigue siendo TRUE. Si se transmite en lpszBuffer NULL, la función determina el
tamaño de búfer necesario y lo guarda en pdwSize.
Declaración
BOOL TXTRTGetInfoText (
DWORD dwTextID,
LPTSTR lpszBuffer,
LPDWORD pdwSize,
Parámetros
dwTextID
ID del texto que hay que leer
lpszBuffer
Puntero a un búfer en el que se debe almacenar el texto informativo.
pdwSize
Puntero a la DWORD que contiene el tamaño del búfer
lpdmError
Valor de retorno
TRUE
Texto informativo determinado
FALSE
Error

Comentario
Mensajes de error
TXT_RT_OPEN_MMF Error al abrir el archivo asignado en memoria

TXT_RT_CREATE_SERVICE_WINDOW Error al crear la ventana de Servicio
TXT_KEY_NOT_FOUND No se ha podido encontrar el ID del texto indicado.
TXT_RT_NO_READ_ACCESS Rechazado el acceso en lectura al archivo asignado en
memoria
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
AUTOHOTSPOT Leer tooltips del servidor de textos
Ejemplos
Consulte también
3.6.3.5 TXTRTGetInfoTextMC (RT Professional)
Descripción
Obtiene un texto, p. ej., un tooltip, del servidor de texto indicado o de la lista de textos C. En
caso de ejecución correcta, llena el búfer transmitido en lpszBuffer con el texto descrito
mediante dwTextID. Si el búfer transmitido es menor que la longitud del texto (longitud del
búfer en caracteres en pdwSize), el texto se reduce de forma correspondiente. El valor de
retorno sigue siendo TRUE. Si se transmite en lpszBuffer NULL, la función determina el
tamaño de búfer necesario y lo guarda en pdwSize.

Declaración
BOOL TXTRTGetInfoTextMC (
DWORD dwTextID,
LPTSTR lpszBuffer,
LPDWORD pdwSize,
LPTSTR lpszServer,
Parámetros
dwTextID
ID del texto que hay que leer
lpszBuffer
Puntero a un búfer en el que se debe almacenar el texto informativo.
pdwSize
Puntero a la DWORD que contiene el tamaño del búfer
lpszServer
Puntero al nombre simbólico del servidor de texto (sin separadores de servidor :: )
lpdmError
Valor de retorno
TRUE
Texto informativo determinado
FALSE
Error
Comentario
Esta función trabaja sólo en caso de proyectos Multiclient
Mensajes de error

TXT_KEY_NOT_FOUND No se ha podido encontrar el ID del texto indicado.

TXT_RT_NO_READ_ACCESS Rechazado el acceso en lectura al archivo asignado en

memoria
TXT_RT_NODEFAULTSERVER No hay ningún servidor estándar proyectado.
TXT_RT_NOLOCALSERVER No hay ningún servidor local disponible.
TXT_RT_NOSERVER No hay ningún servidor estándar proyectado ni ningún
servidor local disponible.
TXT_RT_NOMCDEFAULTSERVER No es un proyecto Multiclient, pero se ha indicado "@de‐
fault" como prefijo de servidor.
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
AUTOHOTSPOT Leer tooltips
Consulte también
3.6.4 Funciones para la edición de idiomas (RT Professional)
3.6.4.1 TXTEnumLanguages (RT Professional)
Descripción
Llama a la función transmitida Callback para todos los idiomas configurados.
Declaración
BOOL TXTEnumLanguages (
LPDWORD lpdwItems,
TXT_ENUM_LANGUAGES_PROC lpfnEnum,
LPVOID lpvUser,

Parámetros
lpszProjectFile
lpdwItems
Puntero a una variable de palabra doble de la aplicación que contiene la cantidad de idiomas
enumerados después de la llamada.
lpfnEnum
Su función Callback que acepta los idiomas configurados.
lpvUser
lpdmError
Valor de retorno
TRUE
Listado de idiomas configurados
FALSE
Errores
Mensajes de error

Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
TXT_ENUM_LANGUAGES_PROC (Página 2091) Listar idiomas configurados (Callback)

Ejemplos
Consulte también
TXT_ENUM_LANGUAGES_PROC (Página 2091)
3.6.4.2 TXT_ENUM_LANGUAGES_PROC (RT Professional)
Descripción
Para poder evaluar los idiomas listados, es necesario preparar una función Callback del tipo
TXT_ENUM_LANGUAGES_PROC.
Declaración
BOOL ( * TXT_ENUM_LANGUAGES_PROC) (
DWORD dwLocaleID,
LPCTSTR lpszName,
LPVOID lpvUser );
Parámetros
dwLocaleID
Código de idioma
lpszName
Puntero al nombre del idioma.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE

Comentario
Nota
Archivos necesarios
text_cs.h
TXTEnumLanguages (Página 2087) Listar idiomas configurados
Ejemplos
Consulte también
TXTEnumLanguages (Página 2087)
3.6.4.3 TXTGetFont (RT Professional)
Descripción
En caso de ejecución correcta llena la estructura LOGFONT transmitida en lplf con la fuente
configurada del idioma deseado.
Declaración
BOOL TXTGetFont (
DWORD dwLocale,
LPLOGFONT lplf,

Parámetros
lpszProjectFile
dwLocale
Código de los idiomas de los que se debe tomar la fuente.
lplf
Puntero a una estructura específica de Windows del tipo LOGFONT con los datos de un juego
de caracteres.
lpdmError
Valor de retorno
TRUE
Juego de caracteres determinado
FALSE
Errores
Mensajes de error

TXT_NO_LANGUAGE El idioma indicado no es válido
TXT_LANGUAGE_NOT_FOUND No se ha podido encontrar el idioma indicado.
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también

3.6.4.4 TXTShowLanguagesDialog (RT Professional)
Descripción
Abre un diálogo con los idiomas disponibles. Si se cierra el diálogo con "OK", se guarda el
idioma seleccionado en lpdwLocale. Además, la fuente correspondiente se transmite a la
estructura LOGFONT.
Declaración
BOOL TXTShowLanguagesDialog (
HWND hwndParent,
LPDWORD lpdwLocale,
LPLOGFONT lplf,
Parámetros
lpszProjectFile
hwndParent
Handle en la ventana principal en la que tiene lugar el diálogo. El parámetro está ocupado por
defecto con NULL.
dwLocale
Puntero al código del idioma que se va a instalar.

lplf
Puntero a una estructura específica de Windows del tipo LOGFONT con los datos de un juego
de caracteres.
lpdmError
Valor de retorno
TRUE
Idioma selecciona
FALSE
Salir del error o del diálogo con "Cancelar"
Comentario
Para poder ofrecer los idiomas instalados en la ventana de diálogo, la función enumera los
idiomas disponibles en la base de datos. Si se produce un error, el mensaje de error
TXT_CALLBACK se guarda en la estructura de error.
Mensajes de error

Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también
3.6.4.5 TXTRTGetLanguageID (RT Professional)
Descripción
En caso de ejecución correcta llena el búfer transmitido en lpchLanguageID con el ID del
idioma primario cargado en el archivo asignado en memoria.

Declaración
BOOL TXTRTGetLanguageID (
LPBYTE lpchLanguageID,
Parámetros
lpchLanguageID
Puntero a un búfer en el que se debe almacenar el ID del idioma primario.
lpdmError
Valor de retorno
TRUE
Idioma activado determinado
FALSE
Errores
Mensajes de error

TXT_RT_NO_LANGUAGE_FOUND No se ha encontrado idioma
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
Consulte también

3.6.4.6 TXTRTSetLanguage (RT Professional)
Descripción
Ajusta el idioma para los mensajes de error. Si este idioma no está disponible, se ajusta el
idioma por defecto (alemán) y se devuelve FALSE.
Ya no se da soporte a esta función y siempre se devuelve el valor de retorno TRUE.
Declaración
BOOL TXTRTSetLanguage (
DWORD dwLocaleID,
Parámetros
dwLocaleID
Código del idioma que debe ajustarse
lpdmError
Valor de retorno
TRUE
Se ha cambiado el idioma de los mensajes de error
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
Consulte también

3.6.5.1 Obtener texto de ayuda (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Insert new Infotext (TXT)}

//{{FUNCTION}TXTOpenProject (TXT)}
//{{FUNCTION}TXTNewInfoText (TXT)}
//{{FUNCTION}TXTSetInfoText (TXT)}
//{{FUNCTION}TXTCloseProject (TXT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTxtSetInfotext(void) ODK DM CS
// =====================================================================
// Abst. : Insert New Text
// =====================================================================
void MyTxtNewInfotext(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwLocale = 0x0407; // german
TCHAR szFilter[]="S%"; // all texts with 'S'
DWORD dwSize =254;
DWORD dwTextID = 0;
ret = MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile and
g_szDSNName
if(TRUE == ret)
{
ret = TXTOpenProject(g_szProjectFile, g_szDSNName, FALSE, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TXTOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTOpenProject"));
ODKTrace(szText);
dwTextID = 380;
dwLocale = 0x0407; // german
_tcsncpy_s(szText, _countof(szText), _T("NewInfoText_ODK"), _TRUNCATE);
ret = TXTGetInfoText(g_szProjectFile, dwTextID, dwLocale, szText, &dwSize,
&Error);
if(FALSE == ret)
{
TXTNewInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),


}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTNewInfoText"));
}
ODKTrace(szText);
dwLocale=0x0409; // english
//dwTextID = 380; // use ID from TXTNewInfoText
_tcsncpy_s(szText, _countof(szText), _T("InfoText_ODK"), _TRUNCATE);
ret = TXTSetInfoText(g_szProjectFile, NULL, dwTextID, dwLocale, szText, &Error);
if(FALSE == ret)
{
TXTSetInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTSetInfoText"));
}
ODKTrace(szText);
ret = TXTCloseProject(g_szProjectFile, &Error);
if(FALSE == ret)
{
TXTCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTCloseProject"));
ODKTrace(szText);
}
}
}
}
Consulte también
TXTRTGetInfoText (Página 2084)

3.6.5.2 Enumerar textos de ayuda (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enumerate texts (TXT)}

//{{FUNCTION}TXTOpenProject (TXT)}
//{{FUNCTION}TXTCloseProject (TXT)}
//{{FUNCTION}TXTEnumLanguages (TXT)}
//{{FUNCTION}TXT_ENUM_LANGUAGES_PROC (TXT)}
//{{FUNCTION}TXTEnumInfoText (TXT)}
//{{FUNCTION}TXT_ENUM_INFOTEXTS_PROC (TXT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTxtEnums(void) ODK DM CS
// =====================================================================
// Abst. : Enumerate Texts
// =====================================================================
BOOL MyTXTEnumLanguagesCallback (DWORD dwLocID, LPCTSTR lpszName, LPVOID lpvUser)

{
lpvUser;
TCHAR szText[255];
BOOL ret = TRUE;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" InfoLang: ID=%x ;
ODKTrace(szText);
return(ret);
}
BOOL MyTXTEnumInfotextsCallback(DWORD dwTextID, LPCTSTR lpszInfoText, LPVOID lpvUser)

{
lpvUser;
TCHAR szText[255];
BOOL ret = TRUE;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" InfoText: ID=%.4d ; Tx=%s "),
dwTextID, lpszInfoText);
ODKTrace(szText);
return(ret);
}
void MyTxtEnums(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwLocale = 0x0407; // german
DWORD dwItems = 0;
DWORD dwUser = 0;
TCHAR szFilter[]="S%"; // all texts with 'S'
//DWORD dwSize =254;
ret = MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile and
g_szDSNName
if(TRUE == ret)
{

ret = TXTOpenProject(g_szProjectFile, g_szDSNName, FALSE, &Error);

if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TXTOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTOpenProject"));
ODKTrace(szText);
dwItems = 0;
ret = TXTEnumLanguages(g_szProjectFile, &dwItems, MyTXTEnumLanguagesCallback,
&dwUser, &Error);
if(FALSE == ret)
{
TXTOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
dwItems = 0;
ret = TXTEnumInfoText(g_szProjectFile, dwLocale, &dwItems, szFilter,
MyTXTEnumInfotextsCallback, &dwUser, &Error);
if(FALSE == ret)
{
TXTEnumInfoText: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TXTEnumInfoText: NItems=
%d ; LANG=%x ; Filter=%s "),
dwItems, dwLocale, szFilter);
ODKTrace(szText);
ret = TXTCloseProject(g_szProjectFile, &Error);
if(FALSE == ret)
{
TXTCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
}

3.7 Funciones del sistema de informes (RT Professional)
Consulte también
TXTEnumInfoText (Página 2079)
TXT_ENUM_INFOTEXTS_PROC (Página 2081)
TXT_ENUM_LANGUAGES_PROC (Página 2089)
TXTEnumLanguages (Página 2087)
Sinopsis
RPJAttach (Página 2115) Establecer conexión

RPJCallJobMethod (Página 2138) Llamar método de trabajo de impresión
RPJCreateJob (Página 2125) Crear trabajo de impresión
RPJCreatePropertyHandle (Página 2128) Generar handle de una propiedad de trabajo de
impresión
RPJDeleteJob (Página 2127) Borrar trabajo de impresión
RPJDeletePropertyHandle (Página 2129) Borrar handle de una propiedad de trabajo de im‐
presión
RPJDetach (Página 2116) Deshacer conexión
RPJGetJobMethodAt (Página 2139) Determinar nombre de un método de trabajo de
impresión
RPJGetJobNameAt (Página 2131) Determinar nombre de un trabajo de impresión
RPJGetJobPropertyAt (Página 2141) Determinar nombre de propiedades de trabajo de
impresión
RPJGetJobProps (Página 2143) Determinar propiedades del trabajo de impresión
RPJGetNumJobMethods (Página 2140) Determinar cantidad de un método de trabajo de
impresión
RPJGetNumJobProperties (Página 2144) Determinar cantidad de propiedades de trabajo de
impresión
RPJGetNumJobs (Página 2132) Determinar cantidad de trabajos de impresión
RPJGetNumProjectProperties (Página 2118) Determinar el número de propiedades del proyecto
RPJGetProjectPropertyAt (Página 2119) Determinar nombre de propiedad y tipo en el pro‐
yecto por índice
RPJGetProjectProperty (Página 2120) Determinar el valor de la propiedad en el proyecto

RPJGetProperty (Página 2145) Determinar propiedad de trabajo de impresión

RPJJobLock (Página 2133) Bloquear trabajo de impresión para otros accesos
RPJJobUnlockAll (Página 2136) Anular todos los bloqueos del trabajo de impresión
RPJJobUnlock (Página 2135) Anular un bloqueo del trabajo de impresión
RPJMemFree (Página 2117) Habilitar memoria
RPJProjectLock (Página 2121) Bloquear el acceso a la lista de trabajos de impre‐
sión del proyecto
RPJProjectUnlockAll (Página 2124) Anular todos los bloqueos de la lista de trabajos
de impresión del proyecto
RPJProjectUnlock (Página 2123) Anular un bloqueo de la lista de trabajos de impre‐
sión del proyecto
RPJPropertyClear (Página 2148) Borrar handle de una propiedad de trabajo de im‐
presión
RPJSetProperty (Página 2150) Definir propiedades del trabajo de impresión
Propiedades para diseños (CS)

Root
● ObjectName
● Context
Geometría
● Left
● Top
● Width
● Height
● RoundCornerWidth
● RoundCornerHeight
● StartAngle
● EndAngle
● Radio
● RadiusWidth
● RadiusHeight
● Columns
● Index
● PointCount
● ActualPointLeft
● ActualPointTop

● PaperSize
● Orientation
● DynMarginLeft
● DynMarginRight
● DynMarginTop
● DynMarginBottom
● PrintMarginLeft
● PrintMarginRight
● PrintMarginTop
● PrintMarginBottom
Styles
● BorderStyle
● BorderWidth
● FillStyle
Colores
● BorderBackColor
● BorderColor
● BackColor
● FillColor
● ForeColor
Caracteres
● FontName
● FontSize
● FontBold
● FontItalic
● FontUnderline
● Text
● AlignmentLeft
● AlignmentTop
● WordWrap
Otros
● FirstPage
● LastPage
● MetaFileName
● LayoutFileName

● Formato
● List
● Tag
● DataType
● OutFormat
● Calculation
● PageBreak
Propiedades de trabajos de impresión
AbsoluteSelectionFrom
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage Con estos datos se puede conseguir que la im‐
presión del informe termine con una página en
concreto.
JobName El nombre del trabajo de impresión debe ser uní‐
voco dentro de un proyecto y debe ser conforme
a las convenciones de Windows.
LayoutName Con el nombre de diseño se asigna un diseño al
trabajo de impresión.
PrinterName 1 Aquí se define la impresora en la que se intentará
iniciar la impresión en primer lugar.
PrinterName 2 Aquí se define la impresora que se activa cuando
la primera impresora no está disponible.
PrinterName 3 Aquí se define la impresora que se activa cuando
las dos primeras impresoras no están disponibles.
RelativeSelectionCount
RelativeSelectionRange
StartPage Con estos datos se puede conseguir que el infor‐
me se imprima a partir de una página en concreto.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter

Sinopsis
CMN_ERROR:
Mensajes de error CS
ERR_NOERROR 0 Ningún error

ERR_ILLEGALPROJECT 1 Nombre o ruta de proyecto no válido
ERR_NOMEMORY 2 Error de memoria
ERR_UNKNOWNERROR 3 Error desconocido
ERR_THREADNOTINITIALIZED 4 El thread utilizado no está inicializado.
ERR_OLEEXCEPTION 5 Error en relación con MFC u OLE
ERR_NOOLESERVERAVAIL 6 Ningún OLE-Server disponible
Mensajes de error RT
ERR_NOERROR 0 Ningún error

ERR_ILLEGALPROJECT 1 Nombre o ruta de proyecto no válido
ERR_NOMEMORY 2 Error de memoria
ERR_UNKNOWNERROR 3 Error desconocido
ERR_NULLHANDLE 4 No se ha podido crear el handle
ERR_ILLEGALPOINTER 5 Puntero erróneo o no válido
ERR_ILLEGALJOBINDEX 6 Índice erróneo de un trabajo de impresión
ERR_UNKNOWNPROPERTY 7 Propiedad de trabajo de impresión desconocida
ERR_UNKNOWNMETHOD 8 Método de trabajo de impresión desconocido
3.7.1.4 Lista de las propiedades de objeto (RT Professional)
Propiedades para todos los objetos
Nota
Los nombres de propiedades con una descripción básica también pueden consultarse en la
ayuda contextual haciendo clic con el botón derecho del ratón en el campo de propiedades
del objeto en cuestión en el Report-Designer.
Nombre de propiedad Tipo de datos

"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
Propiedades para todos los "objetos bidimensionales":
"FillStyle" VT_I4
"BackColor" VT_I4
"FillColor" VT_I4
Propiedades para "objetos dinámicos":
"DataLink" VT_BSTR
Las siguientes propiedades son específicas de objeto.
Propiedades para todos los objetos "Sistema":

"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
Propiedades para "tablas dinámicas":
"FontName" VT_BSTR
"FontSize" VT_I4

"FontBold" VT_I4
"FontItalic" VT_I4
"Orientation" VT_I4
"Columns" VT_BSTR
"ForeColor" VT_I4
"List" VT_I4
Propiedades de "textos dinámicos":
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"Orientation" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
Propiedades de "imagen dinámica":
"DynHeight" VT_I4
Propiedades de "arco circular":
"Radius" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
Propiedades de "arco elíptico":
"StartAngle" VT_I4
"EndAngle" VT_I4
"RadiusWidth" VT_I4
"RadiusHeight" VT_I4

Propiedades de "círculos":
"Radius" VT_I4
Propiedades de "elipses":
"RadiusWidth" VT_I4
Propiedades de "polígonos":
"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4
Propiedades para "segmentos circulares":
"Radius" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
Propiedades de "segmentos elípticos":
"StartAngle" VT_I4
"EndAngle" VT_I4
"RadiusWidth" VT_I4
Propiedades de "Polilínea":
"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4

Propiedades de "rectángulo redondeado":
"RoundCornerWidth" VT_I4
"RoundCornerHeight" VT_I4
Propiedades de "objetos de texto":
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"Orientation" VT_I4
"Text" VT_BSTR
"WordWrap" VT_I4
"ForeColor" VT_I4
Propiedades de "diseños insertados":
"LayoutFileName" VT_BSTR
Propiedades de "diseños":
"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
Propiedades de "MetaFiles":
"MetaFileName" VT_BSTR
Propiedades de objetos "variables":
"Tag" VT_BSTR
"FontSize" VT_I4
"FontName" VT_BSTR
"FontBold" VT_I4
"FontItalic" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
"OutFormat" VT_BSTR
"DataType" VT_I4
"Calculation" VT_VARIANT
3.7.1.5 Procedimiento general para editar propiedades de trabajos de impresión (Report

Designer) (RT Professional)
Establecer e inicializar conexión con RPJAPI.DLL

RPJAttach.
Crear handle de propiedades de trabajo de impresión

Para poder editar las propiedades de un trabajo de impresión, primero es necesario crear un
handle del trabajo de impresión. A través de él se identifica un área de memoria a través de
la cual se puede acceder a las propiedades del trabajo de impresión.
Función: RPJCreatePropertyHandle.
Leer propiedades de trabajo de impresión

Las propiedades de los trabajos de impresión están guardadas en la base de datos del
proyecto. Para poder editar las propiedades es necesario cargarlas desde la base de datos
en el área especificada por el handle.
Función: RPJGetJobProps.

Determinar propiedades del trabajo de impresión

A una propiedad determinada de un trabajo de impresión se accede a través de su nombre.
Para determinar el valor de una propiedad es necesario leer la propiedad.
Función: RPJGetProperty.
Definir propiedades de trabajo de impresión

Una propiedad determinada de trabajo de impresión se llama a través de su nombre. La
activación de la propiedad se realiza llamando la función RPJSetProperty.
Guardar propiedades de trabajo de impresión

Guardar las propiedades de trabajo de impresión modificadas en la base de datos del
proyecto. Es preciso especificar el nombre del trabajo de impresión que debe guardarse.
Función: RPJSetJobProps.
Volver a inicializar la propiedad del trabajo de impresión

Volver a inicializar el área de memoria referenciada por la identificación sin habilitar el handle.
Función: RPJPropertyClear.
Definir propiedades de trabajo de impresión

Una propiedad determinada de trabajo de impresión se llama a través de su nombre. La
activación de la propiedad se realiza llamando la
función: RPJSetProperty.
Guardar propiedades de trabajo de impresión

Guardar las propiedades de trabajo de impresión modificadas en la base de datos del
proyecto. Es preciso especificar el nombre del trabajo de impresión que debe guardarse.
Función: RPJSetJobProps.
Borrar handle
Borrar handle de una propiedad de trabajo de impresión. Los handles que se crean con
RPJCreatePropertyHandle deben borrarse si ya no se necesitan.
Función: RPJDeletePropertyHandle.
Deshacer conexión con RPJAPI.DLL

RPJDetach.

Ejemplo: Lanzamiento de un trabajo de impresión como vista preliminar
General
Para poder editar las propiedades de un trabajo de impresión, primero es necesario configurar
un handle en el trabajo de impresión. A través de él se identifica un área de memoria a través
de la cual se puede acceder a las propiedades del trabajo de impresión.
Establecer e inicializar conexión con RPJAPI.DLL

RPJAttach.
Crear handle:Función
RPJCreatePropertyHandle.
Leer propiedades del trabajo de impresión

Las propiedades del trabajo de impresión: "Documentación de retorno Control Center" se
cargan desde la base de datos al área de memoria especificada por el handle: hProp.
Función: RPJGetJobProps.
Lanzar método de trabajo de impresión

El trabajo de impresión se inicia indicando el método PREVIEW. El trabajo de impresión en
Sí está especificado por el handle: hProp.
Función: RPJCallJobMethod.
Borrar handle
Borrar handle de una propiedad de trabajo de impresión. Los handles que se crean con
RPJCreatePropertyHandle deben borrarse si ya no se necesitan.
Función: RPJDeletePropertyHandle.
Deshacer conexión con RPJAPI.DLL

RPJDetach.

Ejemplo
void DruckAuftrag(void)
{
CMN_ERROR err; //error structure
BOOL ret;
HPROPERTIES hProp;
char jobname[200];
char method[200];
LPCSTR szProjectName = "c:\\rest\\test.mcp"; //name of project
strcpy(method, "PREVIEW");
strcpy(jobname, "Backdokumentation Control Center");
ret = RPJAttach(&err);
if (TRUE == ret)
{
hProp = RPJCreatePropertyHandle(szProjectName. &err);
if (NULL == hProp)
{
ErrMsg("Error RPJCreatePropertyHandle", &err);
}
else
{
ret = RPJGetJobProps(hProp, jobname, &err);
if (FALSE == ret)
{
ErrMsg("Error RPJGetJobProbs", &err);
}
else
{
ret = RPJCallJobMethod(hProp, method, &err);
if (FALSE == ret)
{
ErrMsg("Error executing RPJCallJobMethod", &err);
}
else
{
Msg("Print job started.");
}
}
RPJDeletePropertyHandle(hProp, &err);
}
RPJDetach(&err);
}
else
{
Msg("No connection to report designer DLL");
}
}

3.7.2 Funciones para establecer una conexión (RT Professional)
3.7.2.1 RPJAttach (RT Professional)
Descripción
Con esta función se establece e inicializa una conexión con RPJAPI.DLL.
Declaración
BOOL RPJAttach (
CMN_ERROR* pcmnerror );
Parámetros
pcmnerror
Valor de retorno
TRUE
Conexión establecida.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJDetach (Página 2116) Deshacer conexión
Consulte también
RPJDetach (Página 2116)

3.7.2.2 RPJDetach (RT Professional)
Descripción
Con esta función se deshace de nuevo una conexión ya existente con RPJAPI.DLL.
Declaración
BOOL RPJDetach (
Parámetros
pcmnerror
Valor de retorno
TRUE
La conexión se ha deshecho de nuevo.
FALSE
Error
Comentario
Nota
a los mecanismos específicos de Microsoft, puede producirse eventualmente un bloqueo de
la llamada y, en consecuencia, del programa.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJAttach (Página 2113) Establecer conexión

Consulte también
RPJAttach (Página 2113)
3.7.2.3 RPJMemFree (RT Professional)
Descripción
Con esta función se deshace de nuevo una conexión ya existente con RPJAPI.DLL y se
autoriza la memoria asignada.
Declaración
BOOL RPJMemFree (
const PVOID pvMemBlock,
Parámetros
pvMemBlock
Puntero sobre un área de la memoria que se va a liberar, asignada anteriormente por una
función RPJ.
Si pvMemBlock = NULL, no se ejecuta nada.
pcmnerror
Valor de retorno
TRUE
Se ha liberado el área de la memoria.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll

Consulte también
3.7.3 Funciones para editar propiedades del proyecto (RT Professional)
3.7.3.1 RPJGetNumProjectProperties (RT Professional)
Descripción
Esta función determina la cantidad de propiedades del proyecto.
Declaración
BOOL RPJGetNumProjectProperties (
LPCSTR pszReserved,
DWORD* pdwNumProperties
Parámetros
pszReserved
pdwNumProperties
Puntero a una variable DWORD en la que se devuelve la cantidad de propiedades.
pcmnerror
Valor de retorno
TRUE
Se ha determinado la cantidad de propiedades.
FALSE
Errores
Archivos necesarios
rpjapi.h

rpjapi.lib
rpjapi.dll
Consulte también
3.7.3.2 RPJGetProjectPropertyAt (RT Professional)
Descripción
La función determina el nombre y tipo de una propiedad por medio del índice del proyecto.
Declaración
BOOL RPJGetProjectPropertyAt (
LPCSTR pszReserved,
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPrpType,
Parámetros
pszReserved
El parámetro se reserva para ampliaciones posteriores.
dwPropIndex
Índice de las propiedades del proyecto desde el que se ha de devolver la información.
pszBuffer
Puntero a un búfer al que se ha de devolver el nombre de la propiedad. El tamaño del búfer
se indica con dwCharMax.
dwCharMax
Tamaño máximo del búfer indicado por pszBuffer
pdwPropType
Puntero a una variable DWORD en la que se devuelve el tipo de la propiedad del proyecto.
pcmnerror

Valor de retorno
TRUE
Se ha determinado el nombre y tipo de la propiedad del proyecto.
FALSE
Error
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
3.7.3.3 RPJGetProjectProperty (RT Professional)
Descripción
Esta función determina el valor de una propiedad. Se deben transmitir el nombre del proyecto
y el de la propiedad.
Declaración
BOOL RPJGetProjectProperty (
LPCSTR pszProjectName,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,
Parámetros
pszProjectName
Puntero al nombre del proyecto, compuesto de la ruta, el nombre del proyecto y la extensión.
pszPropName
Nombre de la propiedad del proyecto.

pvPropValue
Puntero en un búfer al que se ha de devolver el valor de la propiedad. El tamaño del búfer en
pvPropValue se indica con dwBufferSize.
vtPropType
Tipo en el que se espera el valor de la propiedad en el búfer pvPropValue.
VT_I4 Integer o Boolean

VT_LPSTR Texto en formato ANSI
VT_LPWSTR Texto en formato UNICODE
VT_DATE Fecha/hora
dwBufferSize
Tamaño del búfer en pvPropValue en el que se ha de devolver el valor de la propiedad. El
tamaño se debe indicar sólo en BYTE y no en CHAR.
pcmnerror
Valor de retorno
TRUE
Se ha determinado el valor de la propiedad.
FALSE
Error
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
3.7.3.4 RPJProjectLock (RT Professional)
Descripción
Se bloquea para otros el acceso a la lista de trabajo de impresión del proyecto. El nombre de
quien ha bloqueado se debe indicar en pszLockerNameNew. En caso de conflicto de acceso,
se devuelve el nombre de quien ha bloqueado a través de ppszLockerNameCur.

Declaración
BOOL RPJProjectLock (
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
Parámetros
pszProjectName
fWriteLock
Define el tipo de bloqueo.
TRUE Se bloquea para escritura y lectura.

FALSE Se bloquea sólo para lectura.
fDoNotWait
TRUE Si existe un bloqueo, se notifica un error de inmediato.

FALSE Si existe un bloqueo, primero se comprueba cíclicamente. Después de
algunos segundos se cancela con error de Timeout.
pszLockerNameNew
Contiene el nombre de quien bloquea. En caso de conflicto de acceso, se devuelve este
nombre a través de ppszLockerNameCur.
ppszLockerNameCur
En caso de un conflicto de acceso, se devuelve en ppszLockerNameCur el nombre de quien
bloquea actualmente.
pcmnerror
Valor de retorno
TRUE
Lista de trabajo de impresión bloqueada.
FALSE
Ha ocurrido un conflicto de acceso. La lista de trabajo de impresión del proyecto ya está
bloqueada. El nombre de quien bloquea se devuelve con ppszLockerNameCur.

Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJProjectUnlock (Página 2123) Eliminar un bloqueo

RPJProjectUnlockAll (Página 2124) Eliminar todos los bloqueos
Consulte también
RPJProjectUnlock (Página 2123)
RPJProjectUnlockAll (Página 2124)
3.7.3.5 RPJProjectUnlock (RT Professional)
Descripción
Se elimina el bloqueo de una lista de trabajo de impresión.
Declaración
BOOL RPJProjectUnlock (
Parámetros
pszProjectName
Puntero al nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto y
la extensión.
pcmnerror

Valor de retorno
TRUE
Se ha eliminado el bloqueo de la lista de trabajo de impresión.
FALSE
Ha ocurrido un conflicto de acceso.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJProjectLock (Página 2119) Crear bloqueo

RPJProjectUnlockAll (Página 2124) Eliminar todos los bloqueos
Consulte también
RPJProjectLock (Página 2119)
RPJProjectUnlockAll (Página 2124)
3.7.3.6 RPJProjectUnlockAll (RT Professional)
Descripción
Se eliminan todos los bloqueos de una lista de trabajo de impresión.
Declaración
BOOL RPJProjectUnlockAll (
Parámetros
pszProjectName
la extensión.

pcmnerror
Valor de retorno
TRUE
Se han eliminado todos los bloqueos de la lista de trabajo de impresión.
FALSE
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJProjectLock (Página 2119) Crear bloqueo

RPJProjectUnlock (Página 2121) Eliminar un bloqueo
Consulte también
RPJProjectLock (Página 2119)
RPJProjectUnlock (Página 2121)
3.7.4 Funciones para editar trabajos de impresión (RT Professional)
3.7.4.1 RPJCreateJob (RT Professional)
Descripción
Crea un nuevo trabajo de impresión.

Declaración
BOOL RPJCreateJob (
LPCSTR pszJobName,
Parámetros
pszProjectName
la extensión.
pszJobName
Puntero al nombre del trabajo de impresión que se va a crear.
pcmnerror
Valor de retorno
TRUE
Trabajo de impresión creado.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJDeleteJob (Página 2127) Borrar trabajo de impresión
Consulte también
RPJDeleteJob (Página 2127)

3.7.4.2 RPJDeleteJob (RT Professional)
Descripción
Se borra un trabajo de impresión especificado con pszJobName.
Declaración
BOOL RPJDeleteJob (
LPCSTR pszJobName,
Parámetros
pszProjectName
la extensión.
pszJobName
Puntero al nombre del trabajo de impresión que se va a borrar.
pcmnerror
Valor de retorno
TRUE
Trabajo de impresión borrado.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJCreateJob (Página 2123) Crear trabajo de impresión

Consulte también
RPJCreateJob (Página 2123)
3.7.4.3 RPJCreatePropertyHandle (RT Professional)
Descripción
Para poder editar las propiedades de un trabajo de impresión, primero es necesario configurar
un Handle en el trabajo de impresión con esta función. El Handle se obtiene suministrado en
valor de retorno.
Declaración
HPROPERTIES RPJCreatePropertyHandle (
Parámetros
pszProjectName
la extensión.
pcmnerror
Valor de retorno
Handle en la propiedad de trabajo de impresión.
En caso de error el valor de retorno es CERO.
Comentario
El Handle suministrado aquí es necesario, por ejemplo, para las funciones RPJGetJobProps,
RPJGetProperty y RPJSetProperty.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll

RPJDeletePropertyHandle (Página 2129) Borrar Handle

RPJPropertyClear (Página 2148) Inicializar área de memoria
RPJGetJobProps (Página 2143) Calcular propiedades de trabajo de impresión
RPJSetProperty (Página 2150) Definir propiedades de trabajo de impresión
Ejemplos
Show print job preview (Página 2167) "RD02.cpp"
Modify print job properties (Página 2162) "RD02.cpp"
Obtener nombres de trabajo de impresión (Página 2156) "RD02.cpp"
Obtener nombre de método del trabajo de impresión (Página 2153) "RD02.cpp"
Obtener propiedades del trabajo de impresión (Página 2159) "RD02.cpp"
Consulte también
Obtener nombre de método del trabajo de impresión (Página 2153)
Obtener nombres de trabajo de impresión (Página 2156)
Obtener propiedades del trabajo de impresión (Página 2159)
Modify print job properties (Página 2162)
Show print job preview (Página 2167)
RPJDeletePropertyHandle (Página 2129)
RPJGetProperty (Página 2145)
RPJGetJobProps (Página 2143)
RPJSetProperty (Página 2150)
RPJPropertyClear (Página 2148)
3.7.4.4 RPJDeletePropertyHandle (RT Professional)
Descripción
Todos los Handles creados con RPJCreatePropertyHandle deberían borrarse con esta función
cuando yo no se necesiten más.

Declaración
BOOL RPJDeletePropertyHandle (
HPROPERTIES hproperties,
Parámetros
hproperties
El Handle de la propiedad del trabajo de impresión se crea con la función
pcmnerror
Valor de retorno
TRUE
Handle borrado
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJCreatePropertyHandle (Página 2126) Crear Handle
Ejemplos

Consulte también
RPJCreatePropertyHandle (Página 2126)
3.7.4.5 RPJGetJobNameAt (RT Professional)
Descripción
Determina el nombre de un trabajo de impresión especificado por dwJobIndex.
Declaración
BOOL RPJGetJobNameAt (
DWORD dwJobIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
Parámetros
PszProjectName
la extensión.
dwJobIndex
Índice del trabajo de impresión del que debe determinarse el nombre.
pszBuffer
Puntero a un búfer de recepción en el que se ha de crear el nombre del trabajo de impresión.
dwCharMax
Tamaño del búfer de recepción en número de caracteres incluyendo la terminación cero. Este
valor debe ser mayor que 1.
pcmnerror

Valor de retorno
TRUE
Nombre del trabajo de impresión determinado.
FALSE
Errores
Comentario
Un error de índice mostrado por RPJGetJobNameAt se deba posiblemente a que se ha
modificado el número de los trabajos de impresión después de la llamada de RPJGetNumJobs.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
3.7.4.6 RPJGetNumJobs (RT Professional)
Descripción
Determina la cantidad de trabajos de impresión pendientes actualmente. Después de llamar
la función se puede modificar la cantidad borrando o añadiendo trabajos de impresión.
Declaración
BOOL RPJGetNumJobs (
DWORD* pdwNumJobs,

Parámetros
pszProjectName
la extensión.
pdwNumJobs
Puntero a la posición de memoria en la que se debe almacenar el número de trabajos de
impresión.
pcmnerror
Valor de retorno
TRUE
Cantidad de trabajos de impresión determinada.
FALSE
Error
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
3.7.4.7 RPJJobLock (RT Professional)
Descripción
Se bloquea para otros el acceso al trabajo de impresión indicado. El nombre de quien ha
bloqueado se debe indicar en pszLockerNameNew. En caso de conflicto de acceso, se
devuelve el nombre de quien ha bloqueado a través de ppszLockerNameCur.

Declaración
BOOL RPJJobLock (
LPCSTR pszJobName,
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
Parámetros
pszProjectName
pszJobName
Puntero al nombre del trabajo de impresión que se va a bloquear.
fWriteLock
Define el tipo de bloqueo.
TRUE Se bloquea para escritura y lectura.

FALSE Se bloquea sólo para lectura.
fDoNotWait
TRUE Si existe un bloqueo, se notifica un error de inmediato.

FALSE Si existe un bloqueo, primero se comprueba cíclicamente. Después de algunos
segundos se cancela con error de Timeout.
pszLockerNameNew
Contiene el nombre de quien bloquea. En caso de conflicto de acceso, se devuelve este
nombre a través de ppszLockerNameCur.
ppszLockerNameCur
En caso de un conflicto de acceso, se devuelve en ppszLockerNameCur el nombre de quien
bloquea actualmente.
pcmnerror
Valor de retorno
TRUE
Trabajo de impresión bloqueado.

FALSE
Ha ocurrido un conflicto de acceso. La lista de trabajo de impresión del proyecto ya está
bloqueada. El nombre de quien bloquea se devuelve con ppszLockerNameCur.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJJobUnlock (Página 2135) Eliminar un bloqueo

RPJJobUnlockAll (Página 2136) Eliminar todos los bloqueos
Consulte también
RPJJobUnlockAll (Página 2136)
RPJJobUnlock (Página 2135)
3.7.4.8 RPJJobUnlock (RT Professional)
Descripción
Se elimina el bloqueo de un trabajo de impresión.
Declaración
BOOL RPJJobUnlock (
LPCSTR pszJobName,
Parámetros
pszProjectName
la extensión.
pszJobName
Puntero al nombre del trabajo de impresión.

pcmnerror
Valor de retorno
TRUE
Se ha eliminado el bloqueo del trabajo de impresión.
FALSE
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJJobLock (Página 2131) Crear bloqueo

RPJJobUnlockAll (Página 2136) Eliminar todos los bloqueos
Consulte también
RPJJobUnlockAll (Página 2136)
RPJJobLock (Página 2131)
3.7.4.9 RPJJobUnlockAll (RT Professional)
Descripción
Se eliminan todos los bloqueos del trabajo de impresión indicado.
Declaración
BOOL RPJJobUnlockAll (
LPCSTR pszJobName,

Parámetros
pszProjectName
la extensión.
pszJobName
pcmnerror
Valor de retorno
TRUE
Se han eliminado todos los bloqueos del trabajo de impresión indicado.
FALSE
Ha ocurrido un conflicto de acceso
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
RPJJobLock (Página 2131) Crear bloqueo

RPJJobUnlock (Página 2133) Eliminar un bloqueo
Consulte también
RPJJobUnlock (Página 2133)
RPJJobLock (Página 2131)

3.7.5 Funciones para editar métodos de trabajos de impresión (RT Professional)
3.7.5.1 RPJCallJobMethod (RT Professional)
Descripción
Con esta función se puede fijar un determinado método de trabajo. Actualmente se diferencia
entre dos métodos: PrintJob y PreviewJob.
Declaración
RPJCallJobMethod (
LPCSTR pszMethodName
Parámetros
hproperties
pszMethodName
Puntero al nombre del método de trabajo que se va a utilizar.
pcmnerror
Valor de retorno
TRUE
Método de trabajo de impresión fijado
FALSE
Errores
Comentario
Para poder fijar un método de trabajo de impresión con RPJCallJobMethod antes se tiene que
haber ejecutado la función RPJGetJobProps.

Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
3.7.5.2 RPJGetJobMethodAt (RT Professional)
Descripción
La función determina para el nombre del método de impresión especificado en
dwMethodIndex.
Declaración
BOOL RPJGetJobMethodAt (
DWORD dwMethodIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
Parámetros
dwMethodIndex
Índice del método de impresión cuyo nombre se va a determinar.
pszBuffer
Puntero a un búfer en el que se ha de almacenar el nombre del método de impresión.
dwCharMax
Tamaño del búfer que debe registrar el nombre, en número de caracteres incluyendo la
terminación cero. Este valor debe ser mayor que 1.

pcmnerror
Valor de retorno
TRUE
Nombre del método de trabajo de impresión determinado
FALSE
Error
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
3.7.5.3 RPJGetNumJobMethods (RT Professional)
Descripción
La función determina cuántos métodos de trabajo de impresión están disponibles actualmente.
Declaración
BOOL RPJGetNumJobMethods (
DWORD* pdwNumMethods,

Parámetros
pdwNumMethods
Puntero a una posición de memoria en la que se debe guardar el número de métodos de
trabajo de impresión.
pcmnerror
Valor de retorno
TRUE
Cantidad de métodos de trabajo de impresión determinada
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
3.7.6 Funciones para editar propiedades de trabajo de impresión (RT Professional)
3.7.6.1 RPJGetJobPropertyAt (RT Professional)
Descripción
Determina el nombre y el tipo de la propiedad de trabajo especificada en dwPropindex.

Declaración
BOOL RPJGetJobPropertyAt (
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPropType,
Parámetros
dwPropIndex
Índice de las propiedades de trabajo de impresión cuyo nombre debe determinarse.
pszBuffer
Puntero al búfer que recibe el nombre de la propiedad de trabajo.
dwCharMax
Tamaño del búfer de recepción en número de caracteres incluyendo la terminación cero. Este
valor debe ser mayor que 1.
pdwPropType
Puntero a una posición de memoria en la que se almacena el tipo de propiedad de trabajo.
pcmnerror
Valor de retorno
TRUE
Nombre de la propiedad del trabajo de impresión determinado.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos

Consulte también
3.7.6.2 RPJGetJobProps (RT Professional)
Descripción
La función determina las propiedades de un trabajo de impresión y las guarda en el búfer
interno hProps.
Declaración
BOOL RPJGetJobProps (
LPCSTR pszJobName,
Parámetros
hproperties
pszJobName
pcmnerror
Comentario
Esta función es una condición para funciones como RPJGetProperty y RPJSetProperty.
Valor de retorno
TRUE
Propiedades de trabajo de impresión determinadas
FALSE
Errores

Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll

Ejemplos
Consulte también
3.7.6.3 RPJGetNumJobProperties (RT Professional)
Descripción
Determina la cantidad de propiedades de trabajo de impresión disponibles.
Declaración
BOOL RPJGetNumJobProperties (
DWORD* pdwNumProperties,

Parámetros
pdwNumProperties
Puntero a una posición de memoria en la que se debe almacenar el número de propiedades
del trabajo de impresión.
pcmnerror
Valor de retorno
TRUE
Cantidad de propiedades de trabajo de impresión determinada
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
3.7.6.4 RPJGetProperty (RT Professional)
Descripción
Antes de que se pueda determinar con RPJGetProperty el valor de la propiedad del trabajo
de impresión especificada con pszPropName, es necesario haber almacenado con
RPJGetJobProps las propiedades de trabajo en el búfer interno hProp.

Declaración
BOOL RPJGetProperty (
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,
Parámetros
hproperties
pszPropName
Puntero al nombre de la propiedad del trabajo de impresión:
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage Con estos datos se puede conseguir que la impresión del informe
termine con una página en concreto.
JobName El nombre del encargo de impresión debe ser unívoco dentro de un
proyecto y debe ser conforme a las convenciones de Windows.
LayoutName Con el nombre de diseño, se le asigna un diseño al trabajo de impre‐
sión.
PrinterName 1 Aquí se define la impresora en la que se intentará iniciar la impresión
en primer lugar.
PrinterName 2 Aquí se define la impresora que se activa cuando la primera impresora
no está disponible.
PrinterName 3 Aquí se define la impresora que se activa cuando las dos primeras
impresoras no están disponibles.
StartPage Con estos datos se puede conseguir que el informe se imprima a partir
de una página en concreto.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter

pvPropValue
Puntero al búfer que debe aceptar el nombre.
vtPropType
El tipo de la propiedad del objeto depende de pszPropName:
AbsoluteSelectionFrom VT_DATE
AbsoluteSelectionTo VT_DATE
CycleSpan VT_I4
DestinationFile VT_LPSTR
EnableCycle VT_I4
EnableStart VT_I4
EndPage VT_I4
JobName VT_LPSTR / VT_LPWSTR
LayoutName VT_LPSTR / VT_LPWSTR
PrinterName VT_LPSTR / VT_LPWSTR
PrinterName2 VT_LPSTR / VT_LPWSTR
RelativeSelectionCount VT_I4
RelativeSelectionRange VT_I4
StartPage VT_I4
StartTime VT_DATE
UseRelative VT_I4
UseOutputFile VT_I4
UseOutputPrinter VT_I4
Si se desea modificar una cadena de caracteres y la aplicación está compilada con Unicode,
es necesario utilizar como tipo de datos de vtProp VT_LPWSTR. De lo contrario vtProp es del
tipo de datos VT_LPTSTR.
Si vtProp es del tipo de datos VT_DATE, el parámetro prop deberá remitir a una estructura
SYSTEMTIME.
dwBufferSize
Tamaño del búfer al que señala prop en cantidad de bytes.
pcmnerror
Valor de retorno
TRUE
Propiedad de trabajo de impresión determinada
FALSE
Error

Comentario
El búfer se llenará en caso de que se haya seleccionado el búfer demasiado pequeño para
el registro de la propiedad de trabajo, concebible, por ejemplo, en caso del nombre del trabajo
o el nombre del diseño, pero la función devolverá el mensaje de error
ERR_UNKNOWNERROR.
Mensajes de error
ERR_UNKNOWNERROR Error desconocido
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll

Ejemplos
Consulte también
3.7.6.5 RPJPropertyClear (RT Professional)
Descripción
La utilización de la función tiene sentido si el área de memoria referenciada por un Handle
debe inicializarse sin que se borre el Handle.

Declaración
BOOL RPJPropertyClear (
Parámetros
hproperties
pcmnerror
Valor de retorno
TRUE
Memoria inicializada.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también

3.7.6.6 RPJSetProperty (RT Professional)
Descripción
Con esta función se pueden modificar temporalmente distintas propiedades de trabajo de
impresión.
Antes de que se pueda ajustar de nuevo con RPJSetProperty el valor de la propiedad del
trabajo de impresión especificada con pszPropName, es necesario haber almacenado con
RPJGetJobProps las propiedades de trabajo en el búfer interno hProp.
Declaración
BOOL RPJSetProperty (
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwReserved,
Parámetros
hproperties
Handle de las propiedades de trabajo de impresión. El Handle se crea con la función
pszPropName
Puntero al nombre de la propiedad del trabajo de impresión:
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage Con estos datos se puede conseguir que la impresión del informe
termine con una página en concreto.
JobName El nombre del encargo de impresión debe ser unívoco dentro de un
proyecto y debe ser conforme a las convenciones de Windows.
LayoutName Con el nombre de diseño, se le asigna un diseño al trabajo de impre‐
sión.
PrinterName 1 Aquí se define la impresora en la que se intentará iniciar la impresión
en primer lugar.
PrinterName 2 Aquí se define la impresora que se activa cuando la primera impresora
no está disponible.

PrinterName 3 Aquí se define la impresora que se activa cuando las dos primeras
impresoras no están disponibles.
StartPage Con estos datos se puede conseguir que el informe se imprima a partir
de una página en concreto.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
pvPropValue
Puntero al valor de la propiedad del objeto.
vtPropType
El tipo de la propiedad del objeto depende de pszPropName:
AbsoluteSelectionFrom VT_DATE
AbsoluteSelectionTo VT_DATE
CycleSpan VT_I4
DestinationFile VT_LPSTR
EnableCycle VT_I4
EnableStart VT_I4
EndPage VT_I4
JobName VT_LPSTR / VT_LPWSTR
LayoutName VT_LPSTR / VT_LPWSTR
PrinterName VT_LPSTR / VT_LPWSTR
RelativeSelectionCount VT_I4
RelativeSelectionRange VT_I4
StartPage VT_I4
StartTime VT_DATE
UseRelative VT_I4
UseOutputFile VT_I4
UseOutputPrinter VT_I4
Si se desea modificar una cadena de caracteres y la aplicación está compilada con Unicode,
es necesario utilizar como tipo de datos de vtProp VT_LPWSTR. De lo contrario vtProp es del
tipo de datos VT_LPTSTR.
Si vtProp es del tipo de datos VT_DATE, el parámetro prop deberá remitir a una estructura
SYSTEMTIME.
dwReserved

pcmnerror
Valor de retorno
TRUE
Propiedad de trabajo de impresión modificada temporalmente
FALSE
Error
Comentario
Con las funciones RPJGetNumJobProperties y RPJGetJobPropertyAt se pueden determinar
todas las propiedades de trabajo de impresión disponibles.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll

Ejemplos
Consulte también

3.7.7.1 Obtener nombre de método del trabajo de impresión (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Get print job methodname (RPT)}

//{{FUNCTION}RPJCreatePropertyHandle (RPT)}
//{{FUNCTION}RPJDeletePropertyHandle (RPT)}
//{{FUNCTION}RPJGetNumJobMethods (RPT)}
//{{FUNCTION}RPJGetJobMethodAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyPrintJobPropertyInquire( void ) ODK RD RT
// =====================================================================
// : Get print job methodname (Enum) !
// =====================================================================
void MyRPJGetJobMethodAt(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
HPROPERTIES hProp = NULL;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD i = 0L;
char buf[500+1];
DWORD dwBufsize = 500L;
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("--------------------"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobMethodAt:"));
ODKTrace(szText);
ret = RPJAttach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJAttach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJAttach"));
ODKTrace(szText);
}
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE); // print job
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)

{
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJCreatePropertyHandle = 0x
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetNumJobMethods(&d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetNumJobMethods:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
ret = RPJGetJobMethodAt(i, buf, dwBufsize, &Error);
if (ret == FALSE)
{
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobMethod=
%s"),i+1,buf);
}
ODKTrace(szText);
}
}
ret = RPJDeletePropertyHandle(hProp, &Error);

if (FALSE == ret)
{
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
Consulte también
RPJGetJobMethodAt (Página 2137)
RPJGetNumJobMethods (Página 2138)

3.7.7.2 Obtener nombres de trabajo de impresión (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Get print job names (RPT)}

//{{FUNCTION}RPJGetNumJobs (RPT)}
//{{FUNCTION}RPJGetJobNameAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyRPJGetJobNameAt( void ) ODK RD RT
// =====================================================================
// : Get all print job names (Enum) !
// =====================================================================
void MyRPJGetJobNameAt(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD i = 0L;
char buf[500+1];
DWORD dwBufsize = 500;
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobNameAt:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);
}
if(NULL == hProp)
{


ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetNumJobs(/*PROJ_PATH*/g_szProjectFile, &d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetNumJobs: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
ret = FALSE;
ret = RPJGetJobNameAt(/*PROJ_PATH*/g_szProjectFile, i, buf, dwBufsize, &Error);
if (ret == FALSE)
{
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobName=
%s"),i+1, buf);
}
ODKTrace(szText);
}
}
ret = FALSE;
if (ret == FALSE)

{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
Consulte también
RPJGetJobNameAt (Página 2129)
RPJGetNumJobs (Página 2130)

3.7.7.3 Obtener propiedades del trabajo de impresión (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Get print job properties (RPT)}

//{{FUNCTION}RPJGetNumJobProperties (RPT)}
//{{FUNCTION}RPJGetJobPropertyAt (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyRPJGetJobPropertyAt( void ) ODK RD RT
// =====================================================================
// : Inquire print job properties (Enum) !
// =====================================================================
void MyRPJGetJobPropertyAt(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR jobname[255];
TCHAR szText[255];
DWORD d = 0L;
DWORD f = 0L;
DWORD i = 0L;
char buf[500+1];
DWORD dwBufsize = 500L;
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyRPJGetJobPropertyAt:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);
}
if(NULL == hProp)
{


ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetNumJobProperties(&d, &Error);
if(FALSE == ret)
{
RPJGetNumJobProperties: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
ret = RPJGetJobPropertyAt(i, buf, dwBufsize, &f, &Error);
if (FALSE == ret)
{
RPJGetJobPropertyAt: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobProperty=
%s"),i+1, buf);
}
ODKTrace(szText);
}
}
if (FALSE == ret)

{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
Consulte también
RPJGetJobPropertyAt (Página 2139)
RPJGetNumJobProperties (Página 2142)

3.7.7.4 Modify print job properties (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Modify print job properties (RPT)}

//{{FUNCTION}RPJGetJobProps (RPT)}
//{{FUNCTION}RPJGetProperty (RPT)}
//{{FUNCTION}RPJSetJobProps (RPT)}
//{{FUNCTION}RPJSetProperty (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyModifyPrintJob( void ) ODK RD RT
// =====================================================================
// : Modify print job properties (change starttime) !
// =====================================================================
void MyModifyPrintJob(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
SYSTEMTIME st;
LPVOID ptr;
DWORD typ;
TCHAR jobname[200];
TCHAR propname[200];
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyModifyPrintJob:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);
}
// read properties
if(NULL == hProp)
{


ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE);
ret = RPJGetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
ret = RPJDeletePropertyHandle (hProp, &Error);
if(ret == FALSE)
{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}

ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetJobProps"));
ODKTrace(szText);
}
typ = VT_DATE;
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE);
_tcsncpy_s(propname, _countof(propname), _T("STARTTIME"), _TRUNCATE);
memset(&st, 0, sizeof(SYSTEMTIME));
ptr = (LPVOID)&st;
ret = RPJGetProperty (hProp, propname, ptr, (VARTYPE)typ, 16, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetProperty: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Jobname=%s Propname=
%s"),jobname,propname);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %02d.%02d.%04d %02d:
%02d:%02d"),
(WORD)st.wDay,
(WORD)st.wMonth,
(WORD)st.wYear,
(WORD)st.wHour,
(WORD)st.wMinute,
(WORD)st.wSecond);
}
ODKTrace(szText);
// write properties
st.wHour = 11;
st.wMinute = 12;
st.wSecond = 13;
ret = RPJSetProperty (hProp, propname, ptr, (VARTYPE) typ, 16, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJSetProperty: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Jobname=%s ;Propname=
%s"),jobname,propname);

ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %02d.%02d.%04d %02d:
%02d:%02d"),
(WORD)st.wDay,
(WORD)st.wMonth,
(WORD)st.wYear,
(WORD)st.wHour,
(WORD)st.wMinute,
(WORD)st.wSecond);
}
ODKTrace(szText);
ret = RPJSetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJSetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetJobProps"));
}
ODKTrace(szText);
if(FALSE == ret)
{
}
else
{
}
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("RPJDeletePropertyHandle")); }
ODKTrace(szText);
}

Consulte también

3.7.7.5 Show print job preview (RT Professional)
Ejemplo
// =====================================================================
// =====================================================================
// : Modul with examples of Report Designer
// *********************************************************************
// Copyright (C) 1995-99 SIEMENS AG, A&D PT1 D2 All rights reserved
// *********************************************************************
#include "RD02.h"
#include "DM01.h"
//{{ODK_EXAMPLE}Show print job preview (RPT)}

//{{FUNCTION}RPJGetJobProps (RPT)}
//{{FUNCTION}RPJCallJobMethod (RPT)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyShowPrintJobPreview( void ) ODK RD RT
// =====================================================================
// : Show print job preview
// =====================================================================
void MyShowPrintJobPreview(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
CMN_ERROR Error;
TCHAR jobname[200];
TCHAR methode[200];
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("MyShowPrintJobPreview:"));
ODKTrace(szText);
if (FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
return;
}
else
{
ODKTrace(szText);

}
if(NULL == hProp)
{
ODKTrace(szText);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
return;
}
else
{
%08lx"), hProp);
ODKTrace(szText);
}
ret = RPJGetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
if(FALSE == ret)
{
}
else
{
}
ODKTrace(szText);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}

else
{
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetJobProps"));
ODKTrace(szText);
}
_tcsncpy_s(methode, _countof(methode), _T("PREVIEW"), _TRUNCATE); // preview
// _tcsncpy_s(methode, _countof(methode), _T("PRINTJOB"), _TRUNCATE); // print
// _tcsncpy_s(methode, _countof(methode), _T("SETSELECTIONALLPAGES"), _TRUNCATE);
ret = RPJCallJobMethod (hProp, methode, &Error);
if(FALSE == ret)
{
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJCallJobMethod"));
}
ODKTrace(szText);
if(FALSE == ret)
{
}
else
{
}
ODKTrace(szText);
if(FALSE == ret)
{
%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}

3.8 Funciones para variables y ficheros (RT Professional)
Consulte también
RPJCallJobMethod (Página 2136)
Resumen
TLG_ENUM_ARCHIV_CALLBACK (Página 2246) Listar ficheros (Callback)

TLG_ENUM_PROJECT_NAME_CALLBACK (Pá‐ Listar proyectos (Callback)
gina 2236)
AUTOHOTSPOT Listar entradas en plantillas de curvas (Callback)
TLG_ENUM_TIME_NAME_CALLBACK (Pági‐ Listar objetos de tiempo (Callback)
na 2283)
TLG_ENUM_VARIABLE_NAME_CALLBACK (Pá‐ Listar variables (Callback)
gina 2239)
TLG_ENUMBACKUP_ENTRIES (Página 2289) Listar copias de seguridad (Callback)
TLG_ENUMTABLES (Página 2253) Listar ficheros (Callback)
TLG_ENUMTIMES_CALLBACK (Página 2285) Listar objetos de tiempo (Callback)
TLG_ENUMVARIABLES (Página 2242) Listar variables (Callback)
TLG_GETARCHIVDATA_CALLBACK (Pági‐ Leer datos de un fichero (Callback)
na 2258)
TLGChangeLanguage (Página 2228) Cambio de idioma
TLGCloseProject (Página 2232) Cerrar proyecto
TLGCloseWindow (Página 2273) Cerrar trabajo de impresión/diagnóstico de script
TLGConnect (Página 2229) Establecer conexión con Tag Logging RT
TLGCSConnectEx (Página 2225) Establecer conexión con Tag Logging CS
TLGCSConnect (Página 2224) Establecer conexión con Tag Logging CS
TLGDisconnect (Página 2230) Deshacer conexión con Tag Logging RT
TLGDrawCurvesInDC (Página 2274) Representar curvas
TLGEnumArchives (Página 2245) Listar ficheros
TLGEnumArchivsEx (Página 2249) Listar ficheros
TLGEnumArchivs (Página 2247) Listar ficheros
TLGEnumArchivsSel (Página 2251) Listar ficheros

TLGEnumBackupEntries (Página 2288) Listar copias de seguridad

TLGEnumProject (Página 2235) Listar proyectos
TLGEnumTime (Página 2281) Listar objetos de tiempo
TLGEnumTimes (Página 2284) Listar objetos de tiempo
TLGEnumVariablesEx (Página 2240) Listar variables
TLGEnumVariables (Página 2237) Listar variables
TLGExport (Página 2291) Trasvasar fichero
TLGFreeMemory (Página 2255) Habilitar memoria
TLGGetArchivDataEx (Página 2259) Leer datos de un fichero
TLGGetArchivData (Página 2256) Leer datos de un fichero
TLGGetBackupSize (Página 2293) Determinar el tamaño de un registro exportado
TLGGetClosestTimeEx (Página 2264) Determinar el momento de archivación
TLGGetClosestTime (Página 2262) Determinar el momento de archivación
TLGInsertArchivData (Página 2266) Insertar datos en un fichero
TLGInsertTemplateItem (Página 2275) Escribir entadas en plantillas de ventanas de cur‐
vas, escribir entradas en plantillas de ventanas de
tablas
TLGLockArchiv (Página 2269) Habilitar fichero, bloquear fichero
TLGLockVariable (Página 2270) Habilitar variable, bloquear variable
TLGOpenProject (Página 2233) Abrir un proyecto
TLGPressToolbarButton (Página 2277) Activar botones de la barra de herramientas
TLGReadArchiv (Página 2271) Leer parámetros de fichero
TLGReadTime (Página 2287) Determinar parámetros del objeto de tiempo
TLGReadVariable (Página 2243) Determinar parámetros de las variables
TLGSetRulerWindowVisible (Página 2279) Mostrar también la ventana de líneas de lectura
TLGShowWindow (Página 2280) Mostrar trabajo de impresión/diagnóstico de script
Sinopsis
TLG_ARCHIV_STR (Página 2184) Parámetros de fichero

TLG_ARCHIVDATARAW (Página 2187) Datos de fichero
TLG_BACKUP_TABLE_INFO (Página 2190) Información sobre la tabla de trasvase.
TLG_CURVESCALEX (Página 2192) Escala del eje x
TLG_CURVESCALEY (Página 2197) Escala del eje y
TLG_GETARCHIVDATA (Página 2201) Datos de fichero de ficheros de valores de proce‐
so, datos de fichero de ficheros comprimidos
TLG_IO_BACKUP_SELECT (Página 2202) Criterios de selección para funciones de copia de
seguridad
TLG_PROT_CURVE_INFOS (Página 2203) Estructura de informe de curvas
TLG_TABLE_INFO (Página 2206) Estructura de informe de tablas
TLG_SCAL_STR (Página 2205) Valores límite de una variable
TLG_TABLESCALE (Página 2207) Columna de tabla (propiedades)

TLG_TEMPLATEITEM_INFO (Página 2210) Curva (propiedades) Columna de tabla (propieda‐

des)
TLG_TIME_STR (Página 2212) Objeto de tiempo
TLG_TIMEDATA (Página 2213) Objeto de tiempo
TLG_TPLITEM_CURVE (Página 2214) Curva (propiedades)
TLG_TPLITEM_INFO (Página 2215) Curva (propiedades) Columna de tabla (propieda‐
des)
TLG_TPLITEM_TABLE (Página 2216) Columna de tabla (propiedades)
TLG_VAR_STR (Página 2217) Variable (propiedades)
TLG_VARIABLE_INFO (Página 2223) Variable
Sinopsis
CMN_ERROR:
TLG_API_ERROR 0x10000000 Error no especificado

TLG_API_NO_TIME_EXIST 0x10000001 No existe ningún objeto de tiem‐
po
TLG_API_TIME_NAME_EXIST 0x10000002 Ya existe un objeto de tiempo
con este nombre.
TLG_API_TIME_NAME_NOT_EXIST 0x10000003 No se ha encontrado ningún ob‐
jeto de tiempo con este nombre
TLG_API_NO_ARCHIV_EXIST 0x10000004 Ningún fichero disponible
TLG_API_ARCHIV_NAME_EXIST 0x10000005 Ya existe un fichero con este
nombre
TLG_API_ARCHIV_NAME_NOT_EXIST 0x10000006 No se ha encontrado ningún fi‐
chero con este nombre
TLG_API_INVALID_ARCHIV_TYP 0x10000007 Tipo de fichero no válido
TLG_API_NO_VARIABLE_EXIST 0x10000008 No hay ninguna variable
TLG_API_VARIABLE_NAME_EXIST 0x10000009 Ya existe una variable con este
nombre
TLG_API_VARIABLE_NAME_NOT_EXIST 0x1000000A No se ha encontrado ninguna va‐
riable con este nombre
TLG_API_VARTYPE_MISMATCH 0x1000000B Tipo de variable erróneo
TLG_API_SRC_NO_VARIABLE_EXIST 0x1000000C SRC: No hay ninguna variable
TLG_API_SRC_VARIABLE_NAME_NOT_EXIST 0x1000000D SRC: No se ha encontrado nin‐
guna variable con este nombre
TLG_API_SRC_ARCHIV_NOT_EXIST 0x1000000E SRC: El fichero no se ha encon‐
trado
TLG_API_NO_FIELD_EXIST 0x1000000F No hay campos disponibles
TLG_API_FIELD_NAME_EXIST 0x10000010 Ya existe un campo con este
nombre
TLG_API_FIELD_NAME_NOT_EXIST 0x10000011 No se ha encontrado ningún
campo con este nombre

TLG_API_NO_PROJECT_EXIST 0x10000012 No existe ningún proyecto

TLG_API_PROJECT_NAME_NOT_EXIST 0x10000013 Nombre de proyecto no encon‐
trado
TLG_API_PROJECT_IS_ACTIVE 0x20000014 El proyecto está activado
TLG_API_NO_CONNECTION 0x10000015 No se ha establecido conexión
con un proyecto activado
TLG_API_RENAME_NAME_EXIST 0x10000016 El nuevo nombre que debe asig‐
narse ya existe
TLG_API_NAME_WRONG_CHAR 0x10000017 Carácter incorrecto en el nombre
TLG_API_NAME_TOLONG 0x10000018 El nombre es demasiado largo
TLG_API_ERR_ARCHIVSTYLE 0x10000019 Error en el diseño del fichero
TLG_API_NO_TYP_CHANGE_ALLOWED 0x1000001A Modificación de tipo no permitida
TLG_API_ERR_SUPPLY 0x1000001B Se ha producido un error
TLG_API_INVALID_PARAM 0x1000001C Asignación de parámetros no vá‐
lida / incorrecta
TLG_API_NOT_SUPPORTED 0x1000001D Función no soportada
TLG_API_NO_INTERFACE 0x1000001E Error en el acceso a interfaces
COM subordinadas
TLG_API_NODEFAULTSERVER 0x10000021 Ningún servidor estándar confi‐
gurado
TLG_API_NOLOCALSERVER 0x10000022 No hay ningún servidor local dis‐
ponible
TLG_API_NOSERVER 0x10000023 Ningún servidor estándar confi‐
gurado y ningún servidor local
disponible
TLG_API_NOMC 0x10000024 No hay ningún proyecto multi‐
cliente (aquí no se utiliza)
TLG_API_NOMCDEFAULTSERVER 0x10000025 No hay ningún proyecto multi‐
cliente pero "@default::" se ha
indicado como prefijo de servi‐
dor (aquí no se utiliza)
TLG_API_UNKNOWN_ERROR 0x10000030 Error desconocido de Callback
(a partir de WinCC V6.2)
TLG_API_ASYNC_TIMEOUT 0x10000031 Función asíncrona cancelada
con timeout
TLG_API_EXPORT_NO_WRITE 0x10000032 El archivo de exportación no se
ha escrito
TLG_API_CORRUPT_DATA 0x10000033 Datos inservibles/defectuosos
IDS_API_ERROR_CREATING_CLIENT_WND 30001 No se ha podido crear la ventana
de cliente
IDS_API_ERROR_WINDOW_NOT_FOUND 30002 No se ha podido encontrar el bo‐
tón (ventana)

Ventana de runtime
TLG_CURVE_WINDOW 0x00000001 Ventana de curvas

TLG_TABLE_WINDOW 0x00000002 Ventana de tablas
TLG_CTRL_WINDOW 0x00000004 Ventana de control TLGRT
Funciones de trasvase
TLG_BACKUP_EXPORT 0x00000001 Trasvase sin borrado de los datos fuente.

TLG_BACKUP_EVACUATE 0x00000002 Trasvase con borrado de los datos fuente.
TLG_BACKUP_DELETE 0x00000004 Borrar los registros sin trasvase.
TLG_BACKUP_RAW 0x00000008 No tratar fichero de forma especial en caso de cam‐
bio.
Formatos de exportación/importación
TLG_BAKFMT_CSV 0x00000001 Formato CSV (Comma Seperated Value)
Funciones de almacenamiento local
TLG_RESTORE_OVERWRITE 0x00000001 Importación con sobrescritura.

TLG_RESTORE_MERGE 0x00000002 Importación con comprobación, errores mediante
Callback.
TLG_RESTORE_BREAK 0x00000004 Cancelación de la importación en caso de error
Tipos de fichero
TLG_ARCTYP_USER 0x00000001 Fichero de usuario

(a partir de WinCC V5.0 ya No se soporta)
TLG_ARCTYP_PROCESS 0x00000002 Fichero de valores de proceso
TLG_ARCTYP_COMPRESS 0x00000004 Fichero comprimido
Tipos de ficheros
TLG_ARCTYP_ALL 0x00000000 Fichero circular o de continuación

TLG_ARCTYP_CIRCULAR 0x00010000 Fichero circular
TLG_ARCTYP_FOLLOW 0x00020000 Fichero de continuación

Flags de fichero
TLG_API_FLG_FAST_INSERT 0x00000001 A partir de WinCC V6.0 SP1: Inserción rápida de

datos en servidor SQL con TLGInsertArchivData
Plantillas de ventana
TLG_TEMPLATE_ALL 0x00000000 Todas las plantillas de ventana

TLG_TEMPLATE_CURVE 0x00000001 Plantilla de ventana de curvas
TLG_TEMPLATE_TABLE 0x00000002 Plantilla de ventana de tabla
TLG_TYP_TEMPLATE_CURVE 0x00800001 Plantilla de ventana de curvas
TLG_TYP_TEMPLATE_TABLE 0x00800002 Plantilla de ventanas de tabla
Plantillas
TLG_TEMPLATEITEM_ALL 0x00000000 Todos los elementos de plantilla

TLG_TEMPLATEITEM_CURVE 0x00000001 Elementos de plantilla de curvas
TLG_TEMPLATEITEM_TABLE 0x00000002 Elementos de plantilla de tabla
Cambios de elementos de plantillas
TLG_TI_ACTION_COLOR 0x00000001 Cambiar color

TLG_TI_ACTION_SCALE_X 0x00000002 Cambiar escala X
TLG_TI_ACTION_SCALE_Y 0x00000004 Cambiar escala Y
TLG_TI_ACTION_VISIBLE 0x00000005 Cambiar entre visible e invisible
TLG_TI_ACTION_RANGE_X 0x00000006 Área de visualización eje X
TLG_TI_ACTION_RANGE_Y 0x00000007 Área de visualización eje Y
Valores límite
TLG_MAX_SQL_SELECT 512 Longitud máxima de un comando SQL

TLG_MAX_TEMPLATE_NAME 32 Longitud máxima del nombre de una plantilla
de ventana de curva o tabla
TLG_MAX_TEMPLATEITEM_NAME 32 Longitud máxima del nombre de una plantilla
de curva o tabla
TLG_MAX_FUNCTION_NAME 32 Longitud máxima del nombre de una acción o
función.
TLG_MAX_DLL_NAME 32 Longitud máxima del nombre de una DLL.
TLG_MAX_STD_TEXT_NAME 32 TLGSetTemplateData
TLG_SETDATA_DEFAULT 0x00000000 y=f(x)
TLG_SETDATA_RESET 0x00000001 El búfer de curvas se borra.

TLG_SETDATA_TIME_RANGE_X 0x00000002 Los valores x deben interpretarse como rango

de tiempo: y=f(t).
TLG_SETDATA_TIME_RANGE_Y 0x00000004 Los valores y deben interpretarse como rango
de tiempo: x=f(t).
Formas de curva
TLG_CURVEFORM_STEP 0x00000011 Representación de los valores de variables en

forma de curva escalonada.
TLG_CURVEFORM_POINTS 0x00000012 Representación de los valores de variables
como puntos individuales.
TLG_CURVEFORM_DIRECT 0x00000014 Interpolar los valores de variables linealmente.
TLG_CURVEFORM_ DIRFILL 0x00000021
TLG_CURVEFORM_ STEPFILL 0x00000022
Tipos de áreas de datos
TLG_DATATYP_TIMERANGE 0x00000001
TLG_DATATYP_USERARCHIV 0x00000002
TLG_DATATYP_BLOCKDATA 0x00000004
Rangos de tiempo
TLG_TR_MINUTE 1
TLG_TR_HOUR 2
TLG_TR_DAY 3
TLG_TR_WEEK 4
TLG_TR_MONTH 5
TLG_TR_YEAR 6
Ejes
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
Conexión de informe
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
Leer datos de fichero
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
Botones de la barra de herramientas Runtime
Botones para curvas y tablas
TLG_BASIC_BTN_HELP 0x00000001 Identificador del botón para acceder a la

Ayuda en pantalla.
TLG_BASIC_BTN_DLG 0x00000002 Identificador del botón para abrir el diálo‐
go de parametrización de plantillas de
ventanas de curva y tabla.
TLG_BASIC_BTN_FIRST 0x00000004 Identificación del botón para la visualiza‐
ción de los primeros registros de un fiche‐
ro.
TLG_BASIC_BTN_PREV 0x00000008 Identificador del botón para retroceder en
el fichero.
TLG_BASIC_BTN_NEXT 0x00000010 Identificador del botón para avanzar en el
fichero.
TLG_BASIC_BTN_LAST 0x00000020 Identificador del botón para la visualiza‐
ción de los últimos registros de un fichero.
TLG_BASIC_BTN_STARTSTOP 0x00000040 Identificador del botón para detener o
continuar la representación actualizada
de una curva o tabla.
TLG_BASIC_BTN_PREV_ITEM 0x00000800 Curva anterior en primer plano o columna
de tabla primero.

TLG_BASIC_BTN_NEXT_ITEM 0x00001000 Siguiente curva en primer plano o colum‐

na de tabla primero.
TLG_BASIC_BTN_ARC_VAR_SELECT 0x00000100 Abre el diálogo de selección de las varia‐
bles del fichero.
TLG_BASIC_BTN_ITEM_SELECT 0x00000200 Abre el diálogo de selección para curvas
o columnas de tabla.
TLG_BASIC_BTN_TIME_SELECT 0x00000400 Abre el diálogo de selección para el rango
de tiempo de representación.
Botones para curvas
TLG_CURVE_BTN_ZOOMIN 0x01000000 Identificador del botón para activar la función de

zoom para aumentar la sección. El tamaño de la
sección aumentada sólo puede definirse con el
ratón.
TLG_CURVE_BTN_ZOOMOUT 0x02000000 Identificador del botón para desactivar la función
de zoom. No se cambia a la representación nor‐
mal.
TLG_CURVE_BTN_LINEAL 0x04000000 Identificador del botón para activar o desactivar
la regla para determinar las coordenadas de un
punto de medición.
TLG_CURVE_BTN_1_TO_1 0x08000000 Identificador del botón para cambiar a la repre‐
sentación normal de una curva.
Botones para tablas
TLG_TABLE_BTN_EDIT 0x00040000 Identificador del botón para activar o desactivar

la función de edición.
Definiciones de campo para estructuras
PDE_DB_PRJ_PROJNAME_MAX_LENGHT 128
TLG_DB_PRJ_PROJNAME_MAX_LENGHT
PDE_DB_PRJ_COMMENT_MAX_LENGHT 200
TLG_DB_PRJ_COMMENT_MAX_LENGHT
PDE_DB_PRJ_USERDATE_MAX_LENGHT 12
TLG_DB_PRJ_USERDATE_MAX_LENGHT
PDE_DB_PRJ_USERNAME_MAX_LENGHT 30
TLG_DB_PRJ_USERNAME_MAX_LENGHT
PDE_DB_ARC_NAME_MAX_LENGHT 32
TLG_DB_ARC_NAME_MAX_LENGHT
PDE_DB_ARC_NAME_MAX_LENGHT 32
TLG_DB_ARC_NAME_MAX_LENGHT
TLG_DB_ARC_USER_NAME_MAX_LENGHT 8
PDE_DB_ARC_SERVERNAME_MAX_LENGHT 50
TLG_DB_ARC_SERVERNAME_MAX_LENGHT
PDE_DB_ARC_COMMENT_MAX_LENGHT 100
TLG_DB_ARC_COMMENT_MAX_LENGHT

PDE_DB_ARC_ACTIONNAME_MAX_LENGHT 30
TLG_DB_ARC_ACTIONNAME_MAX_LENGHT
PDE_DB_VAR_NAME_MAX_LENGHT 64
TLG_DB_VAR_NAME_MAX_LENGHT
TLG_DB6_VAR_NAME_MAX_LENGHT 128
TLG_DB_MCP_VAR_MAME_MAX_LENGTH 128
PDE_DB_VAR_COMMENT_MAX_LENGHT 100
TLG_DB_VAR_COMMENT_MAX_LENGHT
PDE_DB_VAR_WRITEBACK_MAX_LENGHT 64
TLG_DB_VAR_WRITEBACK_MAX_LENGHT
TLG_DB6_VAR_WRITEBACK_MAX_LENGHT 128
PDE_DB_VAR_CYCLENAME_MAX_LENGHT 30
TLG_DB_VAR_CYCLENAME_MAX_LENGHT
PDE_DB_VAR_SIGNALTEX_MAX_LENGHT 30
TLG_DB_VAR_SIGNALTEX_MAX_LENGHT
PDE_DB_VAR_DLLNAME_MAX_LENGHT 30
TLG_DB_VAR_DLLNAME_MAX_LENGHT
PDE_DB_VAR_FUNCNAME_MAX_LENGHT 30
TLG_DB_VAR_FUNCNAME_MAX_LENGHT
PDE_DB_VAR_UNITDIR_MAX_LENGHT 30
TLG_DB_VAR_UNITDIR_MAX_LENGHT
PDE_DB_VAR_UNITSTR_MAX_LENGHT 64
TLG_DB_VAR_UNITSTR_MAX_LENGHT
TLG_DB6_VAR_UNITSTR_MAX_LENGHT 128
PDE_DB_FUNCNAME_MAX_LENGHT 30
TLG_DB_FUNCNAME_MAX_LENGHT
PDE_DB_DLLNAME_MAX_LENGHT 30
TLG_DB_DLLNAME_MAX_LENGHT
PDE_DB_SCALE_MAX_LENGHT 30
TLG_DB_SCALE_MAX_LENGHT
PDE_DB_TIMENAME_MAX_LENGHT 30
TLG_DB_TIMENAME_MAX_LENGHT
PDE_DB_FIELDNAME_MAX_LENGHT 64
TLG_DB_FIELDNAME_MAX_LENGHT
PDE_DB_STRUCTNAME_MAX_LENGHT 30
TLG_DB_STRUCTNAME_MAX_LENGHT
Definiciones de campo VARIANT-Record de variable de fichero

Para TLGCSCreateTagMulti, TLGCSReadTagMulti y TLGCSModifyTagMulti
Véase el archivo Include pde_typ.h

Estas funciones están disponibles a partir de WinCC V6.2.
Definición en Índice de campo Definición de tipo Tipo Observación/res‐

ENUM_TLG_TAG correspondiente tricción
_FIELDINDEX
ENUM_TLG_TAG 0 VT_TLG_TAG_EN VT_I4 Definido interna‐
_ENUMTYPE UMTYPE mente (valor >=
8), No puede cam‐
biarse
ENUM_TLG_TAG 1 VT_TLG_TAG_VE VT_I4 Definido interna‐
_VERSION RSION mente (valor >=
1), No puede cam‐
biarse
ENUM_TLG_TAG 2 VT_TLG_TAG_CR VT_I4
_CREATORID EATORID
ENUM_TLG_TAG 3 VT_TLG_TAG_NA VT_BSTR Necesario para
_NAME ME Create
ENUM_TLG_TAG 4 VT_TLG_TAG_AR VT_BSTR Necesario para
_ARCHIVNAME CHIVNAME Create
ENUM_TLG_TAG 5 VT_TLG_TAG_TY VT_I4 Necesario para
_TYPE PE Create
ENUM_TLG_TAG 6 VT_TLG_TAG_W VT_BSTR
_WRITEBACKNA‐ RITEBACKNAME
ME
ENUM_TLG_TAG 7 VT_TLG_TAG_CO VT_BSTR
_COMMENT MMENT
ENUM_TLG_TAG 8 VT_TLG_TAG_AR VT_I4
_ARCTYPE CTYPE
ENUM_TLG_TAG 9 VT_TLG_TAG_SU VT_I4
_SUPPLYTYPE PPLYTYPE
ENUM_TLG_TAG 10 VT_TLG_TAG_LO VT_I4
_LOCKED CKED
ENUM_TLG_TAG 11 VT_TLG_TAG_SC VT_BSTR Necesario para
_SCANTIME ANTIME Create
NUM_TLG_TAG_ 12 VT_TLG_TAG_AR VT_BSTR Necesario para
ARCTIME CTIME Create
ENUM_TLG_TAG 13 VT_TLG_TAG_AR VT_I4 Necesario para
_ARCFACTOR CFACTOR Create
ENUM_TLG_TAG 14 VT_TLG_TAG_VA VT_I4
_VARCOUNT‐ RCOUNTFOR‐
FORWARD WARD
_VARCOUNT‐ RCOUNTBACK‐
BACKWARD WARD
ENUM_TLG_TAG 16 VT_TLG_TAG_SA VT_I4
_SAVEBYFAULT VEBYFAULT
ENUM_TLG_TAG 17 VT_TLG_TAG_AR VT_I4 Necesario para
_ARCTRIGGER CTRIGGER Create
ENUM_TLG_TAG 18 VT_TLG_TAG_ST VT_BSTR
_STATETEXT‐ ATETEXTHIGH
HIGH


_FIELDINDEX
ENUM_TLG_TAG 19 VT_TLG_TAG_ST VT_BSTR
_STATETEX‐ ATETEXTLOW
TLOW
_VARPRO RPRO
ENUM_TLG_TAG 21 VT_TLG_TAG_FU VT_BSTR
_FUNCVALPRO NCVALPRO
ENUM_TLG_TAG 22 VT_TLG_TAG_DL VT_BSTR
_DLLVARPRO LVARPRO
_FUNCSTARTE‐ NCSTARTEVENT
VENT
_DLLSTARTE‐ LSTARTEVENT
VENT
_FUNCSTOPE‐ NCSTOPEVENT
VENT
_DLLSTOPE‐ LSTOPEVENT
VENT
_FUNCDYNAMIC NCDYNAMIC
_DLLDYNAMIC LDYNAMIC
ENUM_TLG_TAG 29 VT_TLG_TAG_UN VT_BSTR
_UNITDIRECT ITDIRECT
ENUM_TLG_TAG 30 VT_TLG_TAG_NA VT_BSTR
_NAMEUNITS‐ MEUNITSTRUCT
TRUCT
ENUM_TLG_TAG 31 VT_TLG_TAG_UN VT_I4
_UNITINDEX ITINDEX
ENUM_TLG_TAG 32 VT_TLG_TAG_VA VT_R8
_VARUPPER RUPPER
ENUM_TLG_TAG 33 VT_TLG_TAG_VA VT_R8
_VARLOWER RLOWER
ENUM_TLG_TAG 34 VT_TLG_TAG_AR VT_R8
_ARCUPPER CUPPER
_ARCLOWER CLOWER
_NAMESCALE MESCALE
_NAMESOUR‐ MESOURCEARC
CEARC
_NAMESOURCE‐ MESOURCEVAR
VAR


_FIELDINDEX
_NAMERAWVAR MERAWVAR
ENUM_TLG_TAG 40 VT_TLG_TAG_CO VT_BSTR
_CONVDLL NVDLL
ENUM_TLG_TAG 41 VT_TLG_TAG_PR VT_BSTR Necesario para
_PROCVARNAME OCVARNAME Create
ENUM_TLG_TAG 42 VT_TLG_TAG_TI‐ VT_BSTR Definido interna‐
_TIMEMODIFY MEMODIFY mente (nuevo se‐
llo de tiempo para
Create y Modify),
No puede modifi‐
carse
ENUM_TLG_TAG 43 VT_TLG_TAG_AR VT_I4
_ARCONCHAN‐ CONCHANGE
GE
_ARCONHYSTE‐ CONHYSTERESE
RESE
ENUM_TLG_TAG 45 VT_TLG_TAG_FL VT_I4
_FLAGS AGS
ENUM_TLG_TAG 46 VT_TLG_TAG_ALI VT_BSTR
_ALIAS AS
ENUM_TLG_TAG 47 VT_TLG_TAG_VA VT_BSTR
_VARSTARTE‐ RSTARTEVENT
VENT
ENUM_TLG_TAG 48 VT_TLG_TAG_VA VT_BSTR
_VARSTOPE‐ RSTOPEVENT
VENT
ENUM_TLG_TAG 49 VT_TLG_TAG_PR VT_BSTR
_PRECISION ECISION
ENUM_TLG_TAG 50 VT_TLG_TAG_TA VT_I4 Definido interna‐
_TAGID GID mente, No puede
cambiarse
Flags de variables de fichero

Véase Include-Datei pde_typ.h ENUM_TLG_TAG_FLAGVALUES a partir de WinCC V6.2
ENUM_TLG_TAG_FLAGVALUE_NOFLAGS 0 Valor predeterminado

ENUM_TLG_TAG_FLAGVALUE_LONG‐ 1
TERM_DISABLE
ENUM_TLG_TAG_FLAGVALUE_ARCHI‐ 2
VING_ON_SEGMENTCHANGE

Flags de selección para TLGCSReadTagMulti y TLGCSModifyTagMulti

Estas funciones están disponibles a partir de WinCC V6.2.
TLG_TAG_SELECTION_BY_NAME 1 Selección con nombre de archi‐

vo y de variable, repectivamente.
--- --- ---
TLG_TAG_DEFAULT_SELECTION TLG_TAG_SELEC‐ Tipo de selección de uso prefe‐
TION_BY_NAME rente.
TLG_TAG_SELECTION_FLAGS_MASK 0x0000000FL Enmascaramiento de la selec‐
ción en los flags.
TLG_TAG_SELECTION_FLAGS_OFFSET 0x0L Offset del valor de la selección
tras enmascaramiento en los
flags.

3.8.2.1 TLG_ARCHIV_STR (RT Professional)
Declaración
typedef struct {
TCHAR szName[
PDE_DB_ARC_NAME_MAX_LENGHT+1];
TCHAR szComment[
PDE_DB_ARC_COMMENT_MAX_LENGHT+1];
TCHAR szServername[
PDE_DB_ARC_SERVERNAME_MAX_LENGHT +1];
DWORD dwTyp;
DWORD dwAccessRead;
DWORD dwAccessWrite;
TCHAR szArchivAction[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
BOOL fLocked;
DWORD dwRecordTyp;
DWORD dwFillMessage;
DWORD dwRecordSize;
DWORD dwStorage;
TCHAR szCircularAction[
TCHAR szCompressTime[
PDE_DB_TIMENAME_MAX_LENGHT+1];
DWORD dwSourceProcess;
TCHAR szRawDatVar[
PDE_DB_VAR_NAME_MAX_LENGHT+1];
TCHAR szSendAct[
TCHAR szRecAct[
DWORD dwRecItems;
}
TLG_ARCHIV_STR;
Members
szName
Parámetro global para el nombre del fichero
szComment
Parámetro global para el comentario del proyecto.
szServername
Parámetro global reservado para futuras ampliaciones.

dwTyp
Parámetro global que identifica el tipo de fichero.
TLG_ARCHIV_TYP_PROCESS Fichero de datos de proceso

TLG_ARCHIV_TYP_COMPRESS Fichero comprimido
dwAccessRead
Parámetro global que identifica el nivel de autorización para el acceso de lectura ( 0...999).
dwAccessWrite
Parámetro global que identifica el nivel de autorización para el acceso de escritura ( 0...999).
szArchivAction
Parámetro global con el nombre de la acción de la edición general del fichero.
fLocked
Parámetro global que identifica un fichero como habilitado o bloqueado.
dwRecordTyp
Parámetro para ficheros circulares y de continuación, el cual identifica el tipo de fichero.
TLG_RECORD_TYP_CIRCULAR Fichero circular

TLG_RECORD_TYP_FOLLOW Fichero de continuación
dwFillMessage
Parámetro para ficheros circulares, de continuación y de compresión, el cual identifica cuándo
se debe ejecutar un mensaje de nivel de llenado. Con una operación lógica O se pueden
configurar como máximo dos mensajes de nivel de llenado.
p.ej.: 100% || 50%-90%)
TLG_FILL_MESSAGE_NO Ningún mensaje de nivel de llenado

TLG_FILL_MESSAGE_50 Mensaje de nivel de llenado para 50%
dwRecordSize
Parámetro para ficheros circulares, el cual define el tamaño del búfer circular en registros.
dwStorage
Parámetro para ficheros circulares, el cual define el lugar de archivación.
TLG_STORAGE_MEMORY Fichero circular en la memoria principal

TLG_STORAGE_HD Fichero circular en el disco duro

szCircularAction
Parámetro para fichero circular, nombre de la acción para traspasar los datos de un fichero
circular.
szCompressTime
Parámetro para ficheros comprimidos, nombre del objeto temporal que especifica el período
de compresión.
dwSourceProcess
Parámetro para ficheros comprimidos, el cual define el tipo de ejecución del fichero de origen.
PDE_COMPSRC_CALC Calcular
PDE_COMPSRC_CALCCOPY Calcular y copiar
PDE_COMPSRC_CALCDEL Calcular y borrar
PDE_COMPSRC_CALCCOPYDEL Calcular, copiar y borrar
szRawDatVar
por 0.
szSendAct
por 0.
szRecAct
por 0.
dwRecItems
por 0.
Comentario
Los parámetros de la estructura TLG_ARCHIV_STR dependen del tipo de fichero (fichero de
proceso, o fichero comprimido) y el tipo de archivación (archivo circular o de continuación).
Archivos necesarios
pde_def.h
Funciones API

Consulte también
TLGReadArchiv (Página 2271)
3.8.2.2 TLG_ARCHIVDATARAW (RT Professional)
Declaración
typedef struct {
SYSTEMTIME stTime;
double doValue;
DWORD dwFlags;
}
TLG_ARCHIVDATARAW;
Members
stTime
stTime contiene el instante de archivación.
doValue
doValue contiene el valor existente en el instante stTime.
dwFlags
Tag Logging activa Flags para cada valor escrito en el fichero, los cuales proporcionan
información sobre el estado de las variables.
Para analizar los Flags se debe convertir el valor en su representación hexadecimal. Así,
● la palabra izquierda (HighWord) contiene Flags del administrador de datos
● la palabra izquierda (HighWord) contiene Quality Codes, cuando
PDE_RT_QUALITYCODE se encuentra activado
● la palabra derecha (LowWord) contiene Statusflags del Tag Logging
Tag Logging Statusflags (LowWord):

PDE_RT_DAYLIGHT 0x0001 Horario de verano, se puede determinar el estado con Get‐
TimeZomeInformation
PDE_RT_SUBSTITUTION 0x0002 Valor sustitutivo
PDE_RT_TIME_BEVOR_JUMP 0x0004 Valor antes de un salto de tiempo
PDE_RT_TIME_BEHIND_JUMP 0x0008 Valor después de un salto de tiempo
PDE_RT_TIME_OVERLAPPED 0x0010 Valores después de una superposición de tiempos
PDE_RT_LOAD_SYSTEM 0x0020 Valor archivado por primera vez después de crear el archivo
PDE_RT_RELOAD_SYSTEM 0x0040 Primer valor después de activar Runtime
PDE_RT_CMPCOPY 0x0080 valor comprimido
PDE_RT_TIME_CHANGED 0x0100 Se ha realizado una modificación de tiempo

Tag Logging Statusflags (LowWord):

PDE_RT_HAND 0x0200 Suministro manual de variables
PDE_RT_ONCHANGEBACKUPVALUESTART 0x0400
PDE_RT_ONCHANGEBACKUPVALUESTOP 0x0800
PDE_RT_QUALITYCODE 0x1000
Datenmanager Statusflags (HighWord)

DM_VARSTATE_NOT_ESTABLISHED 0x0001 Conexión con el interlocutor no establecida
DM_VARSTATE_HANDSHAKE_ERROR 0x0002 Error de protocolo
DM_VARSTATE_MAX_LIMIT 0x0008 Límite superior configurado excedido
DM_VARSTATE_MIN_LIMIT 0x0010 Límite inferior configurado no alcanzado
DM_VARSTATE_MAX_RANGE 0x0020 Límite de formato excedido
DM_VARSTATE_MIN_RANGE 0x0040 Límite de formato no alcanzado
DM_VARSTATE_CONVERSION_ERROR 0x0080 Visualización de error de conversión, en combinación con
MAX/MIN_RANGE
DM_VARSTATE_INVALID_KEY 0x0800 Variable no encontrada o no existente
DM_VARSTATE_TIMEOUT 0x2000 Timeout, ningún retroaviso del canal
DM_VARSTATE_SERVERDOWN 0x4000 Conexión con el servidor interrumpida o servidor apagado
Estado de variable WinCC Quality Code según Profibus PA/OPC

DM_VARSTATE_SERVERDOWN El servidor está apagado Bad, out of service, 0x1C
(0x4000)
DM_VARSTATE_HARDWARE_ERROR Defecto del módulo/tarjeta de Bad, device failure, 0x0C
(0x0004) red
DM_VARSTATE_NOT_ESTABLISHED Conexión con el interlocutor no Bad, not connected, 0x08
(0x0001) establecida
DM_VARSTATE_TIMEOUT Timeout, ningún retroaviso del Uncertain, last usable value, 0x44
(0x2000) canal
DM_VARSTATE_HANDSHAKE_ERROR Error de protocolo Bad, no communication (no usable value),
(0x0002) 0x18
DM_VARSTATE_ADDRESS_ERROR Error de direccionamiento en el Bad, configuration error, value not accep‐
(0x0400) canal ted, 0x04
DM_VARSTATE_INVALID_KEY Variable no encontrada o no Bad, configuration error, value not accep‐
(0x0800) existente ted, 0x04
DM_VARSTATE_ACCESS_FAULT Acceso a variable no permitido Bad, configuration error, value not accep‐
(0x1000) ted, 0x04
DM_VARSTATE_MAX_RANGE Límite de formato excedido Uncertain, engineering unit range violation,
(0x0020) high limit activado, 0x56
DM_VARSTATE_MIN_RANGE Límite de formato no alcanzado Uncertain, engineering unit range violation,
(0x0040) low limit activado, 0x55

Estado de variable WinCC Quality Code según Profibus PA/OPC

DM_VARSTATE_CONVERSION_ERROR Visualización de errores de Uncertain, engineering unit range violation,
(0x0080) conversión activado sin límites, 0x54
DM_VARSTATE_MAX_LIMIT Límite superior configurado ex‐ Mapear en el Limit-Bit HIGH, 0x01
(0x0008) cedido ORear con el otro estado de la variable, p.
ej. "good (cascade), ok" arroja como resul‐
tado 0xC2
DM_VARSTATE_MIN_LIMIT Límite inferior configurado no Mapear en el Limit-BitLOW, 0x02
(0x0010) alcanzado ORear con el otro estado de la variable, p.
ej. "good (cascade), ok" arroja como resul‐
tado 0xC1
DM_VARSTATE_STARTUP_VALUE Valor de inicialización de la va‐ Uncertain, initial value, 0x4C
(0x0100) riable
DM_VARSTATE_DEFAULT_VALUE Valor sustitutivo de la variable Uncertain, substitute-set, 0x48
(0x0200)
Comentario
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
Active el Flag PDE_RT_DAYLIGHT si la hora correspondiente coincide con el horario de
verano. La función de sistema GetTimeZoneInformation le permite determinar el estado del
Flag (TIME_ZONE_ID_DAYLIGHT).
Archivos necesarios
pdertdef.h
pdert.h
dmdefs.h
Funciones API
Consulte también
TLGGetArchivDataEx (Página 2259)

3.8.2.3 TLG_BACKUP_TABLE_INFO (RT Professional)
Declaración
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
Nombre del fichero del que se transferirán los datos.
szFileName
Nombre del archivo de transferencia con ruta y extensión
szComment
Texto del comentario para la transferencia
dwFormatFlags
Especificador de formato:
TLG_BAKFMT_CSV: Formato CSV (Comma Seperated Value)
dwJobFlags
Posibles identificadores específicos de la petición:
TLG_BACKUP_EXPORT: Copia de seguridad sencilla sin borrar los datos

fuente.
TLG_BACKUP_EVACUATE: Transferencia con borrado de Source
dwSize
Tamaño de los datos a exportar.
sysFrom
Instante de inicio a partir del cual se deben transferir datos.

sysTo
Instante final hasta el cual se deben transferir datos.
dwUserData
datos específicos de aplicación
Archivos necesarios
pdertdef.h
Funciones API
Consulte también
TLG_ENUMBACKUP_ENTRIES (Página 2289)

3.8.2.4 TLG_CURVESCALEX (RT Professional)
Declaración
typedef struct {
DWORD dwDataTyp;
DWORD dwBufferSize;
DWORD dwRangeTyp;
DWORD dwAxisLocation;
BOOL fActualize;
BOOL fAutoRange;
BOOL fGridLinesBig;
BOOL fGridLinesFine;
BOOL fGridLinesBigVisible;
BOOL fGridLinesFineVisible;
BOOL fPercent;
BOOL fLimitRange;
BOOL fSubstitute;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doGridBig;
double doGridFine;
double doShowDigits;
double doLimitUpper1;
double doLimitLower1;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitLower1;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
TCHAR szFunction[ TLG_MAX_FUNCTION_NAME ];
TCHAR szDLL[ TLG_MAX_DLL_NAME ];
}
TLG_CURVESCALEX;

Members
dwDataTyp
Con dwDataTyp se determina el tipo de datos que sirven de base para la curva:
TLG_DATATYP_TIMERAN‐ 0x00000001 para el rango de tiempo:

GE Los datos proceden de un fichero controlado por tiempo (p.ej.: archivo
de datos de proceso). Los valores indicados en stFrom y stTo son váli‐
dos. El Flag fAutoRange carece entonces de efecto.
por lo demás es válido:
Los datos proceden de un fichero controlado por datos (p.ej.: fichero
de usuario). Los valores indicados en doFrom y doTo son válidos.
TLG_DATATYP_USERAR‐ 0x00000002 no relevante para curvas:
CHIV Los datos proceden de un fichero de usuario controlado por datos. Los
valores indicados en doFrom y doTo son válidos.
TLG_DATATYP_BLOCKDA‐ 0x00000004 Los datos se activan a través de TLGSetTemplateData:
TA Los valores en stFrom, stTo, doFrom y doTo resultan entonces no re‐
levantes.
dwBufferSize
dwBufferSize equivale al número de puntos de medición de la curva y determina el tamaño
del búfer de datos de la curva.
dwRangeTyp
El parámetro se reserva para ampliaciones posteriores y debe estar ocupado por defecto por
0.
dwAxisLocation
0.
fActualize
Si fActualize = TRUE la representación de la curva se realiza de forma dinámica. En otro caso
se representará de forma estática.
fAutoRange
Si fAutoRange = TRUE la autoescala se encuentra activada.
Si existe un fichero controlado por tiempo (dwDataTyp = TLG_DATATYP_TIMERANGE),
fAutoRange no produce ningún efecto y los valores indicados en stFrom y stTo son válidos.
fGridLinesBig
0.
fGridLinesFine
0.

fGridLinesBigVisible
0.
fGridLinesFineVisible
0.
fPercent
0.
fLimitRange
0.
fSubstitute
0.
stFrom
Instante de inicio del área de representación. El parámetro sólo se evalúa si
dwDataTy = TLG_TIME_RANGE.
stTo
Instante final del área de representación. El parámetro sólo se evalúa si
dwDataTyp = TLG_TIME_RANGE.
doFrom
Valor inicial del área de representación. El parámetro sólo se evalúa si
dwDataTyp = TLG_DATA_RANGE.
doTo
Valor final del área de representación. El parámetro sólo se evalúa si en
dwDataTyp = TLG_DATA_RANGE.
doGridBig
0.
doGridFine
0.

doShowDigits
Número de decimales
doLimitUpper1
0.
doLimitUpper2
0.
doLimitUpper3
0.
doLimitLower1
0.
doLimitLower2
0.
doLimitLower3
0.
doDisplayRangeFrom
Indica el valor a partir del cual se debe producir una visualización controlada por datos.
doDisplayRangeTo
Indica el valor hasta el cual se debe producir una visualización controlada por datos.
doLimitRangeFrom
0.
doLimitRangeTo
0.
crColor
El valor crColor de 32 bits específico de Windows determina el color de representación de la
curva.
crColorTimeOverlapped

crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1
crColorLimitLower2
crColorLimitLower3
szSelectSQL
El parámetro se reserva para ampliaciones posteriores y se debe inicializar con NULL.
szText;
Título del eje x.
szFunction
szDLL
Comentario
TLG_CURVESCALEX es utilizado por la estructura TLG_TPLITEM_CURVE (Página 2214).
Archivos necesarios
pdertdef.h
Consulte también
TLG_TPLITEM_CURVE (Página 2214)

3.8.2.5 TLG_CURVESCALEY (RT Professional)
Declaración
typedef struct {
DWORD dwDataTyp;
DWORD dwRangeTyp;
DWORD dwAxisLocation;
DWORD dwCurveForm;
BOOL fAutoRange;
BOOL fGridLinesBig;
BOOL fGridLinesFine;
BOOL fGridLinesBigVisible;
BOOL fGridLinesFineVisible;
BOOL fPercent;
BOOL fLimitRange;
BOOL fSubstitute;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doGridBig;
double doGridFine;
double doShowDigitsF;
double doShowDigitsB;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
}
TLG_CURVESCALEY;

Members
dwDataTyp
El tipo de datos (tiempo/ usuario/ datos de bloque) carece aquí de significado
dwRangeTyp
por 0.
dwAxisLocation
por 0.
dwCurveForm
Con dwCurveForm se determina el aspecto de la curva
TLG_CURVEFORM_STEP Representación de la curva de forma escalonada

TLG_CURVEFORM_POINTS Representación de la curva como punto individual
TLG_CURVEFORM_DIRECT Unir los puntos de la curva de forma lineal
fAutoRange
fAutoRange = TRUE adapta automáticamente el área de representación.
fGridLinesBig
fgridLinesBig = TRUE activa líneas de cuadrícula gruesas.
fGridLinesFine
fgridLinesFine = TRUE activa líneas de cuadrícula finas.
fGridLinesBigVisible
Si fgridLinesBigVisible = TRUE se representan las líneas gruesas de cuadrícula.
fGridLinesFineVisible
Si fgridLinesFineVisible = TRUE se representan las líneas finas de cuadrícula.
fPercent
por 0.
fLimitRange
por 0.
fSubstitute
por 0.

stFrom
stTo
doFrom
Límite inferior del área de representación del eje y.
doTo
Límite superior del área de representación del eje y.
doGridBig
Distancia entre las líneas gruesas de cuadrícula.
doGridFine
Distancia entre las líneas finas de cuadrícula.
doShowDigitsF
Dígitos al visualizar valores (previos a decimales)
doShowDigitsB
Determina el número de decimales
doLimitUpper1
por 0.
doLimitUpper2
por 0.
doLimitUpper3
por 0.
doLimitLower1
por 0.
doLimitLower2
por 0.
doLimitLower3
por 0.

doDisplayRangeFrom
Determina el valor a partir del cual comienza el área de representación.
doDisplayRangeTo
Determina el valor hasta el cual alcanza el área de representación.
doLimitRangeFrom
por 0.
doLimitRangeTo
por 0.
crColor
El valor crColor de 32 bits específico de Windows determina el color de representación de la
curva.
crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1
crColorLimitLower2
crColorLimitLower3
szSelectSQL[ TLG_MAX_SQL_SELECT ];
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szText[ TLG_MAX_STD_TEXT_NAME ];
Título del eje y.

Comentario
TLG_CURVESCALEY es utilizado por la estructura AUTOHOTSPOT.
Archivos necesarios
pdertdef.h
Consulte también
3.8.2.6 TLG_GETARCHIVDATA (RT Professional)
Declaración
typedef struct {
LPTSTR lpszArchivName;
LPTSTR lpszVarName;
SYSTEMTIME stTime;
double doValue;
DWORD dwFlags;
}
TLG_GETARCHIVDATA;
Members
lpszArchivName
Puntero al nombre del fichero desde el cual se han leído los datos.
lpszVarName
Puntero al nombre de variable cuyos valores se han leído.
stTime
Valor x del valor de fichero.
doValue
Valor y del valor de fichero.
dwFlags
0.
Archivos necesarios
pdertdef.h

Funciones API
TLG_GETARCHIVDATA_CALLBACK (Pági‐ Leer datos de un fichero (Callback)

na 2258)
Consulte también
TLG_GETARCHIVDATA_CALLBACK (Página 2258)
3.8.2.7 TLG_IO_BACKUP_SELECT (RT Professional)
Declaración
typedef struct {
SYSTEMTIME sysFrom;
SYSTEMTIME sysTo;
LPTSTR lpszSqlString;
}
TLG_IO_BACKUP_SELECT;
Members
sysFrom
Hora del sistema del primer registro a seleccionar
sysTo
Hora del sistema del último registro a seleccionar
lpszSqlString
Archivos necesarios
pdertdef.h
Funciones API
TLGGetBackupSize (Página 2293) Determinar el tamaño de un registro exportado

TLGExport (Página 2291) Exportar datos de fichero
Consulte también
TLGGetBackupSize (Página 2293)
TLGExport (Página 2291)

3.8.2.8 TLG_PROT_CURVE_INFOS (RT Professional)
Declaración
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
Nombre del fichero del que proceden los datos a registrar.
szVariableName
Nombre de las variables de fichero cuyos valores se registran.
szTextX
Título del eje x.
szTextY
Título del eje y.
stFrom
Instante de inicio a partir del cual se registra. El parámetro sólo se evalúa si en dwFlags se
encuentra activado TLG_PROTFLG_TIME_RANGE.
stTo
Instante final hasta el cual se registra. El parámetro sólo se evalúa si en dwFlags se encuentra
activado TLG_PROTFLG_TIME_RANGE.
doFrom
Instante de inicio a partir del cual se debe realizar el registro. El parámetro sólo se evalúa si
en dwFlags se encuentra activado TLG_PROTFLG_DATA_RANGE.

doTo
Instante final hasta el cual se debe realizar el registro. El parámetro sólo se evalúa si en
dwFlags se encuentra activado TLG_PROTFLG_DATA_RANGE.
dwFlags
Con dwFlags se determina el tipo de datos que sirven de base para la curva:
TLG_PROTFLG_TIME_RANGE Los datos proceden de un fichero controlado por tiempo (p.ej.:

archivo de datos de proceso). Los valores indicados en stFrom y
stTo son válidos.
TLG_PROTFLG_DATA_RANGE Los datos proceden de un fichero controlado por datos (p.ej.: fi‐
chero de usuario). Los valores indicados en doFrom y doTo son
válidos.
dwCurveForm
Con dwCurveForm se determina el aspecto de la curva
TLG_CURVEFORM_STEP Representación de la curva de forma escalonada

TLG_CURVEFORM_POINTS Representación de la curva como punto individual
TLG_CURVEFORM_DIRECT Unir los puntos de la curva de forma lineal
Comentario
TLG_PROT_CURVE_INFOS es utilizado por las estructuras TLG_TABLESCALE
(Página 2207) y TLG_TPLITEM_INFO (Página 2215).
Archivos necesarios
pdertdef.h
Funciones API
TLGDrawCurvesInDC (Página 2274) Representar curvas
Consulte también
TLGDrawCurvesInDC (Página 2274)
TLG_TABLESCALE (Página 2207)
TLG_TPLITEM_INFO (Página 2215)

3.8.2.9 TLG_SCAL_STR (RT Professional)
Declaración
typedef struct {
double doScalVarUpper;
double doScalVarLower;
double doScalArcUpper;
double doScalArcLower;
TCHAR szStructName[PDE_DB_SCALE_MAX_LENGHT];
}
TLG_SCAL_STR;
Members
doScalVarLower
Límite inferior del valor de variable.
doScalVarUpper
Límite superior del valor de variable.
doScalArcLower
por 0.
doScalArcUpper
por 0.
szStructName
Nombre de la estructura de escala para los valores de variable.
Comentario
La estructura TLG_SCAL_STR se utiliza dentro de la estructura TLG_VAR_STR
(Página 2217) y está prevista para futuras ampliaciones.
Archivos necesarios
pde_def.h
Consulte también
TLG_VAR_STR (Página 2217)

3.8.2.10 TLG_TABLE_INFO (RT Professional)
Declaración
typedef struct {
DWORD dwArchivTyp;
TCHAR szArchivName[ _MAX_PATH + 1 ];
DWORD dwSaveTyp;
}
TLG_TABLE_INFO;
Members
dwArchivTyp
dwArchivTyp identifica el tipo de fichero:
TLG_ARCTYP_USER Fichero de usuario

TLG_ARCTYP_PROCESS Fichero de datos de proceso
TLG_ARCTYP_COMPRESS Fichero comprimido
szArchivName
La forma en la que se proporciona el nombre del fichero depende de las funciones que utilizan
TLG_TABLE_INFO.
La enumeración de los ficheros mediante TLGEnumArchivs y TLGEnumArchivsSel
proporciona el nombre del fichero en forma de nombre de tabla, es decir, en la forma
"UA#ARCHIV#Archivname" para Userarchive o "PDE#HD#Archivname#Variablenname", ya
que aquí existe una variable para cada entrada de tabla. Es decir, se realiza una enumeración
para cada variable.
La enumeración mediante TLGEnumArchivsEx proporciona el "mero" nombre del fichero.
dwSaveTyp
dwSaveTyp identifica el tipo del fichero:
TLG_ARCTYP_CIRCULAR Fichero circular

TLG_ARCTYP_FOLLOW Fichero de continuación
Archivos necesarios
pdertdef.h
Funciones API

Consulte también
TLG_ENUMTABLES (Página 2253)
3.8.2.11 TLG_TABLESCALE (RT Professional)
Declaración
typedef struct {
BOOL fActualize;
BOOL fVisible;
BOOL fModify;
BOOL fCommon;
DWORD dwDataTyp;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doShowDigits;
OLORREF crColor;
}
TLG_TABLESCALE;
Members
fActualize
TRUE La curva se representa de forma dinámica.

FALSE La curva se representa de forma estática.
fVisible
TRUE La columna resulta visible.

FALSE La columna no resulta visible.

fModify
TRUE Las entradas en la columna son editables.

FALSE Las entradas en la columna no son editables.
fCommon
TRUE Todas las columnas de la tabla poseen una columna de tiempos compartida:
FALSE Las columnas de la tabla no poseen una columna de tiempos compartida:
dwDataTyp
por 0.
stFrom
Hora de inicio del área de representación.
stTo
Hora de fin del área de representación.
doFrom
por 0.
doTo
por 0.
doShowDigits
Número de decimales de salida.
doLimitUpper1
por 0.
doLimitUpper2
por 0.
dpoLimitUper3
por 0.

doLimitLower1
por 0.
doLimitLower2
por 0.
doLimitLower3
por 0.
crColor
El valor crColor de 32 bits específico de Windows determina el color utilizado en la columna
de la tabla.
crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1
crColorLimitLower2
crColorLimitLower3
szSelectSQL
Comentario
TLG_TABLESCALE es utilizado por la estructura TLG_TEMPLATEITEM_INFO
(Página 2210).

Archivos necesarios
pdertdef.h
Consulte también
TLG_PROT_CURVE_INFOS (Página 2201)
TLG_TEMPLATEITEM_INFO (Página 2210)
TLG_TPLITEM_TABLE (Página 2216)
3.8.2.12 TLG_TEMPLATEITEM_INFO (RT Professional)
Declaración
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
Nombre de la curva / columna
szTemplateName
Nombre de la plantilla de la curva / plantilla de la ventana de tabla
szArchivName
Nombre del fichero en el cual se encuentra archivada la variable de fichero enlazada con la
curva / columna.

szVariableName
Nombre de las variables de fichero enlazadas con la curva / columna
szDMVariableName
Nombre de las variables del administrador de datos
dwReadAccessLevel
En la enumeración de curvas / columnas, dwReadAccesLevel contiene el nivel de autorización
de usuario para un acceso de lectura.
dwWriteAccessLevel
En la enumeración de curvas / columnas, dwWriteAccesLevel contiene el nivel de autorización
de usuario para un acceso de escritura.
dwArchivTyp

szTimeNameRange
Nombre del objeto de tiempo a utilizar para fijar el rango de tiempo a partir de una hora de
inicio.
dwTemplateItemTyp
dwTemplateItemTyp debe corresponderse con el valor indicado en dwTemplateTyp:
TLG_TEMPLATEITEM_ALL Plantillas de curvas y tablas

TLG_TEMPLATEITEM_CURVE Plantilla de curva
TLG_TEMPLATEITEM_TABLE Plantilla de tabla
dwTemplateTyp
dwTemplateTyp identifica el tipo de plantilla de ventana
TLG_TEMPLATE_CURVE Plantilla de ventana de curvas

TLG_TEMPLATE_TABLE Plantilla de ventanas de tabla
fVisible
TRUE La columna / curva resulta visible.

FALSE La columna / curva no resulta visible.
tplInfo
Estructura del tipo TLG_TPLITEM_INFO (Página 2215) con las propiedades de una plantilla
de curva / columna.

Archivos necesarios
pdertdef.h
Funciones API
TLG_TABLESCALE (Página 2205) Columna de tabla (propiedades) (estructura)
Consulte también
TLGInsertTemplateItem (Página 2275)
3.8.2.13 TLG_TIME_STR (RT Professional)
Declaración
typedef struct {
DWORD dwBasis;
DWORD dwFactor;
TCHAR szTimeName[
PDE_DB_TIMENAME_MAX_LENGHT + 1 ];
}
TLG_TIME_STR;
Members
dwBasis
Base de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo.
TLG_TBASE_500MS 500ms
TLG_TBASE_SEC 1 segundo
TLG_TBASE_MIN 1 minuto
TLG_TBASE_HOUR 1 hora
TLG_TBASE_DAY 1 día
dwFactor
Factor de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo.
szTimeName
Nombre del objeto de tiempo.

Comentario
Al hablar de tiempos se entienden ciclos de adquisición y archivación de libre asignación. Se
puede utilizar un objeto de tiempo simultáneamente como ciclo de adquisición y ciclo de
archivación.
Archivos necesarios
pde_def.h
Funciones API
TLGReadTime (Página 2287) Determinar parámetros del objeto de tiempo
Consulte también
TLGReadTime (Página 2287)
3.8.2.14 TLG_TIMEDATA (RT Professional)
Declaración
typedef struct {
TCHAR szTimeName[ _MAX_PATH + 1 ];
DWORD dwTimeBase;
DWORD dwTimeValue;
}
TLG_TIMEDATA;
Members
szTimeName
Nombre del objeto de tiempo
dwTimeBase
Base de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo
TLG_TBASE_500MS 500ms
TLG_TBASE_SEC 1 segundo
TLG_TBASE_MIN 1 minuto
TLG_TBASE_HOUR 1 hora
TLG_TBASE_DAY 1 día

dwTimeValue
Factor de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo.
Archivos necesarios
pdertdef.h
Funciones API
Consulte también
TLG_ENUMTIMES_CALLBACK (Página 2285)
3.8.2.15 TLG_TPLITEM_CURVE (RT Professional)
Declaración
typedef struct {
TLG_CURVESCALEX csx;
TLG_CURVESCALEY csy;
}
TLG_TPLITEM_CURVE;
Members
csx
La estructura TLG_CURVESCALEX (Página 2190) contiene los datos para la escala del eje
X de una curva.
csy
La estructura TLG_CURVESCALEY (Página 2195) contiene los datos para la escala del eje
Y de una curva.
Descripción
TLG_TPLITEM_CURVE es utilizado por la estructura TLG_TPLITEM_INFO (Página 2215).
Archivos necesarios
pdertdef.h

Consulte también
TLG_CURVESCALEX (Página 2190)
TLG_CURVESCALEY (Página 2195)
3.8.2.16 TLG_TPLITEM_INFO (RT Professional)
Declaración
typedef union {
TLG_TPLITEM_CURVE tplCurve;
TLG_TPLITEM_TABLE tplTable;
}
TLG_TPLITEM_INFO;
Members
tplCurve
Las propiedades de una curva se leen en la estructura TLG_TPLITEM_CURVE
(Página 2212).
tplTable
Las propiedades de una columna se leen en la estructura TLG_TPLITEM_TABLE
(Página 2216).
Comentario
TLG_TPLITEM_INFO es utilizado por la estructura TLG_TEMPLATEITEM_INFO
(Página 2208).
Dado que una variable se puede representar tanto en una curva como una tabla, es posible
asignar valores a ambas estructuras TLG_TPLITEM_CURVE y TLG_TPLITEM_TABLE.
Archivos necesarios
pdertdef.h
Consulte también


TLG_TPLITEM_TABLE (Página 2216)
3.8.2.17 TLG_TPLITEM_TABLE (RT Professional)
Declaración
typedef struct {
TLG_TABLESCALE ts;
}
TLG_TPLITEM_TABLE;
Members
ts
TLG_TABLESCALE (Página 2205) con las propiedades de una columna de tabla.
Descripción
TLG_TPLITEM_TABLE es utilizado por la estructura TLG_TPLITEM_INFO (Página 2213).
Por cuestiones de organización no es posible utilizar TLG_TABLESCALE directamente en la
estructura TLG_TPLITEM_INFO.
Archivos necesarios
pdertdef.h
Consulte también

3.8.2.18 TLG_VAR_STR (RT Professional)
Declaración
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;
Comentario
La asignación de los parámetros de la estructura TLG_VAR_STR depende del tipo de
archivación (acíclica, cíclica selectiva o cíclica continua) y el tipo de variable (binaria o
analógica).

Members
szVarName
Parámetro global para el nombre de la variable de fichero / del grupo de variables.
Los caracteres : ? " ' \ * % y espacio en blanco no se pueden emplear en los nombres de
variable de fichero, ya que de lo contrario se devuelve el error
TLG_API_NAME_WRONG_CHAR.
szProcName
Parámetro global para el nombre de la variable de proceso
dwVarType
Parámetro global que identifica el tipo de variable de fichero.
TLG_VAR_TYP_ANALOG 0x00010001 Variable analógica:

dwArchivTrigger se ajusta internamente a 0L (no relevante)
TLG_VAR_TYP_BIN 0x00010002 variable binaria:
dwValProcess se ajusta internamente a 0L (no relevante)
TLG_VAR_TYP_COMPRESS 0x00010004 Variable para ficheros comprimidos:
dwSuppy se ajusta internamente a TLG_SUPPLY_BY_SYSTEM
dwSaveByFault se ajusta internamente a TLG_SAVE_LAST_VA‐
LUE
TLG_VAR_TYP_PROCESS 0x00010008 variable controlada por proceso
valor no válido Mensaje de error: TLG_API_VARTYPE_MISMATCH
dwArchivStyle
Parámetro global que identifica el tipo de archivación.
TLG_STY_ACYCLIC 0x00800001 Archivación acíclica

TLG_STY_CYCLIC_CON 0x00800002 Archivación cíclica continua
TLG_STY_ CYCLIC_SEL 0x00800004 Archivación cíclica selectiva
TLG_STY_ON_CHANGE 0x00800008 Adquisición al modificar
valor no válido Mensaje de error TLG_API_ERR_ARCHIVSTYLE
szWriteBackTo
Parámetro global en el cual se debe reescribir el nombre de la variable de fichero.
dwSupply
Parámetro global que identifica el modo de suministro de variables.
TLG_SUPPLY_BY_HAND 0L - FALSE Entrada manual de las variables

TLG_SUPPLY_BY_SYSTEM 1L - TRUE Suministro por parte del sistema (acoplamiento de proceso o va‐
riable interna)
valor no válido Mensaje de error TLG_API_INVALID_PARAM
Si dwVarType = TLG_VAR_TYP_COMPRESS, internamente siempre se activa

TLG_SUPPLY_BY_SYSTEM.

fLocked
Parámetro global que identifica el tratamiento de la archivación durante un arranque del
sistema.
TRUE bloqueado
FALSE habilitado
szComment
Parámetro global para el comentario de la variable de fichero.
szRecordCycle
Nombre del objeto de tiempo (p. ej.: "1 minuto"), el cual especifica el ciclo de adquisición.
El parámetro es relevante para la adquisición cíclica selectiva, cíclica continua de variables
analógicas y binarias.
szArchivCycle
Nombre del objeto de tiempo (p. ej.: "1 minuto"), que especifica el ciclo de archivación. El ciclo
de archivación resulta de multiplicar dwMultiple con szArchivCycle.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
dwMultiple
Identifica el factor de multiplicación. El ciclo de archivación resulta de multiplicar dwMultiple
con szArchivCycle.
dwValueFlow
Identifica el número de valores de cabeza.
dwValueFollow
Identifica el número de valores de retorno.
dwSaveByFault
Identifica el comportamiento de almacenamiento en caso de fallo.
El parámetro es relevante para variables analógicas y binarias de todo tipo de archivaciones.
TLG_SAVE_LAST_VALUE 1L guardar el último valor válido

TLG_SAVE_SUBST_VALUE 2L guardar valor sustitutivo
Si dwVarType = TLG_VAR_TYP_COMPRESS, internamente siempre se activa

TLG_SAVE_LAST_VALUE.

dwArchivTrigger
Identifica el comportamiento de disparo de la archivación.
binarias.
TLG_TRIG_CHANGE 1L Archivación con cada cambio de señal

TLG_TRIG_CHANGE_01 2L Archivación al cambiar la señal 0 -> 1
TLG_TRIG_CHANGE_10 3L Archivación al cambiar la señal 1 -> 0
TLG_TRIG_ALLWAYS 4L El valor se archiva en cada ciclo de archivación, también sin
cambio de señal.
Si dwVarType = TLG_VAR_TYP_ANALOG internamente siempre se activa 0L (no relevante).
szTextHighSignal
Texto para el estado de señal 1.
binarias.
szTextLowSignal
Texto para el estado de señal 0.
binarias.
dwValProcess
Identifica la ejecución del valor de fichero a guardar a través de los valores registrados durante
el ciclo de archivación.
analógicas.
TLG_VAL_ACTUAL 1L Valor actual

TLG_VAL_AVERAGE 2L Valor medio
TLG_VAL_SUM 3L Suma
TLG_VAL_MIN 4L Valor mínimo
TLG_VAL_MAX 5L Valor máximo
TLG_VAL_DLL 6L Función o DLL
Si dwVarType = TLG_VAR_TYP_BIN internamente siempre se activa 0L (no relevante).
szFuncValProcess
Nombre de la acción o de la función DLL que especifica la ejecución del valor de fichero a
guardar.
analógicas y comprimidas, únicamente si dwValProcess = TLG_VAL_DLL.

szDLLValProcess
Nombre del DLL.
analógicas y comprimidas, únicamente si dwValProcess = TLG_VAL_DLL.
szFuncStartEvent
Nombre de la acción o de la función DLL que especifica el evento de inicio.
szDLLStartEvent
Nombre del DLL.
szFuncStopEvent
Nombre de la acción o de la función DLL que especifica el evento de parada.
El parámetro es relevante para la archivación cíclica selectiva de variables analógicas y
binarias.
szDLLStopEvent
Nombre del DLL.
El parámetro es relevante para la archivación cíclica selectiva de variables analógicas y
binarias.
szFuncDynamic
Nombre de la acción o de la función DLL que especifica la conmutación dinámica del ciclo de
adquisición y/o del ciclo de archivación.
analógicas y binarias,
szDLLDynamic
Nombre del DLL.
analógicas y binarias,
szUnitDirect
Identifica la unidad de las variables de fichero.
El parámetro es relevante para la variable analógica de todo tipo de archivaciones.
szUnitStruct
Nombre de la estructura que contiene la unidad de las variables de fichero. NULL cuando la
unidad se configura directamente en szUnitDirect.
El parámetro es relevante para la variable analógica de todo tipo de archivaciones,
dwRecItems
El parámetro está reservado para posteriores ampliaciones para futuras ampliaciones y se
debe inicializar con 0.

szSourceArchiv
Nombre del fichero fuente.
El parámetro es relevante para la archivación cíclica continua,
szSourceVarName
Nombre de las variables de fichero en el fichero de origen.
El parámetro es relevante para la archivación cíclica continua,
szRawdataName
Nombre de las variables de datos sin formato.
El parámetro es relevante para las variables controladas por proceso.
szRawConvDLLName
Nombre del DLL de normalización.
El parámetro es relevante para las variables controladas por proceso,
dwRawDataIndex
El número de las variables de datos sin formato se corresponde, en relación a S7PMC, con
la ID de fichero del PLC.
El parámetro es relevante para variables controladas por proceso.
dwRawDataFormat
Formato de las variables de datos sin formato.
El parámetro es relevante para las variables controladas por proceso
ScaleStruct
Estructura TLG_SCAL_STR (Página 2203) con los valores límite de la variable.
RecordStruct
Archivos necesarios
pde_def.h
Funciones API
TLGReadVariable (Página 2243) Determinar parámetros de las variables
Consulte también
TLGReadVariable (Página 2243)
TLG_SCAL_STR (Página 2203)

3.8.2.19 TLG_VARIABLE_INFO (RT Professional)
Declaración
typedef struct {
DWORD dwVariableTyp;
TCHAR szVariableName[ _MAX_PATH + 1 ];
}
TLG_VARIABLE_INFO;
Members
dwVariableTyp
dwVariableTyp identifica el tipo de variables. Valores posibles:
TLG_VAR_TYP_ANALOG variable analógica

TLG_VAR_TYP_BIN variable binaria
TLG_VAR_TYP_COMPRESS variable para ficheros comprimidos
TLG_VAR_TYP_PROCESS variable controlada por proceso
szVariableName
Archivos necesarios
pdertdef.h
pde_typ.h
Funciones API
Consulte también
TLG_ENUMVARIABLES (Página 2242)

3.8.3.1 TLGCSConnect (RT Professional)
Descripción
La función establece una conexión con la base de datos de proyecto WinCC.
Declaración
BOOL TLGCSConnect (
HWND hwndParent,
LPCMN_ERROR lpError );
Parámetros
hwndParent
Handle de ventana de la ventana maestra.
lpError
Valor de retorno
TRUE
Conexión establecida.
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

TLGCSConnectEx (Página 2225) Establecer una conexión con la base de datos de

proyecto
TLGCSDisConnect (Página 2226) Establecer una conexión con la base de datos de
proyecto
Ejemplos
Enum all acquisition and archiving times (Página 2298) "TL01.cpp"
Read parameters of time object (Página 2312) "TL01.cpp"
Enum archives (Página 2301) "TL01.cpp"
Read archive (Página 2308) "TL01.cpp"
Consulte también
TLGCSConnectEx (Página 2225)
Enum archives (Página 2301)
TLGOpenProject (Página 2233)
Read parameters of time object (Página 2312)
Enum all acquisition and archiving times (Página 2298)
Read archive (Página 2308)
TLGCSDisConnect (Página 2226)
3.8.3.2 TLGCSConnectEx (RT Professional)
Descripción
La función establece una conexión con la base de datos de proyecto WinCC.
Declaración
BOOL TLGCSConnectEx (
HWND hwndParent,
DWORD dwMode,
Parámetros
hwndParent

dwMode
lpError
Valor de retorno
TRUE
Conexión establecida
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
TLGCSConnect (Página 2222) Establecer una conexión con la base de datos de

proyecto
Consulte también
TLGCSConnect (Página 2222)
3.8.3.3 TLGCSDisConnect (RT Professional)
Descripción
La función establece una conexión ya existente con la base de datos de proyecto WinCC. La
llamada es necesaria para que el DLL pueda volver a descargarse sin problemas.
Nota
No se puede utilizar la llamada en el destructor de una aplicación (EXE, DLL, OCX...), ya que
debido a los mecanismos especiales de Microsoft la llamada podría bloquearse, y en
consecuencia, también el programa.

Declaración
BOOL TLGCSDisConnect (
Parámetros
lpError
Valor de retorno
TRUE
Conexión interrumpida.
FALSE
Errores
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

proyecto
Ejemplos
Consulte también


3.8.3.4 TLGChangeLanguage (RT Professional)
Descripción
La función permite cambiar el idioma de datos actualmente utilizado.
Declaración
BOOL TLGChangeLanguage (
DWORD dwLanguage,
PCMN_ERROR lpError );
Parámetros
dwLanguage
Código del futuro idioma a utilizar.
lpError
Valor de retorno
TRUE
Idioma de datos cambiado
FALSE
Error
Mensajes de error
TLG_API_INVALID_PARAM Suministro de parámetros no válido / incorrecto

TLG_API_NO_INTERFACE Error en el acceso a interfaces COM subordinadas
TLG_API_NO_CONNECTION No se ha establecido conexión con un proyecto activado
TLG_API_ERR_SUPPLY Se ha producido un error
Archivos necesarios
pdertcli.h

pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.3.5 TLGConnect (RT Professional)
Descripción
La función inicializa el sistema de ficheros y establece una conexión con el Tag Logging
Runtime.
Declaración
BOOL TLGConnect (
HWND hwndParent,
Parámetros
hwndParent
lpError
Valor de retorno
TRUE
Conexión establecida
FALSE
Error
Comentario
La llamada genera una ventana invisible para la comunicación, la cual se borra con la función
TLGDisconnect. Ello resulta eventualmente relevante si se utilizan también funciones de
Windows.

Mensajes de error

Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
TLGDisconnect (Página 2230) Deshacer conexión
Ejemplos
Enumerate archives (Página 2306) "TL02.cpp"
Consulte también
Enumerate archives (Página 2306)
TLGDisconnect (Página 2230)
Edit curve template - Example 1 (Página 2295)
3.8.3.6 TLGDisconnect (RT Professional)
Descripción
Con la función se interrumpe una conexión existente con el Tag Logging Runtime.
Declaración
BOOL TLGDisconnect (
Parámetros
lpError

Valor de retorno
TRUE
Conexión interrumpida
FALSE
Error
Comentario
Nota
No se puede utilizar la llamada en el destructor de una aplicación (EXE, DLL, OCX...), ya que
debido a los mecanismos especiales de Microsoft la llamada podría bloquearse, y en
consecuencia, también el programa.
Mensajes de error

Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
TLGConnect (Página 2227) Establecer conexión
Ejemplos
Consulte también
TLGConnect (Página 2227)

3.8.4 Funciones de administración del proyecto (RT Professional)
3.8.4.1 TLGCloseProject (RT Professional)
Descripción
Cierra el proyecto actual. Se borran todos los objetos de datos pertenecientes a este proyecto.
La función deja de tener significado y suministra siempre el valor de retorno TRUE.
Declaración
BOOL TLGCloseProject(
HANDLE hProject,
LPCMN_ERROR lpoes );
Parámetros
hProject
Handle de un proyecto abierto con TLGOpenProject.
lpoes
Valor de retorno
TRUE
Proyecto cerrado
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
Ejemplos

Consulte también
3.8.4.2 TLGOpenProject (RT Professional)
Descripción
Establece una conexión con la base de datos de proyecto WinCC.
Declaración
BOOL TLGOpenProject (
HANDLE* lphProject,
LPTSTR lpszProjectName,
HWND hwndParent,
Parámetros
lphProject
Dirección de un área de memoria donde se guardará el Handle.
lpszProjectName
Nombre del proyecto a abrir.
La ruta del proyecto a indicar aquí puede ser determinada por una de las siguientes funciones
API:
● DMEnumOpenedProjects
● DMGetRuntimeProject
● TLGEnumProject
Cuando se indica una ruta de proyecto distinta del proyecto actualmente abierto se devuelve
el error TLG_API_PROJECT_NAME_NOT_EXIST. Sino existe ningún proyecto abierto se
devuelve el error TLG_API_NO_PROJECT_EXIST.
hwndParent
Handle de la ventana maestra.

lpoes
Valor de retorno
TRUE
Proyecto abierto
FALSE
Error
Comentario
Si no se ha establecido previamente con TLGCSConnect una conexión con la base de datos
de proyecto WinCC se devuelve el error de conexión TLG_API_NO_CONNECTION.
Mensajes de error

TLG_API_NO_CONNECTION No se ha establecido conexión con un proyecto
activado
TLG_API_NO_PROJECT_EXIST no existe ningún proyecto
TLG_API_PROJECT_NAME_NOT_EXIST nombre de proyecto no encontrado
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

proyecto
TLGCSConnectEx (Página 2223) Establecer una conexión con la base de datos de
proyecto
Ejemplos


Enum variables of an archive (Página 2304) "TL02.cpp"
Consulte también
TLGEnumProject (Página 2235)
TLGCSConnectEx (Página 2223)
Enum variables of an archive (Página 2304)
3.8.4.3 TLGEnumProject (RT Professional)
Descripción
La función determina el nombre del proyecto abierto.
Declaración
BOOL TLGEnumProject (
TLG_ENUM_PROJECT_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parámetros
lpCallbackFunc
Puntero a la función Callback que se llama para cada proyecto abierto.
lpUser
lpoes

Valor de retorno
TRUE
Proyectos listados
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
TLG_ENUM_PROJECT_NAME_CALLBACK (Pá‐ Listar proyectos (Callback)

gina 2236)
Consulte también
TLG_ENUM_PROJECT_NAME_CALLBACK (Página 2236)
3.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK (RT Professional)
Descripción
Para poder evaluar los proyectos listados por el sistema debe proporcionarse una función
Callback del tipo TLG_ENUM_PROJECT_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_PROJECT_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetros
lpszName
El puntero lpszName remite al nombre del primer proyecto.

lpUser
función Callback.
Valor de retorno
Los valores de retorno dependen de su implementación.
Nota
Archivos necesarios
pdecscli.h
Consulte también
TLGEnumProject (Página 2233)
3.8.5 Funciones para editar variables (RT Professional)
3.8.5.1 TLGEnumVariables (RT Professional)
Descripción
La función determina todos los nombres de variables de un archivo.

Declaración
BOOL TLGEnumVariables (
HANDLE hProject,
LPTSTR lpszArchivName,
TLG_ENUM_VARIABLE_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parámetros
hProject
Handle del proyecto en el que se encuentra el fichero.
lpszArchivName
Puntero al nombre del fichero
lpCallbackFunc
Puntero a la función Callback que se llama para cada entrada de variable en el fichero.
lpUser
lpoes
Valor de retorno
TRUE
Variables de fichero listadas
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

TLG_ENUM_VARIABLE_NAME_CALLBACK (Pá‐ Listar variables (Callback)

gina 2239)
Consulte también
TLG_ENUM_VARIABLE_NAME_CALLBACK (Página 2239)
TLGReadVariable (Página 2243)
3.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK (RT Professional)
Descripción
Para poder evaluar las variables listadas por el sistema debe proporcionar una función
Callback del tipo TLG_ENUM_VARIABLE_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_VARIABLE_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetros
lpszName
El puntero lpszName remite al nombre de la primera variable.
lpUser
función Callback.
Valor de retorno
TRUE

FALSE
Nota
Archivos necesarios
pdecscli.h
Consulte también
TLGEnumVariables (Página 2235)
3.8.5.3 TLGEnumVariablesEx (RT Professional)
Descripción
La función determina todos los nombres de variables de un archivo.
Declaración
BOOL TLGEnumVariablesEx (
LPCTSTR lpszArchiveName,
TLG_ENUMVARIABLES lpfnCallback,
LPVOID lpUser,
Parámetros
lpszArchiveName
Puntero al nombre del archivo, cuyas variables se deben listar.

lpfnCallback
Puntero a la función Callback que se llama para cada variable del fichero.
lpUser
lpError
Valor de retorno
TRUE
Variables listadas
FALSE
Error
Mensajes de error

Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
pdertcli.h
pdertcli.lib
pdertcli.dll
Ejemplos

Consulte también
TLG_ENUMVARIABLES (Página 2242)
3.8.5.4 TLG_ENUMVARIABLES (RT Professional)
Descripción
Para poder evaluar los datos listados por el sistema de una variable debe proporcionar una
función Callback del tipo TLG_ENUMVARIABLES.
Declaración
BOOL ( * TLG_ENUMVARIABLES) (
PTLG_VARIABLE_INFO lpvi,
LPVOID lpUser );
Parámetros
lpvi
Dirección de una estructura del tipo TLG_VARIABLE_INFO (Página 2221) con los datos de
una variable.
lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota

Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
TLGEnumVariablesEx (Página 2238) Listar variables
Ejemplos
Consulte también
TLGEnumVariablesEx (Página 2238)
TLG_VARIABLE_INFO (Página 2221)
TLGEnumArchivsEx (Página 2249)
3.8.5.5 TLGReadVariable (RT Professional)
Descripción
Lectura de los parámetros de una variable.
Declaración
BOOL TLGReadVariable (
HANDLE hProject,
LPTSTR lpszVariableName,
PTLG_VAR_STR lpVariable,
Parámetros
hProject
Handle del proyecto en que se encuentra la variable editar.
lpszArchivName

lpszVariableName
Puntero al nombre de una variable del fichero.
lpVariable
Dirección de la estructura TLG_VAR_STR (Página 2215) en la que se deben leer los datos
de las variables.
lpoes
Valor de retorno
TRUE
Parámetro leído
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

TLGReadVariable6 Determinar parámetros de las variables
Ejemplos
Consulte también
TLG_VAR_STR (Página 2215)
TLGEnumVariables (Página 2235)

3.8.6 Funciones para editar ficheros (RT Professional)
3.8.6.1 TLGEnumArchives (RT Professional)
Descripción
La función determina el nombre de todos los ficheros del proyecto hproject. Esta función
permite editar todos los tipos de ficheros.
Declaración
BOOL TLGEnumArchives (
HANDLE hProject,
TLG_ENUM_ARCHIV_CALLBACK lpCallbackFunc,
PVOID lpUser,
Parámetros
hProject
Handle del proyecto en el que se encuentran los ficheros.
lpCallbackFunc
Puntero a la función Callback que se llama para cada fichero.
lpUser
lpoes
Valor de retorno
TRUE
Ficheros listados
FALSE
Error
Archivos necesarios
pdecscli.h

pdecscli.lib
pdecscli.dll

TLG_ENUM_ARCHIV_CALLBACK (Página 2246) Listar ficheros (Callback)
Ejemplos
Consulte también
TLG_ENUM_ARCHIV_CALLBACK (Página 2246)
TLGReadArchiv (Página 2271)
3.8.6.2 TLG_ENUM_ARCHIV_CALLBACK (RT Professional)
Descripción
Para poder evaluar los ficheros listados por el sistema debe proporcionar una función Callback
del tipo TLG_ENUM_ARCHIV_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_ARCHIV_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetros
lpszName
El puntero lpszName remite al nombre del fichero.
lpUser
función Callback.

Valor de retorno
TRUE
FALSE
Comentario
Nota
Archivos necesarios
pdecscli.h
Ejemplos
Consulte también
TLGEnumArchives (Página 2243)
3.8.6.3 TLGEnumArchivs (RT Professional)
Descripción
Enumera los ficheros existentes. A diferencia de TLGEnumArchivsSel, solo se pueden limitar
los ficheros a listar a través del tipo de fichero.

A través de la función Callback se proporcionan las informaciones de un fichero en estructuras

del tipo TLG_TABLE_INFO. En esta operación se transmite el nombre del fichero en forma
de nombre de tabla, es decir, en la forma "UA#ARCHIV#ArchivName" o
"PDE#HD#Archivname#Variablenname".
Declaración
BOOL TLGEnumArchivs (
DWORD dwArchivTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
Parámetros
dwArchivTyp

NULL Se enumeran todos los ficheros.
lpfnCallback
lpUser
lpError
Valor de retorno
TRUE
Ficheros listados
FALSE
Error

Mensajes de error

Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
TLGEnumArchivsEx (Página 2249) Listar ficheros

Ejemplos
Consulte también
TLGEnumArchivsSel (Página 2251)
3.8.6.4 TLGEnumArchivsEx (RT Professional)
Descripción
Enumera los ficheros existentes. A diferencia de TLGEnumArchivsSel, solo se pueden limitar
los ficheros a listar a través del tipo de fichero (fichero de usuario, fichero de valor de proceso,
fichero comprimido).
del tipo TLG_TABLE_INFO. A diferencia de TLGEnumArchivs, no se transfiere el nombre de
tabla del fichero, sino el "mero" nombre del fichero.

Declaración
BOOL TLGEnumArchivsEx (
DWORD dwArchivTyp,
LPVOID lpUser,
Parámetros
dwArchivTyp
TLG_ARCTYP_U_USER Fichero de usuario

lpfnCallback
lpUser
lpError
Valor de retorno
TRUE
Los ficheros se listan
FALSE
Error
Mensajes de error

activado

Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Consulte también
TLGEnumArchivs (Página 2245)
3.8.6.5 TLGEnumArchivsSel (RT Professional)
Descripción
La función enumera los tipos de fichero existentes. A diferencia de TLGEnumArchivs, los
archivos a listar se pueden limitar junto con el tipo de archivo también mediante el tipo de
archivación (fichero circular, fichero siguiente).
del tipo TLG_TABLE_INFO. En esta operación se transfiere el nombre del fichero en forma
de nombre de tabla, es decir, en la forma "UA#ARCHIV#ArchivName" o
"PDE#HD#Archivname#Variablenname". Se enumeran todas las variables del fichero. Esta
forma se requiere, p.ej. en TLGBackup.
Declaración
BOOL TLGEnumArchivsSel (
DWORD dwArchivTyp,
DWORD dwSaveTyp,
LPVOID lpUser,

Parámetros
dwArchivTyp

dwSaveTyp
dwSaveTyp identifica el tipo del fichero:
TLG_ARCTYP_ALL Ficheros circulares y de continuación

TLG_ARCTYP_CIRCULAR Ficheros circulares
TLG_ARCTYP_FOLLOW Ficheros de continuación
lpfnCallback
lpUser
lpError
Valor de retorno
TRUE
Los ficheros se listan.
FALSE
Error
Mensajes de error

TLG_API_INVALID_PARAM Suministro de parámetros no válido o incorrecto
Archivos necesarios
pdertcli.h

pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

AUTOHOTSPOT Listar ficheros
Consulte también
TLG_TABLE_INFO (Página 2204)
3.8.6.6 TLG_ENUMTABLES (RT Professional)
Descripción
Para poder evaluar los ficheros listados por el sistema debe proporcionar una función Callback
del tipo TLG_ENUMTABLES.
Declaración
BOOL TLG_ENUMTABLES (
LPTSTR lpTableName,
PTLG_TABLE_INFO lpti,
PVOID lpUser );
Parámetros
lpTableName
Puntero al nombre del fichero.
lpti
La información sobre la tabla de la base de datos está contenida en la estructura
TLG_TABLE_INFO (Página 2204).

lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Comentario
Nota
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Ejemplos
Enumerate archives "TL02.cpp"

Consulte también
TLG_TABLE_INFO (Página 2204)
3.8.6.7 TLGFreeMemory (RT Professional)
Descripción
Con esta función se habilita un área de memoria mediante TLGGetArchivDataEx.
Declaración
BOOL TLGFreeMemory (
LPVOID lpMemory );
Parámetros
lpMemory
El puntero al área de memoria que liberar se obtiene al llamar la función TLGGetArchivDataEx
en el parámetro ppTLGData.
Nota
Se debe inicializar el puntero antes de la llamada TLGGetArchivDataEx() con NULL, y realizar
antes de la llamada TLGFreeMemory() una comprobación del tipo diferente de NULL.
Valor de retorno
TRUE
Se habilita la memoria
FALSE
Error
Nota

Archivos necesarios
pdertcli.h
pdertcli.lib
pdertcli.dll
Consulte también
3.8.6.8 TLGGetArchivData (RT Professional)
Descripción
La función lee de un fichero los datos entre dos instantes. A diferencia de
TLGGetArchivDataEx, se proporcionan los valores de las variables de fichero mediante una
función Callback.
Con una llamada se pueden leer hasta 10.000 registros. Si existen más registros entre la hora
de inicio y la hora de fin, sólo obtendrá los primeros 10.000.
Los siguientes registros se obtienen añadiendo un milisegundo a la hora del último registro,
utilizándola como hora de inicio en una nueva llamada de TLGGetArchivData.
Declaración
BOOL TLGGetArchivData (
LPTSTR lpszVarName,
SYSTEMTIME stStart,
SYSTEMTIME stStop,
TLG_GETARCHIVDATA_CALLBACK lpfnCallback,
PVOID lpUser,
DWORD dwFlags,
Parámetros
lpszArchivName
Puntero al nombre del archivo en el que se deben leer datos.

lpszVarName
Puntero al nombre de las variables de fichero, cuyos valores se deben leer.
stStart
Instante de inicio, a partir del cual se deben leer datos.
stStop
Instante final hasta el cual se deben leer datos.
lpfnCallback
Puntero a la función Callback que se llama para cada punto de medición a leer.
lpUser
dwFlags
por 0.
lpError
Valor de retorno
TRUE
Datos de fichero determinados
FALSE
Error
Mensajes de error

TLG_API_NODEFAULTSERVER Ningún servidor estándar configurado
TLG_API_NOSERVER Ningún servidor estándar configurado y ningún servidor local
disponible
Archivos necesarios
pdertcli.h

pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
TLG_GETARCHIVDATA_CALLBACK Leer datos de un fichero (Callback)

(Página 2258)
Consulte también
TLG_GETARCHIVDATA_CALLBACK (Página 2258)
3.8.6.9 TLG_GETARCHIVDATA_CALLBACK (RT Professional)
Descripción
Para poder evaluar los datos de fichero listados por el sistema debe proporcionar una función
Callback del tipo TLG_GETARCHIVDATA_CALLBACK.
Declaración
BOOL ( * TLG_GETARCHIVDATA_CALLBACK) (
PTLG_GETARCHIVDATA lpGAD,
PVOID lpUser );
Parámetros
lpGAD
Por cada archivo el sistema reserva memoria con la longitud de la estructura
TLG_GETARCHIVDATA. El puntero lpGAD remite al comienzo del primer elemento.
lpUser
función Callback.

Valor de retorno
TRUE
FALSE
Nota
Transferir, dentro de lo posible, únicamente datos. Los siguientes tipos de llamadas de función
● Funciones en las cuales se accede a un Message Loop, p.ej. GetMessage
● Funciones API Runtime de la misma DLL
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h

TLG_GETARCHIVDATA (Pági‐ Datos de fichero de archivos de datos de proceso (estructura)
na 2199) Datos de fichero de ficheros comprimidos (estructura)
Consulte también
TLGGetArchivData (Página 2254)
TLG_GETARCHIVDATA (Página 2199)
3.8.6.10 TLGGetArchivDataEx (RT Professional)
Descripción
Lee de un fichero los datos entre dos instantes. A diferencia de TLGGetArchivData los valores
de las variables de fichero se guardan en la memoria.
Nota
La memoria asignada en ppTlgData se debe habilitar de nuevo mediante TLGFreeMemory.

Declaración
BOOL TLGGetArchivDataEx (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstStart,
SYSTEMTIME* pstStop,
PTLG_ARCHIVDATARAW* ppTlgData,
DWORD* pdwNumberOfData,
DWORD* pdwFlags,
Parámetros
lpszArchivName
Puntero al nombre del fichero en el que se leen los datos.
lpszVarName
Puntero al nombre de las variables de fichero, cuyos valores se leen.
stStart
Instante de inicio, a partir del cual se leen datos.
stStop
Instante final hasta el cual se leen datos.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, utilice la función
GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
ppTlgData
Dirección de un puntero, en el cual se guarda la dirección de los datos de las variables de
fichero. El campo de datos es asignado por TLGGetArchivDataEx y contiene estructuras del
tipo TLG_ARCHIVDATARAW (Página 2185).
Nota
Se debe habilitar de nuevo la memoria asignada mediante TLGFreeMemory.
pdwNumberOfData
Puntero al número de registros.
● Antes de la llamada: Cantidad máxima de registros a leer.
● Después de la llamada: Cantidad de registros leídos con los valores de las variables de
fichero (de las estructuras del tipo TLG_ARCHIVDATARAW).

Se pueden leer un máximo de 10.000 registros con una llamada. Si existen más registros
entre la hora de inicio y la hora de fin, sólo obtendrá los primeros 10000. Los siguientes
registros se obtienen añadiendo un milisegundo a la hora del último registro, y utilizando esta
como hora de inicio en una nueva llamada de TLGGetArchivDataEx.
dwFlags
por 0.
lpError
Valor de retorno
TRUE
Datos de fichero determinados
FALSE
Error
Nota
La memoria asignada mediante en TLGGetArchivDataEx en ppTlgData se debe habilitar de
nuevo mediante TLGFreeMemory.
Mensajes de error

activado
TLG_API_NOSERVER Ningún servidor estándar configurado y ningún
servidor local disponible
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib

pdertcli.dll

TLGFreeMemory (Página 2253) Liberar memoria
Consulte también
TLGFreeMemory (Página 2253)
TLGGetArchivData (Página 2254)
TLG_ARCHIVDATARAW (Página 2185)
3.8.6.11 TLGGetClosestTime (RT Professional)
Descripción
La función determina los instantes de archivación adyacentes en un instante predeterminado.
Declaración
BOOL TLGGetClosestTime (
SYSTEMTIME* pstTime,
BOOL bPrevious,
Parámetros
lpszArchivName
lpszVarName
Puntero al nombre de la variable
pstTime
pstTime se utiliza como parámetro de entrada y salida. Al llamar TLGGetClosestTime, pstTime
contiene la hora del sistema a la cual se deben determinar los tiempos de archivación
adyacentes. Una vez ejecutada correctamente la llamada de función, pstTime contiene el
instante de archivación más próximo.

bPrevious
bPrevious identifica si a la hora del sistema transmitida se debe determinar un instante de
archivación previo o consecutivo.
TRUE Se determina un instante de archivación previo.

FALSE Se determina un instante de archivación consecutivo.
lpError
Valor de retorno
TRUE
pstTime contiene un instante de archivación adyacente.
FALSE
Error o no se ha podido determinar ningún instante de archivación adyacente.
Comentario
Si bPrevious se encuentra indicado como TRUE y pstTime contiene un valor existente, puede
ocurrir que se devuelva exactamente este instante y no el instante precedente. Si bPrevious
se encuentra indicado como FALSE, siempre se suministra el instante consecutivo.
Mensajes de error

activado
TLG_API_VARIABLE_NAME_NOT_EXIST no se ha encontrado ninguna variable con este
nombre
TLG_API_TIME_NAME_NOT_EXIST no se ha encontrado ningún objeto de tiempo con
este nombre
TLG_API_NO_TIME_EXIST no existe ningún objeto de tiempo
Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

TLGGetClosestTimeEx (Página 2264) Determinar el instante de archivación
Consulte también
TLGGetClosestTimeEx (Página 2264)
3.8.6.12 TLGGetClosestTimeEx (RT Professional)
Descripción
La función determina los instantes de archivación adyacentes en un instante predeterminado.
Declaración
BOOL TLGGetClosestTimeEx (
SYSTEMTIME* pstTime,
BOOL bPrevious,
BOOL bIgnoreInvalid,
Parámetros
lpszArchivName
lpszVarName
pstTime
pstTime se utiliza como parámetro de entrada y salida. Al llamar TLGGetClosestTime,
pstTime contiene la hora del sistema a la cual se deben determinar los tiempos de archivación
adyacentes. Una vez ejecutada correctamente la llamada de función, pstTime contiene el
instante de archivación más próximo.
bPrevious
bPrevious identifica si a la hora del sistema transmitida se debe determinar un instante de
archivación previo o consecutivo.
TRUE Se determina un instante de archivación previo.

FALSE Se determina un instante de archivación consecutivo.

bIgnoreInvalid
Indica si en la determinación del tiempo se deben ignorar los valores con el Flag Fallo de
conexión.
TRUE Los valores con fallo de conexión se ignoran o saltan.

FALSE Se tienen en cuenta todos los valores para la determinar el tiempo. De esta forma, la
función se comporta igual que TLGGetClosestTime().
lpError
Valor de retorno
TRUE
pstTime contiene un instante de archivación adyacente.
FALSE
Error o no se ha podido determinar ningún instante de archivación adyacente.
Comentario
Si bPrevious se encuentra indicado como TRUE y pstTime contiene un valor existente, puede
ocurrir que se devuelva exactamente este instante y no el instante precedente. Si bPrevious
se encuentra indicado como FALSE, siempre se suministra el instante consecutivo.
Mensajes de error

TLG_API_VARIABLE_NAME_NOT_EXIST no se ha encontrado ninguna variable con este nombre
TLG_API_TIME_NAME_NOT_EXIST no se ha encontrado ningún objeto de tiempo con este
nombre
TLG_API_NO_TIME_EXIST no existe ningún objeto de tiempo
Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

TLGGetClosestTime (Página 2260) Determinar el instante de archivación
Consulte también
TLGGetClosestTime (Página 2260)
3.8.6.13 TLGInsertArchivData (RT Professional)
Descripción
La función permite incorporar cualquier tipo de datos a un fichero existente en el disco duro.
Si ejecuta TlgInsertArchivData para valores creados durante el horario de verano, deberá
tener en cuenta el desplazamiento horario. Al llamar estos valores active el Flag
PDE_RT_DAYLIGHT.
Sin este Flag las llamadas de lectura, p. ej. TLGGetArchivData o TLGGetClosestTime,
devuelven la hora estándar.
Nota
Al no comprobarse la veracidad de los datos incorporados existe el riesgo de que el fichero
sea destruido.
Declaración
BOOL TLGInsertArchivData (
PTLG_ARCHIVDATARAW pTlgData,
DWORD dwNumberOfData,
DWORD dwFlags,
Parámetros
lpszArchivName
lpszVarName

pTlgData
Puntero a la primera de las estructuras del tipo TLG_ARCHIVDATARAW con los valores de
variable a incorporar al fichero.
dwNumberOfData
Número de valores de variable a incorporar (de las estructuras TLG_ARCHIVDATARAW).
dwFlags
TLG_API_FLG_FAST_INSERT Cuando se activa que este Flag, los datos se escriben mucho
más rápido en el modo optimizado. No obstante, para poder
utilizar esta optimización de rendimiento, los sellos de tiempo
de los registros escritos deben encontrarse ordenados con la
secuencia de tiempo correcta y además siempre deben ser
más actuales que los registros ya existentes en el fichero.
No se puede utilizar este Flag al incorporar registros más an‐
tiguos entre registros ya existentes. Si se incorporan valores
más antiguos que los actuales o no ordenados temporalmen‐
te, los valores más antiguos se rechazan sin indicación de
error.
TLG_API_FLG_REPLACE_INSERT Cuando se activa este flag, los datos se sobrescriben en el
fichero. El flag "TLG_API_FLG_REPLACE_INSERT" no pue‐
de utilizarse junto con el flag "TLG_API_FLG_FAST_INSERT".
TLG_API_FLG_DETAILED_ERROR‐ Si este flag está activado, se emiten códigos de error más
CODES detallados y diferenciados.
lpError
Valor de retorno
TRUE
Valores de variable incorporados al fichero.
FALSE
Error
Códigos de error
Si se indica un fichero en lpszArchivName, ubicado en la memoria principal, se emite el
mensaje de error TLG_API_ERR_SUPPLY.
Esta función solamente se puede aplicar para ficheros existentes en el disco duro. Si se
producen errores de escritura en valores individuales, se devuelve una descripción detallada
del error en CMN_ERROR . Debido a la limitación de la longitud del CMN_ERR.szErrorText
la cantidad de errores detallados se limita a un máximo de 57.

Si se indica un fichero en lpszArchivName, ubicado en la memoria principal, se emite el

mensaje de error TLG_API_ERR_SUPPLY.
dwError1 TLG_API_ERR_SUPPLY
dwError2 0
dwError3 Número de línea en el código fuente
dwError4 Cantidad de errores (máx. 57)
dwError5 Cantidad de datos a escribir (dwNumberOfData)
szErrorText TLG-API: se ha producido un error, line xxx; Pos:0=0xXX,1=0xXX,2=0xXX, ...
(, 56=0xXX)
Si en dwFlags se activa el flag TLG_API_FLG_DETAILED_ERRORCODES, se emiten los

siguientes códigos de error detallados.
Código de error Descripción Valor (con Valor (sin flag)

flag)
OK Ningún error 0x00 0x00
Error Estado de fallo general 0x01 0x40
El registro ya existe El registro ya existe y no se sobrescribe 0x02 0x80
No permitido La entrada manual de valores está blo‐ 0x04 0x800
queada
Violación de límite El valor se encuentra fuera de los límites 0x08 0x1000
Ningún servidor Problemas con la conexión de servidor 0x10 0x10
Variable no encontrada Variable de fichero no encontrada 0x20 0x40
Flag no válido Combinación no permitida de flags 0x40 0x40
TLG_API_FLG_REPLACE_INSERT y
TLG_API_FLG_FAST_INSERT
La etiqueta de tiempo se No se permiten valores con etiquetas 0x80 0x40
encuentra en el futuro de tiempo situadas en el futuro
El fichero se basa en RAM Las operaciones de escritura en fiche‐ 0x100 0x40
ros no están permitidas en la memoria
principal
Mensajes de error

disponible
Archivos necesarios
pdertcli.h
pde_glob.h

pdertdef.h
pdertcli.lib
pdertcli.dll
3.8.6.14 TLGLockArchiv (RT Professional)
Descripción
Bloquea o habilita un fichero completo. Un fichero bloqueado no permite archivar datos nuevos.
Declaración
BOOL TLGLockArchiv (
HWND hwnd,
BOOL fLocked,
Parámetros
hwnd
Handle de ventana de la ventana PDE Runtime.
lpszArchivName
Puntero al nombre del fichero.
fLocked
TRUE: Bloquear fichero

FALSE: Habilitar fichero
lpError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR . En caso
Valor de retorno
TRUE
Fichero bloqueado/ habilitado
FALSE
Error

Mensajes de error

TLG_API_NO_ARCHIV_EXIST ningún fichero disponible
disponible
Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.6.15 TLGLockVariable (RT Professional)
Descripción
Bloquea o habilita una variable. No es posible actualizar o archivar una variable bloqueada.
Declaración
BOOL TLGLockVariable (
HWND hwnd,
LPTSTR lpszVarName,
BOOL fLocked,
Parámetros
hwnd
Handle de ventana de la ventana PDE Runtime.
lpszArchivName
Para seleccionar un servidor determinado se puede anteponer "ServerPräfix::" al nombre del
fichero.

lpszVarName
fLocked
TRUE: Bloquear variable

FALSE: Habilitar variable
lpError
Valor de retorno
TRUE
Variable habilitada / bloqueada
FALSE
Error
Mensajes de error

TLG_API_NO_ARCHIV_EXIST ningún fichero disponible
disponible
Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.6.16 TLGReadArchiv (RT Professional)
Descripción
Lectura de los parámetros de un fichero existente en el proyecto hProject. Esta función permite
editar todos los tipos de ficheros.

Declaración
BOOL TLGReadArchiv (
HANDLE hProject,
PTLG_ARCHIV_STR lpArchiv,
Parámetros
hProject
Handle del proyecto en el que se encuentra el fichero a editar.
lpszArchivName
Nombre del fichero a editar.
lpArchiv
Dirección de la estructura TLG_ARCHIV_STR (Página 2182) en la cual se guardan los
parámetros del fichero.
lpoes
Valor de retorno
TRUE
Contenidos del fichero leídos
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

TLGReadArchiv6 Leer parámetros de fichero

Ejemplos
Read archive (Página 2308)"TL01.cpp"
Consulte también
TLGEnumArchives (Página 2243)
TLG_ARCHIV_STR (Página 2182)
3.8.7 Funciones para representación de curvas y tablas (RT Professional)
3.8.7.1 TLGCloseWindow (RT Professional)
Descripción
Esta función cierra una ventana de una aplicación.
Declaración
BOOL TLGCloseWindow (
HWND hwnd,
Parámetros
hwnd
Handle en la ventana maestra de la aplicación a cerrar.
lpError
Valor de retorno
TRUE
Ventana de la aplicación cerrada
FALSE
Error

Mensajes de error

Archivos necesarios
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
3.8.7.2 TLGDrawCurvesInDC (RT Professional)
Descripción
Esta función permite representar curvas en una ventana de una aplicación.
Declaración
BOOL TLGDrawCurvesInDC (
HDC hDC,
PRECT lprect,
PTLG_PROT_CURVE_INFOS lpci,
DWORD dwNumberOfCurves,
Parámetros
hDC
Handle en la ventana maestra, en la que se debe representar la curva
lprect
Puntero a la estructura específica de Windows del tipo RECT con las indicaciones de tamaño
de la ventana.
lpci
Puntero a la primera estructura del tipo TLG_PROT_CURVE_INFOS (Página 2201) con
informaciones sobre la forma de representación de las curvas.
dwNumberOfCurves
Número de estructuras entregadas en lpci (número de curvas a representar).

lpError
Valor de retorno
TRUE
Curvas representadas
FALSE
Error
Mensajes de error

TLG_API_NOT_SUPPORTED función no soportada
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
3.8.7.3 TLGInsertTemplateItem (RT Professional)
Descripción
La función añade una nueva entrada a una plantilla de ventana existente, bien una plantilla
de curva o una plantilla de tabla.

Declaración
BOOL TLGInsertTemplateItem (
LPTSTR lpszTemplateName,
PTLG_TEMPLATEITEM_INFO lpptii,
Parámetros
lpszTemplateName
Puntero al nombre de la plantilla de ventana a la que se desea añadir una plantilla de curva
o de tabla.
lpptii
Puntero a una estructura del tipo TLG_TEMPLATEITEM_INFO (Página 2208) con los datos
de la plantilla de curva o tabla que se debe añadir.
lpError
Valor de retorno
TRUE
Plantilla de ventana ampliada
FALSE
Error
Mensajes de error

activado
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib

pdertcli.dll
Ejemplos
Edit curve template - Example 1 (Página 2295) "TL02.cpp"
Consulte también
3.8.7.4 TLGPressToolbarButton (RT Professional)
Descripción
Esta función permite lanzar las funciones enlazadas con los botones de la barra de
herramientas.
Declaración
BOOL TLGPressToolbarButton (
LPTSTR lpszTemplate,
DWORD dwButtonID,
Parámetros
lpszTemplate
Nombre de la plantilla
dwButtonID
Clave para el botón a activar:
Constantes para curvas y tablas

TLG_BASIC_BTN_HELP Abrir ayuda en pantalla
TLG_BASIC_BTN_DLG Abrir diálogo de parametrización
TLG_BASIC_BTN_FIRST Mostrar el primer registro de un fichero.
TLG_BASIC_BTN_PREV Retroceder en el fichero.
TLG_BASIC_BTN_NEXT Avanzar en el fichero.
TLG_BASIC_BTN_LAST Mostrar el último registro de un fichero.
TLG_BASIC_BTN_STARTSTOP Activar o desactivar la representación actualizada de
una curva o tabla.
TLG_BASIC_BTN_PREV_ITEM Curva anterior en primer plano o columna de tabla pri‐
mero.

Constantes para curvas y tablas

TLG_BASIC_BTN_NEXT_ITEM Siguiente curva en primer plano o columna de tabla pri‐
mero.
TLG_BASIC_BTN_ARC_VAR_SELECT Abre el diálogo de selección de las variables del fichero.
TLG_BASIC_BTN_ITEM_SELECT Abre el diálogo de selección para curvas o columnas de
tabla.
TLG_BASIC_BTN_TIME_SELECT Abre el diálogo de selección para el dominio temporal
de representación.
Constantes para tablas

TLG_TABLE_BTN_EDIT Activa o desactiva la función de edición.
Constantes para curvas

TLG_CURVE_BTN_ZOOMIN Activación de la función de zoom para ampliar seccio‐
nes.
TLG_CURVE_BTN_ZOOMOUT Desactivación de la función de zoom.
TLG_CURVE_BTN_1_TO_1 Cambiar a la representación normal de una curva.
TLG_CURVE_BTN_LINEAL Activación o desactivación de la regla.
lpError
Mensajes de error

IDS_API_ERROR_WINDOW_NOT_FOUND no se ha podido encontrar el Button ( ventana )
activado
TLG_API_NO_TYP_CHANGE_ALLOWED Modificación de tipo no autorizada
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

3.8.7.5 TLGSetRulerWindowVisible (RT Professional)
Descripción
Esta función permite mostrar u ocultar la ventana de datos de la línea de lectura.
Declaración
BOOL TLGSetRulerWindowVisible (
LPTSTR lpszTemplateName,
BOOL bShowRulerWindow,
Parámetros
lpszTemplateName
Puntero al nombre de la plantilla de ventana.
bShowRulerWindow
TRUE: Se muestra la línea de lectura con ventana de datos

FALSE: Se muestra la línea de lectura sin ventana de datos
lpError
Valor de retorno
TRUE
Se ha aceptado nuevamente el parámetro para la visibilidad de la ventana de datos de la línea
de lectura.
FALSE
Error
Comentario
En el visor de curvas f(x) y el visor de tablas, la función resulta efectiva en cuanto se muestra
la imagen correspondiente con el objeto.

Mensajes de error

IDS_API_ERROR_WINDOW_NOT_FOUND no se ha podido encontrar el Button ( ventana )
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
3.8.7.6 TLGShowWindow (RT Professional)
Descripción
La función influye en la forma en que se representa la ventana.
Declaración
BOOL TLGShowWindow (
HWND hwnd,
DWORD dwFlags,
Parámetros
hwnd
Handle de ventana de la ventana Runtime.
dwFlags
Aquí se aplican los mismos Flags que en ::ShowWindow(HWND hwnd, int nCmdShow), tal y
como se definen en WinUser.h (SW_SHOW, SW_HIDE, ...).
lpError

Valor de retorno
TRUE
Ventana de aplicación mostrada
FALSE
Error
Mensajes de error

Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
WinUser.h
3.8.8 Funciones para procesar sistemas de tiempo (RT Professional)
3.8.8.1 TLGEnumTime (RT Professional)
Descripción
Enumera los nombres de todos los tiempos de adquisición y archivación de un proyecto.
Declaración
BOOL TLGEnumTime (
HANDLE hProject,
TLG_ENUM_TIME_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,

Parámetros
hProject
Handle del proyecto en el que se encuentran los objetos de tiempo a listar.
lpCallbackFunc
Puntero a la función Callback que se llama una única vez para cada objeto de tiempo existente.
lpUser
lpoes
Valor de retorno
TRUE
Objetos de tiempo listados
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
TLG_ENUM_TIME_NAME_CALLBACK (Pági‐ Listar objetos de tiempo (Callback)

na 2283)
Ejemplos
Consulte también
TLG_ENUM_TIME_NAME_CALLBACK (Página 2283)

3.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK (RT Professional)
Descripción
Para poder evaluar los objetos de tiempo listados por el sistema debe proporcionar una función
Callback del tipo TLG_ENUM_TIME_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_TIME_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetros
lpszName
El puntero lpszName remite al nombre del primer objeto de tiempo.
lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
pdecscli.h

TLGEnumTime (Página 2279) Listar objetos de tiempo
Ejemplos
Consulte también
TLGEnumTime (Página 2279)
3.8.8.3 TLGEnumTimes (RT Professional)
Descripción
Enumera todos los tiempos de adquisición y archivación.
Declaración
BOOL TLGEnumTimes(
TLG_ENUMTIMES_CALLBACK lpfnCallback,
LPVOID lpUser,
Parámetros
lpfnCallback
Puntero a la función Callback,
lpUser
lpError
Valor de retorno
TRUE
Objetos de tiempo listados.

FALSE
Error
Mensajes de error

activado
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_ENUMTIMES_CALLBACK (Página 2285)
3.8.8.4 TLG_ENUMTIMES_CALLBACK (RT Professional)
Descripción
Para poder evaluar los objetos de tiempo listados por el sistema debe proporcionar una función
Callback del tipo TLG_ENUMTIMES_CALLBACK.
Declaración
BOOL ( * TLG_ENUMTIMES_CALLBACK) (
PTLG_TIMEDATA lpTime,
PVOID lpUser );

Parámetros
lpTime
Por cada objeto de tiempo el sistema reserva memoria temporalmente con la longitud de la
estructura TLG_TIMEDATA (Página 2211). El puntero lpTime remite al comienzo del primer
elemento.
lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
TLGEnumTimes (Página 2282) Listar objetos de tiempo
Consulte también
TLGEnumTimes (Página 2282)
TLG_TIMEDATA (Página 2211)

3.8.8.5 TLGReadTime (RT Professional)
Descripción
Lectura de los parámetros de un objeto de tiempo ya creado.
Declaración
BOOL TLGReadTime (
HANDLE hProject,
LPTSTR lpszTimeName,
PTLG_TIME_STR lpTime,
Parámetros
hProject
Handle del proyecto en el que se encuentra el objeto de tiempo a editar.
lpszTimeName
Puntero al nombre del objeto de tiempo
lpTime
Dirección de la estructura TLG_TIME_STR (Página 2210) con los datos del objeto de tiempo.
lpoes
Valor de retorno
TRUE
Parámetros del objeto de tiempo leídos.
FALSE
Error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

Ejemplos
Consulte también
TLG_TIME_STR (Página 2210)
3.8.9 Funciones para proteger y restaurar (RT Professional)
3.8.9.1 TLGEnumBackupEntries (RT Professional)
Descripción
Ya no se soporta esta función, devolviéndose el valor FALSE y el código de error
TLG_API_NOT_SUPPORTED.
Declaración
BOOL TLGEnumBackupEntries (
TLG_ENUMBACKUP_ENTRIES lpfnCallback,
LPVOID lpUser,
Parámetros
lpszArchivName
lpfnCallback
Puntero a la función Callback que se llama para cada copia de seguridad existente.
lpUser
lpError

Valor de retorno
TRUE
Copias de seguridad listadas
FALSE
Error
Mensajes de error

Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_ENUMBACKUP_ENTRIES (Página 2289)
3.8.9.2 TLG_ENUMBACKUP_ENTRIES (RT Professional)
Descripción
Ya no se soporta la función TLGEnumBackupEntries. Para poder evaluar las copias de
seguridad listadas por el sistema debe proporcionar una función Callback del tipo
TLG_ENUMBACKUP_ENTRIES.

Declaración
BOOL ( * TLG_ENUMBACKUP_ENTRIES) (
PTLG_BACKUP_TABLE_INFO lpbti,
PVOID lpUser );
Parámetros
lpbti
Por cada copia de seguridad el sistema reserva memoria temporalmente con la longitud de
la estructura TLG_BACKUP_TABLE_INFO (Página 2188). El puntero lpbti remite al comienzo
del primer elemento.
lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Comentario
Nota
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h

TLGEnumBackupEntries (Página 2286) Listar copias de seguridad
Consulte también
TLGEnumBackupEntries (Página 2286)
TLG_BACKUP_TABLE_INFO (Página 2188)
3.8.9.3 TLGExport (RT Professional)
Descripción
Esta función permite exportar partes de un fichero. La selección de los registros a exportar se
realiza con la estructura TLG_IO_BACKUP_SELECT.
Declaración
BOOL TLGExport (
LPTSTR lpszFileName,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
Parámetros
lpszArchivName
Puntero al nombre del fichero. Se debe indicar el nombre con la estructura "nombre de archivo
\ nombre de variable".
Con TLGEnumArchivsEx y TLGEnumVariablesEx se pueden determinar los componentes del
nombre.
lpszFileName
Puntero al nombre del fichero al que se deben exportar los datos.
lpibs
Dirección de la estructura de transferencia TLG_IO_BACKUP_SELECT (Página 2200) para
los parámetros de selección.
dwJobFlags
El parámetro está previsto para futuras ampliaciones y se debe asignar con 0L.

Manua

WCC PReference Es-ES

Cargado por

Información del documento

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

WCC PReference Es-ES

Cargado por

Copyright:

Formatos disponibles

VB Scripting 1

C-Scripting (RT Professional) 2

Impresión de la Ayuda en pantalla

WinCC Engineering V15.1: Referencia para la programación

1.1.45 Logoff (Panels, Comfort Panels, RT Advanced)....................................................................73

WinCC Engineering V15.1: Referencia para la programación

1.2.2 ActivateScreenInScreenWindow (RT Professional).............................................................122

WinCC Engineering V15.1: Referencia para la programación

1.4.5.8 Input (Panels, Comfort Panels)............................................................................................177

WinCC Engineering V15.1: Referencia para la programación

1.5.5.2 Propiedades B (Panels, Comfort Panels, RT Advanced, RT Professional).........................537

WinCC Engineering V15.1: Referencia para la programación

2.1.16.12 Funciones GetTagValueStateQCWait (RT Professional)..................................................1436

WinCC Engineering V15.1: Referencia para la programación

2.1.43.2 uaArchiveDelete (RT Professional)....................................................................................1507

WinCC Engineering V15.1: Referencia para la programación

2.2.3 Funciones math (RT Professional).....................................................................................1545

WinCC Engineering V15.1: Referencia para la programación

3.2.2.21 DM_VARKEY (RT Professional)........................................................................................1614

WinCC Engineering V15.1: Referencia para la programación

3.2.5.8 DMSetBlockQueueSize (RT Professional).........................................................................1697

WinCC Engineering V15.1: Referencia para la programación

3.2.8 Funciones para procesar conexiones (RT Professional)...................................................1817

WinCC Engineering V15.1: Referencia para la programación

3.2.11.31 OnTestVariablenSuspendvarupdate (RT Professional).....................................................1888

WinCC Engineering V15.1: Referencia para la programación

3.4.2.3 CREATE_USER_HEADER_FILE (RT Professional)..........................................................1980

WinCC Engineering V15.1: Referencia para la programación

3.5.6.3 PWGENDeletePermLevel (RT Professional).....................................................................2038

WinCC Engineering V15.1: Referencia para la programación

3.6.4.3 TXTGetFont (RT Professional)..........................................................................................2092

WinCC Engineering V15.1: Referencia para la programación

3.7.7.5 Show print job preview (RT Professional)..........................................................................2167

WinCC Engineering V15.1: Referencia para la programación

3.8.6.7 TLGFreeMemory (RT Professional)...................................................................................2255

WinCC Engineering V15.1: Referencia para la programación

3.9.4.1 uaConnect (RT Professional).............................................................................................2330

WinCC Engineering V15.1: Referencia para la programación

3.9.10.3 uaArchiveWriteTagValues (RT Professional).....................................................................2385

WinCC Engineering V15.1: Referencia para la programación

3.10.6 Funciones para la edición de grupos de aviso (RT Professional)......................................2474

WinCC Engineering V15.1: Referencia para la programación

3.13.2 CCStorageError.h (RT Professional).................................................................................2536

WinCC Engineering V15.1: Referencia para la programación

WinCC Engineering V15.1: Referencia para la programación

1.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)

Utilización en la lista de funciones

Utilización en funciones definidas por el usuario

1.1.2 ActivatePLCCodeView (Panels, Comfort Panels, RT Advanced)

WinCC Engineering V15.1: Referencia para la programación

Utilización en la lista de funciones

Utilización en funciones definidas por el usuario

WinCC Engineering V15.1: Referencia para la programación

1.1.3 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)

WinCC Engineering V15.1: Referencia para la programación

Utilización en la lista de funciones

Utilización en funciones definidas por el usuario

1.1.4 ActivateScreen (Panels, Comfort Panels, RT Advanced)

Utilización en la lista de funciones

Utilización en funciones definidas por el usuario

Número del objeto

WinCC Engineering V15.1: Referencia para la programación

1.1.5 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced)

Utilización en la lista de funciones