WCC Professional V13 SP2 Prog EsES Es-ES

C-Scripting (RT Professional) 1
API de runtime (RT

Professional) 2
VB-Scripting (Panels,
SIMATIC Comfort Panels, RT 3
Advanced, RT Professional)
WinCC
WinCC Professional V13 SP2 -
Referencia para programación
Manual de sistema
Impresión de la Ayuda en pantalla
03/2017
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 2017.
Division Digital Factory Ⓟ 05/2017 Sujeto a cambios sin previo aviso Reservados todos los derechos
Postfach 48 48
90026 NÜRNBERG
ALEMANIA
Índice
1 C-Scripting (RT Professional).....................................................................................................................23

1.1 Funciones de sistema (RT Professional)...............................................................................23
1.1.1 ActivateNextScreen (RT Professional)...................................................................................23
1.1.2 ActivatePreviousScreen (RT Professional)............................................................................24
1.1.3 ActivateScreen (RT Professional)..........................................................................................25
1.1.4 ActivateScreenInScreenWindow (RT Professional)...............................................................26
1.1.5 ActivateStartScreen (RT Professional)..................................................................................27
1.1.6 ActivateStoredScreen (RT Professional)...............................................................................28
1.1.7 DecreaseTag (RT Professional).............................................................................................29
1.1.8 GetLocalScreen (RT Professional)........................................................................................31
1.1.9 GetLinkedTag (RT Professional)............................................................................................33
1.1.10 GetLanguageByLocaleID (RT Professional)..........................................................................34
1.1.11 GetParentScreen (RT Professional)......................................................................................36
1.1.12 GetParentScreenWindow (RT Professional)..........................................................................37
1.1.13 GetProp (RT Professional).....................................................................................................39
1.1.13.1 GetPropBOOL (RT Professional)..........................................................................................39
1.1.13.2 GetPropChar (RT Professional).............................................................................................40
1.1.13.3 GetPropDouble (RT Professional).........................................................................................42
1.1.13.4 GetPropLong (RT Professional).............................................................................................43
1.1.14 GetServerTagPrefix (RT Professional)..................................................................................44
1.1.15 GetTag (RT Professional)......................................................................................................47
1.1.15.1 Funciones GetTag (RT Professional).....................................................................................47
1.1.15.2 Función GetTagDateTime (RT Professional).........................................................................48
1.1.15.3 Funciones GetTagMultiStateQCWait (RT Professional)........................................................49
1.1.15.4 Funciones GetTagMultiStateWait (RT Professional).............................................................51
1.1.15.5 Funciones GetTagMultiWait (RT Professional)......................................................................52
1.1.15.6 Funciones GetTagState (RT Professional)............................................................................53
1.1.15.7 Funciones GetTagStateQC (RT Professional).......................................................................56
1.1.15.8 Funciones GetTagStateQCWait (RT Professional)................................................................58
1.1.15.9 Funciones GetTagStateWait (RT Professional).....................................................................61
1.1.15.10 Funciones GetTagValue (RT Professional)...........................................................................63
1.1.15.11 Funciones GetTagValueStateQC (RT Professional)..............................................................65
1.1.15.12 Funciones GetTagValueStateQCWait (RT Professional)......................................................66
1.1.15.13 Funciones GetTagValueWait (RT Professional)....................................................................68
1.1.15.14 Funciones GetTagWait (RT Professional).............................................................................69
1.1.16 IncreaseTag (RT Professional)..............................................................................................71
1.1.17 InquireLanguage (RT Professional).......................................................................................72
1.1.18 InverseLinearScaling (RT Professional).................................................................................74
1.1.19 InvertBit (RT Professional).....................................................................................................76
1.1.20 InvertBitInTag (RT Professional)............................................................................................77
1.1.21 IsUserAuthorized (RT Professional).......................................................................................78
1.1.22 LinearScaling (RT Professional)............................................................................................79
1.1.23 ReportJob (RT Professional)..................................................................................................81
1.1.24 ResetBit (RT Professional).....................................................................................................82
1.1.25 ResetBitInTag (RT Professional)...........................................................................................83
1.1.26 SetBit (RT Professional).........................................................................................................84
WinCC Professional V13 SP2 - Referencia para programación

Manual de sistema, 03/2017, Expresión de la ayuda en pantalla 3
Índice
1.1.27 SetBitInTag (RT Professional)...............................................................................................85

1.1.28 SetLanguageByLocaleID (RT Professional)..........................................................................87
1.1.29 SetProp (RT Professional).....................................................................................................88
1.1.29.1 SetPropBOOL (RT Professional)...........................................................................................88
1.1.29.2 SetPropChar (RT Professional).............................................................................................90
1.1.29.3 SetPropDouble (RT Professional)..........................................................................................91
1.1.29.4 SetPropLong (RT Professional).............................................................................................93
1.1.30 SetPropertyByConstant (RT Professional).............................................................................94
1.1.31 SetPropertyByProperty (RT Professional).............................................................................96
1.1.32 SetPropertyByTag (RT Professional).....................................................................................97
1.1.33 SetPropertyByTagIndirect (RT Professional).........................................................................99
1.1.34 SetTag (RT Professional).....................................................................................................100
1.1.34.1 Funciones SetTag (RT Professional)...................................................................................100
1.1.34.2 SetTagDateTime (RT Professional).....................................................................................102
1.1.34.3 Funciones SetTagMultiStateWait (RT Professional)............................................................103
1.1.34.4 Funciones SetTagMultiWait (RT Professional)....................................................................104
1.1.34.5 Funciones SetTagState (RT Professional)...........................................................................107
1.1.34.6 Funciones SetTagStateWait (RT Professional)...................................................................109
1.1.34.7 Funciones SetTagValue (RT Professional)..........................................................................112
1.1.34.8 Funciones SetTagValueWait (RT Professional)...................................................................114
1.1.34.9 Funciones SetTagWait (RT Professional)............................................................................115
1.1.34.10 SetTag (RT Professional).....................................................................................................117
1.1.34.11 SetTagByProperty (RT Professional)...................................................................................118
1.1.34.12 SetTagByTagIndirect (RT Professional)..............................................................................120
1.1.34.13 SetTagIndirect (RT Professional)........................................................................................121
1.1.34.14 SetTagIndirectByProperty (RT Professional).......................................................................121
1.1.34.15 SetTagIndirectByTagIndirect (RT Professional)...................................................................123
1.1.34.16 SetTagIndirectWithOperatorInputAlarm (RT Professional)..................................................124
1.1.34.17 SetTagWithOperatorEvent (RT Professional)......................................................................124
1.1.35 StartProgram (RT Professional)...........................................................................................125
1.1.36 StopRuntime (RT Professional)...........................................................................................126
1.1.37 StoreScreen (RT Professional)...........................................................................................127
1.1.38 TriggerOperatorEvent (RT Professional).............................................................................128
1.1.39 UA (Recipe) (RT Professional).............................................................................................129
1.1.39.1 uaAddArchive (RT Professional)..........................................................................................129
1.1.39.2 uaAddField (RT Professional)..............................................................................................130
1.1.39.3 uaArchiveClose (RT Professional).......................................................................................131
1.1.39.4 uaArchiveDelete (RT Professional)......................................................................................131
1.1.39.5 uaArchiveExport (RT Professional)......................................................................................132
1.1.39.6 uaArchiveGetCount (RT Professional).................................................................................133
1.1.39.7 uaArchiveGetFieldLength (RT Professional)........................................................................134
1.1.39.8 uaArchiveGetFieldName (RT Professional).........................................................................134
1.1.39.9 uaArchiveGetFields (RT Professional).................................................................................135
1.1.39.10 uaArchiveGetFieldType (RT Professional)..........................................................................136
1.1.39.11 uaArchiveGetFieldValueDate (RT Professional)..................................................................136
1.1.39.12 uaArchiveGetFieldValueDouble (RT Professional)..............................................................137
1.1.39.13 uaArchiveGetFieldValueFloat (RT Professional).................................................................138
1.1.39.14 uaArchiveGetFieldValueLong (RT Professional).................................................................139
1.1.39.15 uaArchiveGetFieldValueString (RT Professional)................................................................139
1.1.39.16 uaArchiveGetFilter (RT Professional)..................................................................................140
1.1.39.17 uaArchiveGetID (RT Professional).......................................................................................141
1.1.39.18 uaArchiveGetName (RT Professional).................................................................................141

4 Manual de sistema, 03/2017, Expresión de la ayuda en pantalla
Índice
1.1.39.19 uaArchiveGetSor (RT Professional).....................................................................................142

1.1.39.20 uaArchiveImport (RT Professional)......................................................................................143
1.1.39.21 uaArchiveInsert (RT Professional).......................................................................................144
1.1.39.22 uaArchiveMoveFirst (RT Professional)................................................................................144
1.1.39.23 uaArchiveMoveLast (RT Professional)................................................................................145
1.1.39.24 uaArchiveMoveNext (RT Professional)................................................................................145
1.1.39.25 uaArchiveMovePrevious (RT Professional).........................................................................146
1.1.39.26 uaArchiveOpen (RT Professional).......................................................................................147
1.1.39.27 uaArchiveReadTagValues (RT Professional)......................................................................147
1.1.39.28 uaArchiveReadTagValuesByName (RT Professional).........................................................148
1.1.39.29 uaArchiveRequery (RT Professional)...................................................................................149
1.1.39.30 uaArchiveSetFieldValueDate (RT Professional)..................................................................150
1.1.39.31 uaArchiveSetFieldValueDouble (RT Professional)..............................................................151
1.1.39.32 uaArchiveSetFieldValueFloat (RT Professional)..................................................................152
1.1.39.33 uaArchiveSetFieldValueLong (RT Professional)..................................................................152
1.1.39.34 uaArchiveSetFieldValueString (RT Professional)...............................................................153
1.1.39.35 uaArchiveSetFilter (RT Professional)...................................................................................154
1.1.39.36 uaArchiveSetSort (RT Professional)....................................................................................155
1.1.39.37 uaArchiveUpdate (RT Professional).....................................................................................156
1.1.39.38 uaArchiveWriteTagValues (RT Professional).......................................................................156
1.1.39.39 uaArchiveWriteTagValuesByName (RT Professional).........................................................157
1.1.39.40 uaConnect (RT Professional)...............................................................................................158
1.1.39.41 uaDisconnect (RT Professional)..........................................................................................158
1.1.39.42 uaGetArchive (RT Professional)..........................................................................................159
1.1.39.43 uaGetField (RT Professional)...............................................................................................160
1.1.39.44 uaGetLastError (RT Professional).......................................................................................161
1.1.39.45 uaGetLastHResult (RT Professional)..................................................................................163
1.1.39.46 uaGetNumArchives (RT Professional).................................................................................163
1.1.39.47 uaGetNumFields (RT Professional).....................................................................................164
1.1.39.48 uaQueryArchive (RT Professional).....................................................................................164
1.1.39.49 uaQueryArchiveByName (RT Professional)........................................................................165
1.1.39.50 uaQueryConfiguration (RT Professional).............................................................................166
1.1.39.51 uaReleaseArchive (RT Professional)...................................................................................167
1.1.39.52 uaReleaseConfiguration (RT Professional).........................................................................168
1.1.39.53 uaRemoveAllArchives (RT Professional)............................................................................169
1.1.39.54 uaRemoveAllFields (RT Professional).................................................................................169
1.1.39.55 uaRemoveArchive (RT Professional)...................................................................................170
1.1.39.56 uaRemoveField (RT Professional).......................................................................................171
1.1.39.57 uaSetArchive (RT Professional)...........................................................................................171
1.1.39.58 uaSetField (RT Professional)...............................................................................................172
1.2 C-bib (RT Professional)........................................................................................................173
1.2.1 Funciones ctype (RT Professional)......................................................................................173
1.2.2 Grupo de funciones c_bib (RT Professional).......................................................................174
1.2.3 Funciones math (RT Professional).......................................................................................175
1.2.4 Funciones memory (RT Professional)..................................................................................176
1.2.5 Funciones multibyte (RT Professional)................................................................................176
1.2.6 Funciones stdio (RT Professional).......................................................................................177
1.2.7 Funciones stdlib (RT Professional)......................................................................................178
1.2.8 Funciones string (RT Professional)......................................................................................179
1.2.9 Funciones time (RT Professional)........................................................................................180
1.3 Definición de estructura (RT Professional)..........................................................................181

Índice
1.3.1 Definición de estructura CCAPErrorExecute (RT Professional)..........................................181

1.3.2 Definición de estructura CCAPTime (RT Professional).......................................................182
1.3.3 Definición de estructura CMN_ERROR (RT Professional)..................................................183
1.3.4 Definición de estructura DM_TYPEREF (RT Professional).................................................184
1.3.5 Definición de estructura DM_VAR_UPDATE_STRUCT (RT Professional)..........................185
1.3.6 Definición de estructura DM_VAR_UPDATE_STRUCTEX (RT Professional).....................186
1.3.7 Definición de estructura DM_VARKEY (RT Professional)..................................................187
1.3.8 Definición de estructura LINKINFO (RT Professional).........................................................187
1.3.9 Definición de estructura MSG_FILTER_STRUCT (RT Professional)...................................189
1.3.10 Definición de estructura MSG_RTDATA_STRUCT (RT Professional).................................192
2 API de runtime (RT Professional).............................................................................................................195
2.1 Runtime API (RT Professional)............................................................................................195
2.2 Funciones de la gestión de datos (RT Professional)...........................................................196
2.2.1 Principios básicos (RT Professional)...................................................................................196
2.2.1.1 Sinopsis de las estructuras (RT Professional).....................................................................196
2.2.1.2 Sinopsis de las funciones (RT Professional)........................................................................197
2.2.1.3 Quality Codes de variables HMI (RT Professional)..............................................................198
2.2.1.4 Constantes (RT Professional)..............................................................................................202
2.2.1.5 Mensajes de error (RT Professional)...................................................................................206
2.2.1.6 Rutinas de conversión (Control Center) (RT Professional)..................................................208
2.2.2 Estructuras (RT Professional)..............................................................................................214
2.2.2.1 DM_CONNECTION_DATA (RT Professional).....................................................................214
2.2.2.2 DM_CONNKEY (RT Professional).......................................................................................215
2.2.2.3 DM_CYCLE_INFO (RT Professional)..................................................................................216
2.2.2.4 DM_DATA_SERVICE (RT Professional)..............................................................................217
2.2.2.5 DM_DIRECTORY_INFO (RT Professional).........................................................................218
2.2.2.6 DM_DLGOPTIONS (RT Professional).................................................................................219
2.2.2.7 DM_FORMAT_INFO (RT Professional)...............................................................................221
2.2.2.8 DM_MACHINE_TABLE (RT Professional)...........................................................................221
2.2.2.9 DM_PROJECT_INFO (RT Professional)..............................................................................222
2.2.2.10 DM_SEND_DATA_STRUCT (RT Professional)...................................................................223
2.2.2.11 DM_SD_TARGET_MACHINE (RT Professional).................................................................225
2.2.2.12 DM_SD_TARGET_APP (RT Professional)..........................................................................226
2.2.2.13 DM_TYPEREF (RT Professional)........................................................................................227
2.2.2.14 DM_VAR_UPDATE_STRUCT (RT Professional).................................................................228
2.2.2.15 DM_VAR_UPDATE_STRUCTEX (RT Professional)............................................................230
2.2.2.16 DM_VARFILTER (RT Professional).....................................................................................233
2.2.2.17 DM_VARGRP_DATA (RT Professional)..............................................................................235
2.2.2.18 DM_VARGRPKEY (RT Professional)..................................................................................236
2.2.2.19 DM_VARIABLE_DATA (RT Professional)............................................................................237
2.2.2.20 DM_VARIABLE_DATA4 (RT Professional)..........................................................................239
2.2.2.21 DM_VARKEY (RT Professional)..........................................................................................242
2.2.2.22 DM_VARLIMIT (RT Professional)........................................................................................244
2.2.2.23 MCP_NEWVARIABLE_DATA (RT Professional).................................................................245
2.2.2.24 MCP_NEWVARIABLE_DATA_4 (RT Professional).............................................................248
2.2.2.25 MCP_NEWVARIABLE_DATA_5 (RT Professional).............................................................250
2.2.2.26 MCP_NEWVARIABLE_DATA_EX (RT Professional)..........................................................252
2.2.2.27 MCP_NEWVARIABLE_DATA_EX4 (RT Professional)........................................................254
2.2.2.28 MCP_VARIABLE_COMMON (RT Professional)..................................................................257
2.2.2.29 MCP_VARIABLE_COMMON_EX (RT Professional)............................................................258
2.2.2.30 MCP_VARIABLE_LIMITS (RT Professional).......................................................................261

Índice
2.2.2.31 MCP_VARIABLE_LIMITS5 (RT Professional).....................................................................263

2.2.2.32 MCP_VARIABLE_LIMITS_EX (RT Professional).................................................................265
2.2.2.33 MCP_VARIABLE_PROTOCOL (RT Professional)...............................................................266
2.2.2.34 MCP_VARIABLE_PROTOCOL_EX (RT Professional)........................................................268
2.2.2.35 MCP_VARIABLE_SCALES (RT Professional).....................................................................269
2.2.3 Funciones generales (RT Professional)...............................................................................270
2.2.3.1 DMActivateRTProject (RT Professional)..............................................................................270
2.2.3.2 DMAddNotify (RT Professional)...........................................................................................271
2.2.3.3 DMChangeDataLocale (RT Professional)............................................................................278
2.2.3.4 DMConnect (RT Professional).............................................................................................279
2.2.3.5 DM_NOTIFY_PROC (RT Professional)...............................................................................282
2.2.3.6 DMDeactivateRTProject (RT Professional)..........................................................................285
2.2.3.7 DMDisconnect (RT Professional).........................................................................................286
2.2.3.8 DMEnumNumberFormats (RT Professional).......................................................................287
2.2.3.9 DM_ENUM_FORMATS_PROC (RT Professional)...............................................................289
2.2.3.10 DMEnumUpdateCycles (RT Professional)...........................................................................290
2.2.3.11 DM_ENUM_CYCLES_PROC (RT Professional)..................................................................292
2.2.3.12 DMExitWinCC (RT Professional).........................................................................................293
2.2.3.13 DMExitWinCCEx (RT Professional).....................................................................................294
2.2.3.14 DMFireNotifyData (RT Professional)....................................................................................295
2.2.3.15 DMGetConnectionState (RT Professional)..........................................................................298
2.2.3.16 DMGetDataLocale (RT Professional)...................................................................................299
2.2.3.17 DMGetHotkey (RT Professional)..........................................................................................300
2.2.3.18 DMGetMachineInfo (RT Professional).................................................................................301
2.2.3.19 DMGetMachineTable (RT Professional)..............................................................................302
2.2.3.20 DMRemoveNotify (RT Professional)....................................................................................303
2.2.4 Funciones para la administración de proyectos (RT Professional)......................................306
2.2.4.1 DMEnumOpenedProjects (RT Professional).......................................................................306
2.2.4.2 DM_ENUM_OPENED_PROJECTS_PROC (RT Professional)............................................307
2.2.4.3 DMGetProjectDirectory (RT Professional)...........................................................................309
2.2.4.4 DMGetProjectInformation (RT Professional)........................................................................310
2.2.4.5 DMGetRuntimeProject (RT Professional)............................................................................312
2.2.4.6 DMOpenProjectDocPlus (RT Professional).........................................................................313
2.2.4.7 DMOpenProjectPlus (RT Professional)................................................................................314
2.2.5 Canales de transporte de datos (RT Professional)..............................................................316
2.2.5.1 DMClearBlockQueue (RT Professional)..............................................................................316
2.2.5.2 DMEnumDataServices (RT Professional)............................................................................317
2.2.5.3 DM_ENUM_DATA_SERVICE_PROC (RT Professional).....................................................319
2.2.5.4 DM_DATA_SERVICE_PROC (RT Professional).................................................................320
2.2.5.5 DMGetNumPendingBlocks (RT Professional).....................................................................321
2.2.5.6 DMInstallDataService (RT Professional)..............................................................................322
2.2.5.7 DMSendApplicationData (RT Professional).........................................................................324
2.2.5.8 DMSetBlockQueueSize (RT Professional)...........................................................................325
2.2.6 Funciones para procesar variables (RT Professional).........................................................326
2.2.6.1 DMEnumVarData (RT Professional)....................................................................................326
2.2.6.2 DM_ENUM_VARIABLE_PROC (RT Professional)...............................................................328
2.2.6.3 DMEnumVarData4 (RT Professional)..................................................................................330
2.2.6.4 DM_ENUM_VARIABLE_PROC4 (RT Professional).............................................................332
2.2.6.5 DMEnumVarGrpData (RT Professional)..............................................................................334
2.2.6.6 DMEnumVarGrpDataExStr (RT Professional).....................................................................335
2.2.6.7 DM_ENUM_VARGRP_PROC (RT Professional).................................................................337
2.2.6.8 DMEnumVariables (RT Professional)..................................................................................338

Índice
2.2.6.9 DM_ENUM_VAR_PROC (RT Professional).........................................................................340

2.2.6.10 DMGetValue (RT Professional)............................................................................................342
2.2.6.11 DMGetValueEx (RT Professional).......................................................................................344
2.2.6.12 DMGetValueExStr (RT Professional)...................................................................................345
2.2.6.13 DMGetValueWait (RT Professional)....................................................................................355
2.2.6.14 DMGetValueWaitEx (RT Professional)................................................................................357
2.2.6.15 DMGetValueWaitExStr (RT Professional)............................................................................359
2.2.6.16 DMGetVarInfo (RT Professional).........................................................................................361
2.2.6.17 DMGetVarInfoExStr (RT Professional)................................................................................363
2.2.6.18 DMGetVarLimits (RT Professional)......................................................................................373
2.2.6.19 DMGetVarLimitsExStr (RT Professional).............................................................................375
2.2.6.20 DMGetVarType (RT Professional).......................................................................................379
2.2.6.21 DMGetVarTypeExStr (RT Professional)..............................................................................381
2.2.6.22 DMSetValue (RT Professional)............................................................................................386
2.2.6.23 DMSetValueExStr (RT Professional)...................................................................................389
2.2.6.24 DMSetValueMessage (RT Professional).............................................................................392
2.2.6.25 DMSetValueMessageExStr (RT Professional).....................................................................394
2.2.6.26 DMSetValueWait (RT Professional).....................................................................................395
2.2.6.27 DMSetValueWaitExStr (RT Professional)............................................................................398
2.2.6.28 DMSetValueWaitMessage (RT Professional)......................................................................401
2.2.6.29 DMSetValueWaitMessageExStr (RT Professional).............................................................404
2.2.6.30 DM_COMPLETITION_PROC (RT Professional)..................................................................406
2.2.6.31 DMShowVarPropertiesExStr (RT Professional)...................................................................408
2.2.6.32 DMShowVarDatabase (RT Professional).............................................................................411
2.2.6.33 DMShowVarDatabaseExStr (RT Professional)....................................................................413
2.2.6.34 DMShowVarDatabaseMulti (RT Professional).....................................................................416
2.2.6.35 DMShowVarDatabaseMultiExStr (RT Professional)............................................................418
2.2.6.36 DM_NOTIFY_SELECT_VAR_PROC (RT Professional)......................................................422
2.2.6.37 GAPICreateNewVariable (RT Professional)........................................................................423
2.2.6.38 GAPICreateNewVariable4 (RT Professional).....................................................................425
2.2.6.39 GAPICreateNewVariable5 (RT Professional).....................................................................426
2.2.6.40 GAPICreateNewVariableEx4 (RT Professional).................................................................428
2.2.7 Funciones para procesar variables estructuradas (RT Professional)..................................430
2.2.7.1 GAPIEnumTypeMembers (RT Professional).......................................................................430
2.2.7.2 DM_ENUM_TYPEMEMBERS_PROC (RT Professional).....................................................431
2.2.7.3 GAPIEnumTypeMembersEx (RT Professional)...................................................................433
2.2.7.4 GAPIEnumTypeMembersExStr (RT Professional)..............................................................434
2.2.7.5 DM_ENUM_TYPEMEMBERS_PROC_EX (RT Professional)..............................................436
2.2.7.6 GAPIEnumTypeMembersEx4 (RT Professional).................................................................437
2.2.7.7 DM_ENUM_TYPEMEMBERS_PROC_EX4 (RT Professional)............................................439
2.2.7.8 GAPIEnumTypes (RT Professional)....................................................................................440
2.2.7.9 DM_ENUM_TYPES_PROC (RT Professional)....................................................................442
2.2.8 Funciones para procesar conexiones (RT Professional).....................................................444
2.2.8.1 DMEnumConnectionData (RT Professional).......................................................................444
2.2.8.2 DMEnumConnectionDataExStr (RT Professional)...............................................................445
2.2.8.3 DM_ENUM_CONNECTION_PROC (RT Professional)........................................................447
2.2.9 Funciones de la plataforma de trabajo (RT Professional)....................................................448
2.2.9.1 DMGetOSVersion (RT Professional)...................................................................................448
2.2.9.2 DMGetSystemLocale (RT Professional)..............................................................................449
2.2.9.3 DMSetLanguage (RT Professional).....................................................................................450
2.2.9.4 DMShowLanguageDialog (RT Professional).......................................................................451
2.2.10 Funciones para actualizar variables (RT Professional)........................................................453

Índice
2.2.10.1 DMBeginStartVarUpdate (RT Professional).........................................................................453

2.2.10.2 DMEndStartVarUpdate (RT Professional)...........................................................................454
2.2.10.3 DMResumeVarUpdate (RT Professional)............................................................................455
2.2.10.4 DMStartVarUpdate (RT Professional)..................................................................................457
2.2.10.5 DM_NOTIFY_VARIABLE_PROC (RT Professional)............................................................459
2.2.10.6 DMStartVarUpdateEx (RT Professional)..............................................................................461
2.2.10.7 DMStartVarUpdateExStr (RT Professional).........................................................................463
2.2.10.8 DM_NOTIFY_VARIABLEEX_PROC (RT Professional).......................................................470
2.2.10.9 DMStopAllUpdates (RT Professional)..................................................................................472
2.2.10.10 DMStopVarUpdate (RT Professional)..................................................................................473
2.2.10.11 DMSuspendVarUpdate (RT Professional)...........................................................................474
2.2.11 Ejemplos (RT Professional).................................................................................................477
2.2.11.1 Connection to DM (RT Professional)...................................................................................477
2.2.11.2 Enum Data of Tags (RT Professional).................................................................................480
2.2.11.3 Enum open projects (RT Professional)................................................................................482
2.2.11.4 Enumerate all structured types (RT Professional)...............................................................484
2.2.11.5 Enumerate all connections (RT Professional)......................................................................486
2.2.11.6 Inquire project informations (RT Professional).....................................................................488
2.2.11.7 OnTestDeactivateRuntimeProject (RT Professional)...........................................................489
2.2.11.8 OnTestEnumGroupsAll (RT Professional)...........................................................................489
2.2.11.9 OnTestEnumVariables (RT Professional)............................................................................490
2.2.11.10 OnTestEnumConnectionDataAll (RT Professional).............................................................491
2.2.11.11 OnTestMachines (RT Professional).....................................................................................492
2.2.11.12 OnTestProjectInfo (RT Professional)...................................................................................492
2.2.11.13 OnTestProjectPaths (RT Professional)................................................................................494
2.2.11.14 OnTestOpenProject (RT Professional)................................................................................495
2.2.11.15 OnTestOpenProjects (RT Professional)...............................................................................496
2.2.11.16 OnTestRuntimeProject (RT Professional)............................................................................496
2.2.11.17 OnTestSystemLocale (RT Professional)..............................................................................497
2.2.11.18 OnTestUpdateCycles (RT Professional)..............................................................................497
2.2.11.19 OnTestVariablenBeginstartvarupdate (RT Professional).....................................................498
2.2.11.20 OnTestVariablenEndstartvarupdate (RT Professional)........................................................499
2.2.11.21 OnTestVariablenGetvalue (RT Professional).......................................................................500
2.2.11.22 OnTestVariablenGetvaluewait (RT Professional)................................................................503
2.2.11.23 OnTestVariablenGetVarInfo (RT Professional)....................................................................507
2.2.11.24 OnTestVariablenGetvarlimits (RT Professional)..................................................................508
2.2.11.25 OnTestVariablenGetvartype (RT Professional)....................................................................509
2.2.11.26 OnTestVariablenResumevarupdate (RT Professional)........................................................510
2.2.11.27 OnTestVariablenSetvalue (RT Professional).......................................................................511
2.2.11.28 OnTestVariablenSetvaluewait (RT Professional).................................................................512
2.2.11.29 OnTestVariablenStopallupdates (RT Professional).............................................................513
2.2.11.30 OnTestVariablenStopvarupdate (RT Professional)..............................................................513
2.2.11.31 OnTestVariablenSuspendvarupdate (RT Professional).......................................................514
2.2.11.32 OnTestWinCCShutdown (RT Professional).........................................................................514
2.2.11.33 Open project by means of dialog (RT Professional)............................................................515
2.2.11.34 Read tag (RT Professional)..................................................................................................516
2.2.11.35 Write tag (RT Professional)..................................................................................................521
2.3 Funciones del sistema gráfico (RT Professional).................................................................523

Índice
2.3.1.4 constantes (RT Professional)...............................................................................................526

2.3.1.5 Lista de las propiedades de objeto (A-K) (Graphics Designer) (RT Professional)...............527
2.3.1.6 Lista de las propiedades de objeto (L-Z) (Graphics Designer) (RT Professional)...............540
2.3.1.7 Llamadas de API en los OCX (RT Professional).................................................................553
2.3.2.1 LINKINFO (RT Professional)................................................................................................554
2.3.2.2 MULTILINK (RT Professional).............................................................................................556
2.3.2.3 MULTILINKINFO (RT Professional).....................................................................................557
2.3.2.4 FOCUSINFO (RT Professional)...........................................................................................558
2.3.3.1 PDLRTClosePicture (RT Professional)................................................................................558
2.3.3.2 PDLRTDisableClosePicture (RT Professional)....................................................................560
2.3.3.3 PDLRTEnableClosePicture (RT Professional).....................................................................562
2.3.3.4 PDLRTGotoPicture (RT Professional).................................................................................563
2.3.3.5 PDLRTInquireFreeArea (RT Professional)..........................................................................565
2.3.3.6 PDLRTOpenPicture (RT Professional)................................................................................566
2.3.3.7 PDLRTPictureNavigation (RT Professional)........................................................................569
2.3.3.8 PDLRTShowApp (RT Professional).....................................................................................570
2.3.3.9 PDLRT_CALLBACK (RT Professional)................................................................................571
2.3.4 Funciones para influir en el cursor de runtime (RT Professional)........................................573
2.3.4.1 PDLRTGetCursorKeys (RT Professional)............................................................................573
2.3.4.2 PDLRTGetFocus (RT Professional).....................................................................................575
2.3.4.3 PDLRTSetCursorKeys (RT Professional)............................................................................577
2.3.4.4 PDLRTSetFocus (RT Professional).....................................................................................579
2.3.5 Funciones para editar propiedades de objeto (RT Professional).........................................582
2.3.5.1 PDLRTGetDefPropEx (RT Professional).............................................................................582
2.3.5.2 PDLRTGetPropEx (RT Professional)...................................................................................584
2.3.5.3 PDLRTSetPropEx (RT Professional)...................................................................................587
2.3.6 Funciones para editar dinámicas (RT Professional)............................................................592
2.3.6.1 PDLRTGetLink (RT Professional)........................................................................................592
2.3.6.2 PDLRTSetLink (RT Professional)........................................................................................594
2.3.6.3 PDLRTSetMultiLink (RT Professional).................................................................................596
2.4 Funciones del scripting (RT Professional)...........................................................................598
2.4.2.1 AP_ACT_KEY (RT Professional).........................................................................................603
2.4.2.2 AP_ACT_RESULT_STRUCT (RT Professional)..................................................................605
2.4.2.3 CREATE_USER_HEADER_FILE (RT Professional)............................................................606
2.4.2.4 GENERATE_COMPILE (RT Professional)..........................................................................607
2.4.2.5 GET_ACTION_STREAM (RT Professional).........................................................................608
2.4.3.1 APConnect (RT Professional)..............................................................................................609
2.4.3.2 APDisconnect (RT Professional)..........................................................................................611
2.4.3.3 APSetLanguage (RT Professional)......................................................................................613
2.4.3.4 AP_RT_PROC (RT Professional).........................................................................................614
2.4.4 Funciones para editar Source Code (RT Professional).......................................................617
2.4.4.1 APCompile (RT Professional)..............................................................................................617
2.4.4.2 APCompileEx (RT Professional)..........................................................................................619

Índice
2.4.4.3 GSCGenCompile (RT Professional)....................................................................................622

2.4.4.4 GSCGenCompileUserFunctions (RT Professional).............................................................623
2.4.5 Funciones para editar acciones (RT Professional)..............................................................624
2.4.5.1 GSCGenGetActionStream (RT Professional)......................................................................624
2.4.6 Funciones de la programación de acción (RT Professional)...............................................625
2.4.6.1 APActive (RT Professional)..................................................................................................625
2.4.6.2 APEndAct (RT Professional)................................................................................................627
2.4.6.3 APFreeResultStruct (RT Professional)................................................................................629
2.4.6.4 APInactive (RT Professional)...............................................................................................630
2.4.6.5 APStart (RT Professional)....................................................................................................632
2.4.6.6 APTransact (RT Professional).............................................................................................634
2.4.7.1 Establish connection to script programming (RT Professional)...........................................636
2.5 Funciones de la administración de usuarios (RT Professional)...........................................638
2.5.2.1 PWGEN_GROUPINFO (RT Professional)...........................................................................641
2.5.2.2 PWGEN_LEVELINFO (RT Professional).............................................................................642
2.5.2.3 PWGEN_USERINFO (RT Professional)..............................................................................642
2.5.3.1 PWGENConnect (RT Professional).....................................................................................643
2.5.3.2 PWGENDisconnect (RT Professional).................................................................................645
2.5.4 Funciones para editar usuarios (RT Professional)...............................................................646
2.5.4.1 PWGENAddUser (RT Professional).....................................................................................646
2.5.4.2 PWGENAddUserEx (RT Professional)................................................................................648
2.5.4.3 PWGENChangePassword (RT Professional)......................................................................650
2.5.4.4 PWGENCheckUser (RT Professional).................................................................................651
2.5.4.5 PWGENDeleteUser (RT Professional).................................................................................652
2.5.4.6 PWGENEnumUsers (RT Professional)................................................................................654
2.5.4.7 PWGEN_ENUM_USERS_CALLBACK (RT Professional)...................................................655
2.5.5 Funciones para editar grupos de usuarios (RT Professional)..............................................657
2.5.5.1 PWGENAddGroup (RT Professional)..................................................................................657
2.5.5.2 PWGENEnumGroups (RT Professional).............................................................................658
2.5.5.3 PWGEN_ENUM_GROUPS_CALLBACK (RT Professional)................................................660
2.5.6 Funciones para editar autorizaciones (RT Professional).....................................................661
2.5.6.1 PWGENAddPermLevel (RT Professional)...........................................................................661
2.5.6.2 PWGENCheckPermission (RT Professional).......................................................................662
2.5.6.3 PWGENDeletePermLevel (RT Professional).......................................................................664
2.5.6.4 PWGENEnumPermLevels (RT Professional)......................................................................665
2.5.6.5 PWGEN_ENUM_LEVELS_CALLBACK (RT Professional)..................................................666
2.5.6.6 PWGENReadUserPerm (RT Professional)..........................................................................668
2.5.6.7 PWRTCheckPermission (RT Professional)..........................................................................669
2.5.6.8 PWRTCheckPermissionOnPicture (RT Professional)..........................................................670
2.5.6.9 PWRTPermissionLevelDialog (RT Professional).................................................................671
2.5.6.10 PWRTPermissionLevelDialogEx (RT Professional).............................................................672
2.5.6.11 PWRTPermissionToString (RT Professional)......................................................................673
2.5.7 Funciones para iniciar y cerrar sesión (RT Professional)....................................................674
2.5.7.1 PWRTGetCurrentUser (RT Professional)............................................................................674

Índice
2.5.7.2 PWRTGetLoginPriority (RT Professional)............................................................................675

2.5.7.3 PWRTIsLoggedInByCard (RT Professional)........................................................................676
2.5.7.4 PWRTLogin (RT Professional).............................................................................................677
2.5.7.5 PWRTLogout (RT Professional)...........................................................................................679
2.5.7.6 PWRTLogoutEx (RT Professional)......................................................................................680
2.5.7.7 PWRTSilentLogin (RT Professional)....................................................................................681
2.5.7.8 PWRTSilentLoginEx (RT Professional)................................................................................682
2.5.8.1 PWRT check permission (RT Professional).........................................................................684
2.5.8.2 Checks admission of a certain level for a picture (RT Professional)....................................685
2.5.8.3 Gets a string associated with the permission number (RT Professional).............................686
2.5.8.4 Permission level query through a dialog with specifying a possible error (RT
Professional)........................................................................................................................687
2.5.8.5 Return the name of the current user (RT Professional).......................................................688
2.5.8.6 Queries the current login priority (RT Professional).............................................................689
2.5.8.7 Checks for the user has been logged on by card (RT Professional)....................................689
2.5.8.8 PWRT login - dialog provided by WinCC itself (RT Professional)........................................690
2.5.8.9 PWRT logout (RT Professional)...........................................................................................691
2.5.8.10 Silent logout with priority level (RT Professional).................................................................692
2.5.8.11 Login without using a dialog (RT Professional)....................................................................693
2.5.8.12 Silent login with priority level (RT Professional)...................................................................694
2.6 Funciones del sistema de texto (RT Professional)...............................................................695
2.6.1.3 Códigos de idioma (RT Professional)..................................................................................697
2.6.2.1 TXTCloseProject (RT Professional).....................................................................................698
2.6.2.2 TXTGetMaxTextID (RT Professional)..................................................................................700
2.6.2.3 TXTOpenProject (RT Professional).....................................................................................701
2.6.2.4 TXTRTConnect (RT Professional)......................................................................................703
2.6.2.5 TXTRTDisconnect (RT Professional)...................................................................................704
2.6.3 Funciones para la edición de textos de ayuda (RT Professional)........................................705
2.6.3.1 TXTEnumInfoText (RT Professional)...................................................................................705
2.6.3.2 TXT_ENUM_INFOTEXTS_PROC (RT Professional)...........................................................707
2.6.3.3 TXTUpdateRuntime (RT Professional)................................................................................708
2.6.3.4 TXTRTGetInfoText (RT Professional)..................................................................................710
2.6.3.5 TXTRTGetInfoTextMC (RT Professional)............................................................................711
2.6.4 Funciones para la edición de idiomas (RT Professional).....................................................713
2.6.4.1 TXTEnumLanguages (RT Professional)..............................................................................713
2.6.4.2 TXT_ENUM_LANGUAGES_PROC (RT Professional).........................................................715
2.6.4.3 TXTGetFont (RT Professional)............................................................................................716
2.6.4.4 TXTShowLanguagesDialog (RT Professional)....................................................................718
2.6.4.5 TXTRTGetLanguageID (RT Professional)...........................................................................719
2.6.4.6 TXTRTSetLanguage (RT Professional)...............................................................................721
2.6.5.1 Obtener texto de ayuda (RT Professional)...........................................................................722
2.6.5.2 Enumerar textos de ayuda (RT Professional)......................................................................724
2.7 Funciones del sistema de informes (RT Professional).........................................................726

Índice

2.7.1.4 Lista de las propiedades de objeto (RT Professional).........................................................730
2.7.1.5 Procedimiento general para editar propiedades de trabajos de impresión (Report
Designer) (RT Professional).................................................................................................735
2.7.2 Funciones para establecer una conexión (RT Professional)...............................................739
2.7.2.1 RPJAttach (RT Professional)...............................................................................................739
2.7.2.2 RPJDetach (RT Professional)..............................................................................................740
2.7.2.3 RPJMemFree (RT Professional)..........................................................................................741
2.7.3 Funciones para editar propiedades del proyecto (RT Professional)....................................742
2.7.3.1 RPJGetNumProjectProperties (RT Professional)................................................................742
2.7.3.2 RPJGetProjectPropertyAt (RT Professional).......................................................................743
2.7.3.3 RPJGetProjectProperty (RT Professional)...........................................................................744
2.7.3.4 RPJProjectLock (RT Professional).......................................................................................745
2.7.3.5 RPJProjectUnlock (RT Professional)...................................................................................747
2.7.3.6 RPJProjectUnlockAll (RT Professional)...............................................................................748
2.7.4 Funciones para editar trabajos de impresión (RT Professional)..........................................749
2.7.4.1 RPJCreateJob (RT Professional).........................................................................................749
2.7.4.2 RPJDeleteJob (RT Professional).........................................................................................751
2.7.4.3 RPJCreatePropertyHandle (RT Professional)......................................................................752
2.7.4.4 RPJDeletePropertyHandle (RT Professional)......................................................................753
2.7.4.5 RPJGetJobNameAt (RT Professional).................................................................................755
2.7.4.6 RPJGetNumJobs (RT Professional)....................................................................................756
2.7.4.7 RPJJobLock (RT Professional)............................................................................................757
2.7.4.8 RPJJobUnlock (RT Professional).........................................................................................759
2.7.4.9 RPJJobUnlockAll (RT Professional).....................................................................................760
2.7.5 Funciones para editar métodos de trabajos de impresión (RT Professional)......................762
2.7.5.1 RPJCallJobMethod (RT Professional).................................................................................762
2.7.5.2 RPJGetJobMethodAt (RT Professional)..............................................................................763
2.7.5.3 RPJGetNumJobMethods (RT Professional)........................................................................764
2.7.6 Funciones para editar propiedades de trabajo de impresión (RT Professional)..................765
2.7.6.1 RPJGetJobPropertyAt (RT Professional).............................................................................765
2.7.6.2 RPJGetJobProps (RT Professional)....................................................................................767
2.7.6.3 RPJGetNumJobProperties (RT Professional)......................................................................768
2.7.6.4 RPJGetProperty (RT Professional)......................................................................................769
2.7.6.5 RPJPropertyClear (RT Professional)...................................................................................772
2.7.6.6 RPJSetProperty (RT Professional)......................................................................................774
2.7.7.1 Obtener nombre de método del trabajo de impresión (RT Professional).............................777
2.7.7.2 Obtener nombres de trabajo de impresión (RT Professional)..............................................780
2.7.7.3 Obtener propiedades del trabajo de impresión (RT Professional).......................................783
2.7.7.4 Modify print job properties (RT Professional).......................................................................786
2.7.7.5 Show print job preview (RT Professional)............................................................................791
2.8 Funciones para variables y ficheros (RT Professional)........................................................794
2.8.2.1 TLG_ARCHIV_STR (RT Professional).................................................................................808
2.8.2.2 TLG_ARCHIVDATARAW (RT Professional)........................................................................811

Índice
2.8.2.3 TLG_BACKUP_TABLE_INFO (RT Professional).................................................................814

2.8.2.4 TLG_CURVESCALEX (RT Professional).............................................................................816
2.8.2.5 TLG_CURVESCALEY (RT Professional).............................................................................821
2.8.2.6 TLG_GETARCHIVDATA (RT Professional).........................................................................825
2.8.2.7 TLG_IO_BACKUP_SELECT (RT Professional)...................................................................826
2.8.2.8 TLG_PROT_CURVE_INFOS (RT Professional)..................................................................827
2.8.2.9 TLG_SCAL_STR (RT Professional).....................................................................................829
2.8.2.10 TLG_TABLE_INFO (RT Professional)..................................................................................830
2.8.2.11 TLG_TABLESCALE (RT Professional)................................................................................831
2.8.2.12 TLG_TEMPLATEITEM_INFO (RT Professional).................................................................834
2.8.2.13 TLG_TIME_STR (RT Professional)......................................................................................836
2.8.2.14 TLG_TIMEDATA (RT Professional).....................................................................................837
2.8.2.15 TLG_TPLITEM_CURVE (RT Professional)..........................................................................838
2.8.2.16 TLG_TPLITEM_INFO (RT Professional)..............................................................................839
2.8.2.17 TLG_TPLITEM_TABLE (RT Professional)...........................................................................840
2.8.2.18 TLG_VAR_STR (RT Professional).......................................................................................841
2.8.2.19 TLG_VARIABLE_INFO (RT Professional)...........................................................................847
2.8.3.1 TLGCSConnect (RT Professional).......................................................................................848
2.8.3.2 TLGCSConnectEx (RT Professional)...................................................................................849
2.8.3.3 TLGCSDisConnect (RT Professional)..................................................................................850
2.8.3.4 TLGChangeLanguage (RT Professional).............................................................................852
2.8.3.5 TLGConnect (RT Professional)............................................................................................853
2.8.3.6 TLGDisconnect (RT Professional).......................................................................................854
2.8.4 Funciones de administración del proyecto (RT Professional)..............................................856
2.8.4.1 TLGCloseProject (RT Professional).....................................................................................856
2.8.4.2 TLGOpenProject (RT Professional).....................................................................................857
2.8.4.3 TLGEnumProject (RT Professional).....................................................................................859
2.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK (RT Professional).........................................860
2.8.5 Funciones para editar variables (RT Professional)..............................................................861
2.8.5.1 TLGEnumVariables (RT Professional).................................................................................861
2.8.5.2 TLG_ENUM_VARIABLE_NAME_CALLBACK (RT Professional).........................................863
2.8.5.3 TLGEnumVariablesEx (RT Professional).............................................................................864
2.8.5.4 TLG_ENUMVARIABLES (RT Professional).........................................................................866
2.8.5.5 TLGReadVariable (RT Professional)...................................................................................867
2.8.6 Funciones para editar ficheros (RT Professional)................................................................869
2.8.6.1 TLGEnumArchives (RT Professional)..................................................................................869
2.8.6.2 TLG_ENUM_ARCHIV_CALLBACK (RT Professional).........................................................870
2.8.6.3 TLGEnumArchivs (RT Professional)....................................................................................871
2.8.6.4 TLGEnumArchivsEx (RT Professional)................................................................................873
2.8.6.5 TLGEnumArchivsSel (RT Professional)...............................................................................875
2.8.6.6 TLG_ENUMTABLES (RT Professional)...............................................................................877
2.8.6.7 TLGFreeMemory (RT Professional).....................................................................................879
2.8.6.8 TLGGetArchivData (RT Professional)..................................................................................880
2.8.6.9 TLG_GETARCHIVDATA_CALLBACK (RT Professional)....................................................882
2.8.6.10 TLGGetArchivDataEx (RT Professional)..............................................................................883
2.8.6.11 TLGGetClosestTime (RT Professional)...............................................................................886
2.8.6.12 TLGGetClosestTimeEx (RT Professional)...........................................................................888
2.8.6.13 TLGInsertArchivData (RT Professional)...............................................................................890
2.8.6.14 TLGLockArchiv (RT Professional)........................................................................................892
2.8.6.15 TLGLockVariable (RT Professional)....................................................................................893
2.8.6.16 TLGReadArchiv (RT Professional).......................................................................................895

Índice
2.8.7 Funciones para representación de curvas y tablas (RT Professional).................................896

2.8.7.1 TLGCloseWindow (RT Professional)...................................................................................896
2.8.7.2 TLGDrawCurvesInDC (RT Professional).............................................................................897
2.8.7.3 TLGInsertTemplateItem (RT Professional)..........................................................................899
2.8.7.4 TLGPressToolbarButton (RT Professional).........................................................................900
2.8.7.5 TLGSetRulerWindowVisible (RT Professional)....................................................................902
2.8.7.6 TLGShowWindow (RT Professional)...................................................................................903
2.8.8 Funciones para procesar sistemas de tiempo (RT Professional)........................................905
2.8.8.1 TLGEnumTime (RT Professional)........................................................................................905
2.8.8.2 TLG_ENUM_TIME_NAME_CALLBACK (RT Professional)..................................................906
2.8.8.3 TLGEnumTimes (RT Professional)......................................................................................907
2.8.8.4 TLG_ENUMTIMES_CALLBACK (RT Professional).............................................................909
2.8.8.5 TLGReadTime (RT Professional).........................................................................................910
2.8.9 Funciones para proteger y restaurar (RT Professional).......................................................912
2.8.9.1 TLGEnumBackupEntries (RT Professional).........................................................................912
2.8.9.2 TLG_ENUMBACKUP_ENTRIES (RT Professional).............................................................913
2.8.9.3 TLGExport (RT Professional)...............................................................................................915
2.8.9.4 TLGGetBackupSize (RT Professional)................................................................................916
2.8.10.1 Edit curve template - Example 1 (RT Professional).............................................................919
2.8.10.2 Enum all acquisition and archiving times (RT Professional)................................................922
2.8.10.3 Enum archives (RT Professional)........................................................................................925
2.8.10.4 Enum variables of an archive (RT Professional)..................................................................928
2.8.10.5 Enumerate archives (RT Professional)................................................................................930
2.8.10.6 Read archive (RT Professional)...........................................................................................932
2.8.10.7 Read parameters of time object (RT Professional)..............................................................936
2.9 Funciones para recetas (RT Professional)...........................................................................938
2.9.1.2 Estructura de las recetas (RT Professional)........................................................................940
2.9.1.3 Dependencias de la secuencia de llamada de las funciones API (RT Professional)...........942
2.9.2.1 uaGetLastError (RT Professional)........................................................................................946
2.9.2.2 uaIsActive (RT Professional)................................................................................................948
2.9.2.3 uaUsers (RT Professional)...................................................................................................949
2.9.2.4 uaSetLocalEvents (RT Professional)...................................................................................950
2.9.3 Funciones para establecimiento de conexión (RT Professional).........................................951
2.9.3.1 uaConnect (RT Professional)...............................................................................................951
2.9.3.2 uaDisconnect (RT Professional)..........................................................................................952
2.9.3.3 uaQueryArchive (RT Professional)......................................................................................953
2.9.3.4 uaQueryArchiveByName (RT Professional).........................................................................955
2.9.3.5 uaQueryConfiguration (RT Professional).............................................................................957
2.9.3.6 uaReleaseArchive (RT Professional)...................................................................................958
2.9.3.7 uaReleaseConfiguration (RT Professional)..........................................................................960
2.9.4 Funciones para la edición de recetas (RT Professional).....................................................961
2.9.4.1 uaArchiveClose (RT Professional).......................................................................................961
2.9.4.2 uaArchiveDelete (RT Professional)......................................................................................962
2.9.4.3 uaArchiveExport (RT Professional)......................................................................................963
2.9.4.4 uaArchiveGetID (RT Professional).......................................................................................965
2.9.4.5 uaArchiveGetName (RT Professional).................................................................................966

Índice
2.9.4.6 uaArchiveGetSort (RT Professional)....................................................................................967

2.9.4.7 uaArchiveImport (RT Professional)......................................................................................968
2.9.4.8 uaArchiveOpen (RT Professional).......................................................................................969
2.9.4.9 uaArchiveUpdate (RT Professional).....................................................................................971
2.9.4.10 uaGetArchive (RT Professional)..........................................................................................972
2.9.4.11 uaGetNumArchives (RT Professional).................................................................................973
2.9.4.12 uaOpenArchives (RT Professional)......................................................................................974
2.9.5 Funciones para la edición de elementos de receta (RT Professional).................................975
2.9.5.1 uaArchiveGetCount (RT Professional).................................................................................975
2.9.5.2 uaArchiveGetFilter (RT Professional)..................................................................................976
2.9.5.3 uaArchiveInsert (RT Professional).......................................................................................977
2.9.5.4 uaArchiveMoveFirst (RT Professional)................................................................................978
2.9.5.5 uaArchiveMoveLast (RT Professional).................................................................................979
2.9.5.6 uaArchiveMoveNext (RT Professional)................................................................................980
2.9.5.7 uaArchiveMovePrevious (RT Professional).........................................................................981
2.9.5.8 uaGetNumFields (RT Professional).....................................................................................982
2.9.6 Funciones para la edición de campos (RT Professional).....................................................983
2.9.6.1 uaArchiveGetFieldLength (RT Professional)........................................................................983
2.9.6.2 uaArchiveGetFieldName (RT Professional).........................................................................984
2.9.6.3 uaArchiveGetFields (RT Professional).................................................................................985
2.9.6.4 uaArchiveGetFieldType (RT Professional)...........................................................................986
2.9.6.5 uaArchiveGetFieldValueDate (RT Professional)..................................................................987
2.9.6.6 uaArchiveGetFieldValueDouble (RT Professional)..............................................................988
2.9.6.7 uaArchiveGetFieldValueLong (RT Professional).................................................................990
2.9.6.8 uaArchiveGetFieldValueString (RT Professional)................................................................991
2.9.6.9 uaArchiveSetFieldValueDate (RT Professional)..................................................................992
2.9.6.10 uaArchiveSetFieldValueDouble (RT Professional)..............................................................993
2.9.6.11 uaArchiveSetFieldValueLong (RT Professional)..................................................................994
2.9.6.12 uaArchiveSetFieldValueString (RT Professional)................................................................996
2.9.6.13 uaGetField (RT Professional)...............................................................................................997
2.9.7 Funciones para la filtración y clasificación (RT Professional)..............................................998
2.9.7.1 uaArchiveRequery (RT Professional)...................................................................................998
2.9.7.2 uaArchiveSetFilter (RT Professional)...................................................................................999
2.9.7.3 uaArchiveSetSort (RT Professional)..................................................................................1001
2.9.8 Funciones para la edición de vistas de receta (RT Professional)......................................1002
2.9.8.1 uaOpenViews (RT Professional)........................................................................................1002
2.9.9 Funciones para la edición de variables (RT Professional).................................................1003
2.9.9.1 uaArchiveReadTagValues (RT Professional)....................................................................1003
2.9.9.2 uaArchiveReadTagValuesByName (RT Professional).......................................................1004
2.9.9.3 uaArchiveWriteTagValues (RT Professional).....................................................................1005
2.9.9.4 uaArchiveWriteTagValuesByName (RT Professional).......................................................1007
2.10 Funciones para avisos (RT Professional)..........................................................................1008
2.10.1 Principios básicos (RT Professional).................................................................................1008
2.10.1.1 Sinopsis de las funciones (RT Professional)......................................................................1008
2.10.1.2 Sinopsis de las estructuras (RT Professional)...................................................................1009
2.10.1.3 Mensajes de error (RT Professional).................................................................................1010
2.10.1.4 Constantes (RT Professional)............................................................................................1012
2.10.2 Estructuras (RT Professional)............................................................................................1024
2.10.2.1 MSG_RTCREATE_STRUCT_PLUS (RT Professional).....................................................1024
2.10.2.2 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (RT Professional)....................1026
2.10.2.3 MSG_FILTER_STRUCT_PLUS (RT Professional)............................................................1029
2.10.2.4 MSG_RTDATA_INSTANCE_STRUCT_PLUS (RT Professional)......................................1033

Índice
2.10.2.5 MSG_CLASS_STRUCT_PLUS (RT Professional).............................................................1036

2.10.2.6 MSG_CSDATA_STRUCT_PLUS (RT Professional)..........................................................1039
2.10.2.7 MSG_RTGROUPENUM_STRUCT_PLUS (RT Professional)............................................1041
2.10.2.8 MSG_RTGROUPSET_STRUCT_PLUS (RT Professional)................................................1042
2.10.2.9 MSG_COMMENT_INSTANCE_STRUCT_PLUS (RT Professional)..................................1043
2.10.2.10 MSG_INFOTEXT_STRUCT_PLUS (RT Professional).......................................................1045
2.10.2.11 MSG_BACKUP_STRUCT_PLUS (RT Professional)..........................................................1046
2.10.2.12 MSG_RTLOCK_STRUCT_PLUS (RT Professional)..........................................................1047
2.10.2.13 MSG_TEXTVAL256_STRUCT_PLUS (RT Professional)...................................................1048
2.10.3 Funciones generales (RT Professional).............................................................................1049
2.10.3.1 MSRTEnumArchivDataPlus (RT Professional)..................................................................1049
2.10.3.2 MSRTStartMsgServicePlus (RT Professional)...................................................................1051
2.10.3.3 MSRTStopMsgServicePlus (RT Professional)...................................................................1055
2.10.3.4 MSRTQuitHornPlus (RT Professional)...............................................................................1056
2.10.3.5 MSG_SERVICE_NOTIFY_PROCPlus (RT Professional)..................................................1057
2.10.3.6 MSRTWebClientPlus (RT Professional)............................................................................1061
2.10.4 Funciones para la edición de protocolos (RT Professional)..............................................1061
2.10.4.1 MSRTActivateMProtPlus (RT Professional).......................................................................1061
2.10.4.2 MSRTEnumProtDataPlus (RT Professional).....................................................................1062
2.10.4.3 MSRTPrintMProtPlus (RT Professional)............................................................................1064
2.10.5 Funciones para la edición de avisos (RT Professional).....................................................1065
2.10.5.1 MSRTEnumArchivInstancePlus (RT Professional)............................................................1065
2.10.5.2 MSRTCreateMsgInstanceWithCommentPlus (RT Professional).......................................1066
2.10.5.3 MSRTCreateMsgInstancePlus (RT Professional)..............................................................1068
2.10.5.4 MSRTDialogMsgLockPlus (RT Professional)....................................................................1070
2.10.5.5 MSRTCreateMsgPlus (RT Professional)...........................................................................1071
2.10.5.6 MSRTEnumLockedMsgPlus (RT Professional).................................................................1073
2.10.5.7 MSRTEnumMsgRTDataPlus (RT Professional)................................................................1074
2.10.5.8 MSRTGetClassInfoPlus (RT Professional)........................................................................1075
2.10.5.9 MSRTGetLastMsgWithCommentPlus (RT Professional)...................................................1077
2.10.5.10 MSRTGetMsgActualPlus (RT Professional)......................................................................1079
2.10.5.11 MSRTGetMsgCSDataPlus (RT Professional)....................................................................1080
2.10.5.12 MSRTGetMsgPriorityPlus (RT Professional).....................................................................1082
2.10.5.13 MSRTGetMsgQuitPlus (RT Professional)..........................................................................1083
2.10.5.14 MSRTGetMsgTextPlus (RT Professional).........................................................................1085
2.10.5.15 MSRTGetSelectedMsgPlus (RT Professional)..................................................................1086
2.10.5.16 MSRTResetMsgPlus (RT Professional).............................................................................1088
2.10.5.17 MSRTLoopInAlarmPlus (RT Professional).........................................................................1090
2.10.6 Funciones para la edición de grupos de aviso (RT Professional)......................................1091
2.10.6.1 MSRTEnumGroupMsgPlus (RT Professional)...................................................................1091
2.10.6.2 MSRTLockGroupPlus (RT Professional)...........................................................................1093
2.10.6.3 MSRTQuitGroupPlus (RT Professional)............................................................................1094
2.10.7 Funciones para la edición de filtros de aviso (RT Professional)........................................1096
2.10.7.1 MSRTGetFilterDataPlus (RT Professional)........................................................................1096
2.10.7.2 MSRTCheckWinFilterPlus (RT Professional).....................................................................1097
2.10.7.3 MSRTSetMsgFilterPlus (RT Professional).........................................................................1099
2.10.7.4 MSRTSetMsgWinFilterPlus (RT Professional)...................................................................1100
2.10.8 Funciones para editar el visor de avisos (RT Professional)...............................................1102
2.10.8.1 MSRTMsgWinCommandPlus (RT Professional)...............................................................1102
2.10.9 Funciones para editar comentarios (RT Professional).......................................................1104
2.10.9.1 MSRTGetCommentInstancePlus (RT Professional)..........................................................1104
2.10.9.2 MSRTSetCommentInstancePlus (RT Professional)..........................................................1105

Índice
2.10.10 Funciones para la edición de textos de información (RT Professional).............................1107

2.10.10.1 MSRTGetInfotextPlus (RT Professional)...........................................................................1107
2.10.10.2 MSRTSetInfotextPlus (RT Professional)............................................................................1108
2.10.11 Funciones de archivo (RT Professional)............................................................................1110
2.10.11.1 MSRTEnumBackupListPlus (RT Professional)..................................................................1110
2.10.11.2 MSRTExportPlus (RT Professional)...................................................................................1111
2.11 Funciones para visualizar códigos PLC (RT Professional)................................................1113
2.11.1 Visualización en STEP 7 (RT Professional).......................................................................1113
2.11.1.1 Principios básicos (RT Professional).................................................................................1113
2.11.1.2 OpenTIAPortalProject (RT Professional)...........................................................................1114
2.11.1.3 OpenTIAPortalIECPLByCall (RT Professional)..................................................................1116
2.11.1.4 OpenTIAPortalIECPLByAssignment (RT Professional).....................................................1118
2.11.1.5 OpenTIAPortalS7GraphByBlock (RT Professional)...........................................................1120
2.11.1.6 Ejemplo: Integración en una función WinCC (RT Professional)........................................1123
2.11.2 Visualización en el visor de código PLC (RT Professional)...............................................1124
2.11.2.1 Principios básicos (RT Professional).................................................................................1124
2.11.2.2 OpenViewerS7GraphByBlock (RT Professional)...............................................................1125
2.11.2.3 OpenViewerIECPLByCall (RT Professional)......................................................................1127
2.11.2.4 OpenViewerIECPLByFCCall (RT Professional).................................................................1131
2.11.2.5 OpenViewerIECPLByAssignment (RT Professional).........................................................1134
2.11.3 Tratamiento de errores (RT Professional)..........................................................................1136
2.12 Tratamiento de errores (RT Professional)..........................................................................1138
2.12.1 CMN_ERROR (RT Professional).......................................................................................1138
2.12.2 CCStorageError.h (RT Professional).................................................................................1139
3 VB-Scripting (Panels, Comfort Panels, RT Advanced, RT Professional)...............................................1151
3.1 Funciones de sistema (Panels, Comfort Panels, RT Advanced).......................................1151
3.1.1 AcknowledgeAlarm (Panels, Comfort Panels, RT Advanced)...........................................1151
3.1.2 ActivatePreviousScreen (Panels, Comfort Panels, RT Advanced)....................................1151
3.1.3 ActivateScreen (Panels, Comfort Panels, RT Advanced)..................................................1152
3.1.4 ActivateScreenByNumber (Panels, Comfort Panels, RT Advanced).................................1153
3.1.5 ActivateSystemDiagnosticsView (Panels, Comfort Panels, RT Advanced).......................1154
3.1.6 ArchiveLogFile (Panels, Comfort Panels, RT Advanced)..................................................1155
3.1.7 BackupRAMFileSystem (Panels, Comfort Panels, RT Advanced)....................................1157
3.1.8 CalibrateTouchScreen (Panels, Comfort Panels, RT Advanced)......................................1157
3.1.9 ChangeConnection (Panels, Comfort Panels, RT Advanced)...........................................1158
3.1.10 ClearAlarmBuffer (Panels, Comfort Panels, RT Advanced)...............................................1160
3.1.11 ClearAlarmBufferProtool (Panels, Comfort Panels, RT Advanced)...................................1160
3.1.12 ClearDataRecord (Panels, Comfort Panels, RT Advanced)..............................................1161
3.1.13 ClearDataRecordMemory (Panels, Comfort Panels, RT Advanced).................................1162
3.1.14 ClearLog (Panels, Comfort Panels, RT Advanced)............................................................1163
3.1.15 CloseAllLogs (Panels, Comfort Panels, RT Advanced).....................................................1164
3.1.16 ControlSmartServer (Panels, Comfort Panels, RT Advanced)..........................................1165
3.1.17 ControlWebServer (Panels, Comfort Panels, RT Advanced).............................................1166
3.1.18 CopyLog (Panels, Comfort Panels, RT Advanced)............................................................1166
3.1.19 DecreaseTag (Panels, Comfort Panels, RT Advanced).....................................................1167
3.1.20 EditAlarm (Panels, Comfort Panels, RT Advanced)...........................................................1168
3.1.21 Encode (Panels, Comfort Panels, RT Advanced)..............................................................1169
3.1.22 EncodeEx (Panels, Comfort Panels, RT Advanced)..........................................................1170
3.1.23 EstablishPROFIsafe (Panels, Comfort Panels, RT Advanced)..........................................1171
3.1.24 ExportDataRecords (Panels, Comfort Panels, RT Advanced)...........................................1171

Índice
3.1.25 ExportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)...................1174

3.1.26 ExportImportUserAdministration (Panels, Comfort Panels, RT Advanced).......................1176
3.1.27 GetBrightness (Panels, Comfort Panels, RT Advanced)...................................................1177
3.1.28 GetDataRecordFromPLC (Panels, Comfort Panels, RT Advanced)..................................1178
3.1.29 GetDataRecordName (Panels, Comfort Panels, RT Advanced)........................................1179
3.1.30 GetDataRecordTagsFromPLC (Panels, Comfort Panels, RT Advanced)..........................1181
3.1.31 GetGroupNumber (Panels, Comfort Panels, RT Advanced)..............................................1182
3.1.32 GetPassword (Panels, Comfort Panels, RT Advanced).....................................................1182
3.1.33 GetUserName (Panels, Comfort Panels, RT Advanced)...................................................1183
3.1.34 GoToEnd (Panels, Comfort Panels, RT Advanced)...........................................................1183
3.1.35 GoToHome (Panels, Comfort Panels, RT Advanced)........................................................1184
3.1.36 ImportDataRecords (Panels, Comfort Panels, RT Advanced)...........................................1184
3.1.37 ImportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)...................1186
3.1.38 IncreaseTag (Panels, Comfort Panels, RT Advanced)......................................................1188
3.1.39 InverseLinearScaling (Panels, Comfort Panels, RT Advanced).........................................1188
3.1.40 InvertBit (Panels, Comfort Panels, RT Advanced).............................................................1190
3.1.41 InvertBitInTag (Panels, Comfort Panels, RT Advanced)....................................................1191
3.1.42 LinearScaling (Panels, Comfort Panels, RT Advanced)....................................................1192
3.1.43 LoadDataRecord (Panels, Comfort Panels, RT Advanced)...............................................1193
3.1.44 Logoff (Panels, Comfort Panels, RT Advanced)................................................................1194
3.1.45 Logon (Panels, Comfort Panels, RT Advanced)................................................................1195
3.1.46 LookupText (Panels, Comfort Panels, RT Advanced).......................................................1195
3.1.47 NotifyUserAction (Panels, Comfort Panels, RT Advanced)...............................................1196
3.1.48 OpenAllLogs (Panels, Comfort Panels, RT Advanced)......................................................1198
3.1.49 OpenCommandPrompt (Panels, Comfort Panels, RT Advanced).....................................1199
3.1.50 OpenControlPanel (Panels, Comfort Panels, RT Advanced).............................................1199
3.1.51 OpenInternetExplorer (Panels, Comfort Panels, RT Advanced)........................................1200
3.1.52 OpenScreenKeyboard (Panels, Comfort Panels, RT Advanced).......................................1201
3.1.53 OpenTaskManager (Panels, Comfort Panels, RT Advanced)...........................................1201
3.1.54 PageDown (Panels, Comfort Panels, RT Advanced).........................................................1202
3.1.55 PageUp (Panels, Comfort Panels, RT Advanced).............................................................1202
3.1.56 PrintReport (Panels, Comfort Panels, RT Advanced)........................................................1203
3.1.57 PrintScreen (Panels, Comfort Panels, RT Advanced).......................................................1204
3.1.58 ResetBit (Panels, Comfort Panels, RT Advanced).............................................................1205
3.1.59 ResetBitInTag (Panels, Comfort Panels, RT Advanced)...................................................1205
3.1.60 SafelyRemoveHardware (Panels, Comfort Panels)...........................................................1207
3.1.61 SaveDataRecord (Panels, Comfort Panels, RT Advanced)...............................................1207
3.1.62 SendEMail (Panels, Comfort Panels, RT Advanced).........................................................1208
3.1.63 SetAcousticSignal (Panels, Comfort Panels, RT Advanced).............................................1209
3.1.64 SetAlarmReportMode (Panels, Comfort Panels, RT Advanced)........................................1210
3.1.65 SetAndGetBrightness (Panels, Comfort Panels, RT Advanced)........................................1211
3.1.66 SetBit (Panels, Comfort Panels, RT Advanced).................................................................1211
3.1.67 SetBitInTag (Panels, Comfort Panels, RT Advanced).......................................................1212
3.1.68 SetBrightness (Panels, Comfort Panels, RT Advanced)....................................................1214
3.1.69 SetConnectionMode (Panels, Comfort Panels, RT Advanced)..........................................1215
3.1.70 SetDataRecordTagsToPLC (Panels, Comfort Panels, RT Advanced)..............................1216
3.1.71 SetDataRecordToPLC (Panels, Comfort Panels, RT Advanced)......................................1217
3.1.72 SetDaylightSavingTime (Panels, Comfort Panels, RT Advanced).....................................1218
3.1.73 SetDeviceMode (Panels, Comfort Panels, RT Advanced).................................................1219
3.1.74 SetDisplayMode (Panels, Comfort Panels, RT Advanced)................................................1220
3.1.75 SetLanguage (Panels, Comfort Panels, RT Advanced).....................................................1220
3.1.76 SetPLCDateTime (Panels, Comfort Panels, RT Advanced)..............................................1221

Índice
3.1.77 SetRecipeTags (Panels, Comfort Panels, RT Advanced)..................................................1222

3.1.78 SetScreenKeyboardMode (Panels, Comfort Panels, RT Advanced).................................1223
3.1.79 SetTag (Panels, Comfort Panels, RT Advanced)...............................................................1224
3.1.80 ShiftAndMask (Panels, Comfort Panels, RT Advanced)....................................................1225
3.1.81 ShowAlarmWindow (Panels, Comfort Panels, RT Advanced)...........................................1227
3.1.82 ShowOperatorNotes (Panels, Comfort Panels, RT Advanced)..........................................1228
3.1.83 ShowPopUpScreen (Panels, Comfort Panels, RT Advanced)...........................................1229
3.1.84 ShowSlideInScreen (Panels, Comfort Panels, RT Advanced)...........................................1230
3.1.85 ShowSoftwareVersion (Panels, Comfort Panels, RT Advanced).......................................1230
3.1.86 ShowSystemAlarm (Panels, Comfort Panels, RT Advanced)............................................1231
3.1.87 ShowSystemDiagnosticsWindow (Panels, Comfort Panels)..............................................1232
3.1.88 StartLogging (Panels, Comfort Panels, RT Advanced)......................................................1232
3.1.89 StartNextLog (Panels, Comfort Panels, RT Advanced).....................................................1233
3.1.90 StartProgram (Panels, Comfort Panels, RT Advanced).....................................................1234
3.1.91 StopLogging (Panels, Comfort Panels, RT Advanced)......................................................1235
3.1.92 StopRuntime (Panels, Comfort Panels, RT Advanced).....................................................1236
3.1.93 TerminatePROFIsafe (Panels, Comfort Panels, RT Advanced)........................................1237
3.1.94 WinACMPGetVersion (Panels, Comfort Panels)...............................................................1238
3.1.95 WinACMPSetStartAtBoot (Panels, Comfort Panels)..........................................................1238
3.1.96 WinACSetStartMode (Panels, Comfort Panels).................................................................1239
3.2 Funciones de sistema (RT Professional)...........................................................................1240
3.2.1 ActivateScreen (RT Professional)......................................................................................1240
3.2.2 ActivateScreenInScreenWindow (RT Professional)...........................................................1241
3.2.3 DecreaseTag (RT Professional).........................................................................................1242
3.2.4 ExportImportUserAdministration (RT Professional)...........................................................1243
3.2.5 IncreaseTag (RT Professional)..........................................................................................1244
3.2.6 InverseLinearScaling (RT Professional).............................................................................1245
3.2.7 InvertBit (RT Professional).................................................................................................1247
3.2.8 InvertBitInTag (RT Professional)........................................................................................1248
3.2.9 LinearScaling (RT Professional)........................................................................................1249
3.2.10 ResetBit (RT Professional).................................................................................................1250
3.2.11 ResetBitInTag (RT Professional).......................................................................................1251
3.2.12 SetBit (RT Professional)....................................................................................................1252
3.2.13 SetBitInTag (RT Professional)...........................................................................................1253
3.2.14 SetPropertyByConstant (RT Professional).........................................................................1255
3.2.15 SetPropertyByProperty (RT Professional).........................................................................1256
3.2.16 SetPropertyByTag (RT Professional).................................................................................1258
3.2.17 SetPropertyByTagIndirect (RT Professional).....................................................................1260
3.2.18 SetTag (RT Professional)...................................................................................................1261
3.2.19 SetTagByProperty (RT Professional).................................................................................1262
3.2.20 SetTagByTagIndirect (RT Professional)............................................................................1263
3.2.21 SetTagIndirect (RT Professional).......................................................................................1264
3.2.22 SetTagIndirectByProperty (RT Professional).....................................................................1265
3.2.23 SetTagIndirectByTagIndirect (RT Professional).................................................................1266
3.2.24 SetTagIndirectWithOperatorInputAlarm (RT Professional)................................................1267
3.2.25 SetTagWithOperatorEvent (RT Professional)....................................................................1268
3.2.26 ShowLogonDialog (RT Professional).................................................................................1269
3.2.27 StopRuntime (RT Professional).........................................................................................1269
3.3 VBScript para Windows (Panels, Comfort Panels, RT Advanced, RT Professional).........1270
3.3.1 VBScript para Windows (Panels, Comfort Panels, RT Advanced, RT Professional).........1270
3.4 VBScript para Windows CE (Panels, Comfort Panels)......................................................1271

Índice
3.4.1 VBScript para Windows CE (Panels, Comfort Panels)......................................................1271

3.4.1.1 Attr (Panels, Comfort Panels)............................................................................................1271
3.4.1.2 Close (Panels, Comfort Panels).........................................................................................1272
3.4.1.3 CreateObject (Panels, Comfort Panels).............................................................................1272
3.4.1.4 Dir (Panels, Comfort Panels).............................................................................................1273
3.4.1.5 EOF (Panels, Comfort Panels)...........................................................................................1274
3.4.1.6 FileCopy (Panels, Comfort Panels)....................................................................................1275
3.4.1.7 FileLen (Panels, Comfort Panels)......................................................................................1275
3.4.1.8 FileDateTime (Panels, Comfort Panels).............................................................................1276
3.4.1.9 Get (Panels, Comfort Panels)............................................................................................1277
3.4.1.10 GetAttr (Panels, Comfort Panels).......................................................................................1278
3.4.1.11 Input (Panels, Comfort Panels)..........................................................................................1279
3.4.1.12 InputFields (Panels, Comfort Panels)................................................................................1280
3.4.1.13 InputB (Panels, Comfort Panels)........................................................................................1281
3.4.1.14 Kill (Panels, Comfort Panels).............................................................................................1281
3.4.1.15 LineInputString (Panels, Comfort Panels)..........................................................................1282
3.4.1.16 LinePrint (Panels, Comfort Panels)....................................................................................1283
3.4.1.17 Loc (Panels, Comfort Panels)............................................................................................1283
3.4.1.18 LOF (Panels, Comfort Panels)...........................................................................................1284
3.4.1.19 MkDir (Panels, Comfort Panels).........................................................................................1284
3.4.1.20 MoveFile (Panels, Comfort Panels)...................................................................................1285
3.4.1.21 Open (Panels, Comfort Panels).........................................................................................1286
3.4.1.22 Put (Panels, Comfort Panels).............................................................................................1287
3.4.1.23 RmDir (Panels, Comfort Panels)........................................................................................1288
3.4.1.24 Seek (Panels, Comfort Panels)..........................................................................................1288
3.4.1.25 SetAttr (Panels, Comfort Panels).......................................................................................1289
3.4.1.26 WriteFields (Panels, Comfort Panels)................................................................................1290
3.5 Modelo de objetos VBS (Panels, Comfort Panels, RT Advanced, RT Professional).........1292
3.5.1 Modelo de objeto VBS (RT Professional)..........................................................................1292
3.5.2 Objetos (Panels, Comfort Panels, RT Advanced)..............................................................1294
3.5.2.1 HMIRuntime (Panels, Comfort Panels, RT Advanced)......................................................1294
3.5.2.2 Screens (lista) (Panels, Comfort Panels, RT Advanced)...................................................1295
3.5.2.3 Screen (Panels, Comfort Panels, RT Advanced)...............................................................1297
3.5.2.4 ScreenItem (Panels, Comfort Panels, RT Advanced)........................................................1298
3.5.2.5 ScreenItems (Panels, Comfort Panels, RT Advanced)......................................................1300
3.5.2.6 SmartTags (Panels, Comfort Panels, RT Advanced).........................................................1301
3.5.2.7 SmartTag (Panels, Comfort Panels, RT Advanced)..........................................................1302
3.5.3 Objetos (RT Professional)..................................................................................................1304
3.5.3.1 Alarm (RT Professional).....................................................................................................1304
3.5.3.2 Alarms (lista) (RT Professional).........................................................................................1305
3.5.3.3 AlarmLogs (lista) (RT Professional)...................................................................................1306
3.5.3.4 DataItem (RT Professional)................................................................................................1308
3.5.3.5 DataLogs (lista) (RT Professional).....................................................................................1309
3.5.3.6 DataSet (lista) (RT Professional).......................................................................................1311
3.5.3.7 HMIRuntime (RT Professional).........................................................................................1313
3.5.3.8 Item (RT Professional).......................................................................................................1314
3.5.3.9 Layer (RT Professional).....................................................................................................1315
3.5.3.10 Layers (lista) (RT Professional).........................................................................................1317
3.5.3.11 Logging (RT Professional).................................................................................................1318
3.5.3.12 Project (RT Professional)...................................................................................................1319
3.5.3.13 Screen (RT Professional)...................................................................................................1320
3.5.3.14 ScreenItem (RT Professional)............................................................................................1323

Índice
3.5.3.15 ScreenItems (lista) (RT Professional)................................................................................1325

3.5.3.16 Screens (lista) (RT Professional).......................................................................................1327
3.5.3.17 SmartTag (RT Professional)..............................................................................................1329
3.5.3.18 SmartTags (RT Professional).............................................................................................1331
3.5.3.19 Tag (RT Professional)........................................................................................................1332
3.5.3.20 Tags (lista) (RT Professional)............................................................................................1335
3.5.3.21 TagSet (lista) (RT Professional)........................................................................................1336
3.5.4 Tipos de objeto (Panels, Comfort Panels, RT Advanced, RT Professional)......................1338
3.5.4.1 Objetos A-I (Panels, Comfort Panels, RT Advanced, RT Professional).............................1338
3.5.4.2 Objetos K-Z (Panels, Comfort Panels, RT Advanced, RT Professional)...........................1422
3.5.5 Propiedades (Panels, Comfort Panels, RT Advanced, RT Professional)..........................1545
3.5.5.1 Propiedades A (Panels, Comfort Panels, RT Advanced, RT Professional).......................1545
3.5.5.2 Propiedades B (Panels, Comfort Panels, RT Advanced, RT Professional).......................1572
3.5.5.3 Propiedades C (Panels, Comfort Panels, RT Advanced, RT Professional).......................1608
3.5.5.4 Propiedades D (Panels, Comfort Panels, RT Advanced, RT Professional).......................1632
3.5.5.5 Propiedades E-F (Panels, Comfort Panels, RT Advanced, RT Professional)....................1641
3.5.5.6 Propiedades G-H (Panels, Comfort Panels, RT Advanced, RT Professional)...................1677
3.5.5.7 Propiedades I-J (Panels, Comfort Panels, RT Advanced, RT Professional).....................1697
3.5.5.8 Propiedades K-L (Panels, Comfort Panels, RT Advanced, RT Professional)....................1702
3.5.5.9 Propiedades M-N (Panels, Comfort Panels, RT Advanced, RT Professional)...................1727
3.5.5.10 Propiedades O-P (Panels, Comfort Panels, RT Advanced, RT Professional)...................1754
3.5.5.11 Propiedades Q-R (Panels, Comfort Panels, RT Advanced, RT Professional)...................1780
3.5.5.12 Propiedades S (Panels, Comfort Panels, RT Advanced, RT Professional).......................1792
3.5.5.13 Propiedades T (Panels, Comfort Panels, RT Advanced, RT Professional).......................1849
3.5.5.14 Propiedades U-W (Panels, Comfort Panels, RT Advanced, RT Professional)..................1950
3.5.5.15 Propiedades X-Z (Panels, Comfort Panels, RT Advanced, RT Professional)....................1989
3.5.6 Métodos (Panels, Comfort Panels, RT Advanced, RT Professional).................................2155
3.5.6.1 Métodos A-G (Panels, Comfort Panels, RT Advanced, RT Professional).........................2155
3.5.6.2 Métodos H-R (Panels, Comfort Panels, RT Advanced, RT Professional).........................2221
3.5.6.3 Métodos S-Z (Panels, Comfort Panels, RT Advanced, RT Professional)..........................2248
Índice alfabético......................................................................................................................................2277

C-Scripting (RT Professional) 1
1.1 Funciones de sistema (RT Professional)
1.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)
El valor de retorno guardado puede procesarse en el código subsiguiente.
{
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
...
}
...
}
1.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
{
...
}
...
}
1.1.3 ActivateScreen (RT Professional)
Descripción
Efectúa un cambio de imagen para visualizar la imagen indicada.
Para conmutar entre la imagen raíz y la ventana permanente, y viceversa, utilice la función
de sistema "ActivarImagenConNúmero".
Utilización en la lista de funciones

ActivarImagen (Nombre de imagen, Número del objeto)
Utilización en funciones definidas por el usuario

ActivateScreen (Screen_name, Object_number)
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
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.
Si indica "0":
● Si al ejecutarse la función de sistema está resaltada la ventana permanente, ésta
permanecerá destacada.
● 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
al pulsar cualquier tecla.
// User defined code

// i.e. when pressing a button
ActivateScreen ("Screen_2", 0);
...
}
1.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)
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 de programa activa la imagen "Screen_2" con la función
ActivateScreenInScreenWindow al pulsar cualquier tecla.
{
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
1.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
{
...
}
...
}
1.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 127)
1.1.7 DecreaseTag (RT Professional)
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 puede asignar un valor con la función de sistema "DefinirVariable".
Si se 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".

ReducirVariable (Variable, Valor)

DecreaseTag (Tag, Value)
Parámetros
Variable
Variable de la que se debe restar el valor indicado.
Valor
Valor que se va a restar.

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);
...
}
1.1.8 GetLocalScreen (RT Professional)
Descripción
Proporciona un puntero hacia el nombre de la imagen.
Sintaxis
char* GetLocalScreen(char* Screen name);
Parámetros
Screen name
Puntero hacia el nombre de la imagen.

Valor de retorno
Nota
El parámetro de llamada transferido "Screen name" debe tener la misma estructura que le da
el sistema gráfico para las rutas de imagen:
<nombre de imagen>.<nombre de ventana de imagen>:<nombre de imagen>.<nombre de
ventana de imagen>:<nombre 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(Screen name) 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);
}
...
}
1.1.9 GetLinkedTag (RT Professional)
Descripción
Devuelve el nombre de la variable que está enlazada con la propiedad de objeto indicada.
Sintaxis
char* GetLinkedTag(char* Screen Name, char* Object, char* Name of Property);
Parámetros
Screen Name
Object
Puntero hacia el nombre del objeto.
Name of Property
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.
Ejemplo
El siguiente código de programa lee una conexión de variable y llena la estructura transferida
linkinfo con la información de la conexión de variable.
{
LINKINFO linkinfo;
//Get the linked Tag

GetLinkedTag(lpszScreenName,"Bar1","Process",&linkinfo);
// linkinfo.szLinkName is the tag name

// linkinfo.dwCycle is the update cycle
// linkinfo.LinkType is the type of the connection
//User defined code where the

//user can do something with the returnvalue
...
}
1.1.10 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);
...
}
1.1.11 GetParentScreen (RT Professional)
Descripción
Proporciona un puntero hacia el nombre de la imagen.
Sintaxis
char* GetParentScreen(char* Screen name);
Parámetros
Screen name
Valor de retorno
Nombre de la imagen actual cuando se llama la función de sistema en una imagen.

Ruta del nombre de la imagen superior cuando se llama la función de sistema en una ventana
de imagen.
Nota
El parámetro de llamada transferido Screen name debe tener la misma estructura que le da
Los caracteres ":" y "." se utilizan exclusivamente para la sintaxis. Por tanto, para los nombres
se deben utilizar exclusivamente los separadores "-" y "_".
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);
}
...
}
1.1.12 GetParentScreenWindow (RT Professional)
Descripción
Proporciona un puntero hacia el nombre de la ventana de imagen.
Sintaxis
char* GetParentScreenWindow(char* Screen name);

Parámetros
Screen name
Valor de retorno
Puntero hacia el nombre de la ventana de imagen cuando la función de sistema se llama en
una imagen que se muestra en una ventana de una imagen de nivel superior.
El parámetro de llamada invariable "Screen name" cuando se llama la función de sistema en
una imagen.
Nota
El parámetro de llamada transferido "Screen name" debe tener la misma estructura que le da
Los caracteres ":" y "." se utilizan exclusivamente para la sintaxis. Por tanto, para los nombres
se deben utilizar exclusivamente los separadores "-" y "_".
Principio
En una imagen "Imagen_1" hay una ventana de imagen "Ventana de imagen_1". 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_1" se representa la "Imagen_2".
En la "Imagen_2" hay una ventana de imagen "Ventana de imagen_2".
2. En la "Ventana de imagen_2" se representa la "Imagen_3".
Puntero hacia el nombre de la ventana de imagen

Ofrece en el siguiente paso la función de sistema GetParentScreenWindow(Screen
name) con los siguientes valores:
● "Imagen_2" cuando se llama la función de sistema en la "Imagen_3"
● "Ventana de imagen_1" cuando se llama la función de sistema en la "Imagen_2"
● "Imagen_1" cuando se llama la función de sistema en la "Imagen_1"

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);
}
...
}
1.1.13 GetProp (RT Professional)
1.1.13.1 GetPropBOOL (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "BOOL".
Sintaxis
BOOL GetPropBOOL(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
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.

Name of the Property

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.
1.1.13.2 GetPropChar (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "Char".

Sintaxis
Char* GetPropChar(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Object

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

1.1.13.3 GetPropDouble (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "Double".
Sintaxis
double GetPropDouble(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Object

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);}
}
...
}
1.1.13.4 GetPropLong (RT Professional)
Descripción
Devuelve el valor de una propiedad del tipo de datos "long".
Sintaxis
long GetPropLong(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Object

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);
}
...
}
1.1.14 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 (char** ppszServerPrefix, char** ppszTagPrefix, char**
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;
}
}

1.1.15 GetTag (RT Professional)
1.1.15.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 Tag_Name);
Parámetros
Tag_Name
Nombre de la variable

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: ha ocurrido 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);
...
}
1.1.15.2 Función GetTagDateTime (RT Professional)
Función
Determina el valor de una variable del tipo de datos "Fecha/hora".
Sintaxis
SYSTEMTIME GetTagDateTime(Tag Tag_Name);

Parámetro
Tag_Name
Valor de retorno
Valor de la variable en el tipo de datos "Fecha/hora".
1.1.15.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 (DWORD* pdwState, DWORD* pdwQualityCode, const
char* 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);

...
}

1.1.15.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(DWORD* pdwState, const char* 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);

...
}
1.1.15.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(const char* 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);
1.1.15.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 Tag_Name, PDWORD 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
Constantes (Página 202)

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


HMI
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 Tag_Name, PDWORD lp_dwstate, PDWORD
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,&dwQC: %d\r\n", &dwState);
printf ("Value at &dwQC: %d\r\n", &dwQC);
...
}
else
{
// failed
printf ( "Error - function failed." );
}
}
1.1.15.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 Tag_Name, PDWORD lp_dwstate, PDWORD
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
{
...
}
}
1.1.15.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
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


datos HMI
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 Tag_Name, PDWORD 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
{
...
}
}
1.1.15.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(LPDM_VARKEY lpdmVarKey, LPDM_VAR_UPDATE_STRUCT
lpdmresult, LPCMN_ERROR 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
...
}
}

1.1.15.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 (LPDM_VARKEY lpdmVarKey,
LPDM_VAR_UPDATE_STRUCTEX lpdmresult, LPCMN_ERROR 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
{
...
}
}
1.1.15.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 (LPDM_VARKEY lpdmVarKey,
LPDM_VAR_UPDATE_STRUCTEX lpdmresult, LPCMN_ERROR 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
{
...
}
}

1.1.15.13 Funciones GetTagValueWait (RT Professional)
Descripción
estructura de resultados que contiene el valor. El valor se lee directamente del PLC.
Sintaxis
BOOL GetTagValueWait(LPDM_VARKEY lpdmVarKey, LPDM_VAR_UPDATE_STRUCT
lpdmresult, LPCMN_ERROR 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
}
...
}
1.1.15.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:

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


HMI
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 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);
...
}
1.1.16 IncreaseTag (RT Professional)
Descripción
Suma el valor indicado al valor de la variable.
X=X+a
Nota


IncrementarVariable (Variable, Valor)
Utilización en scripts de usuario

IncreaseTag (Tag, Value)
Utilizable, siempre que el dispositivo configurado soporte scripts de usuario. Encontrará más
información en "AUTOHOTSPOT".

Parámetros
Variable
Variable a la que se debe agregar el valor indicado.
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.1.17 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 (DWORD* Pointer to a counter);

Parámetros
Pointer to a counter
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++);
}
}
1.1.18 InverseLinearScaling (RT Professional)
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)

InvertLinearScaling (X, Y, b, a)
información al respecto en "Dependencia del dispositivo".
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);

...
}
1.1.19 InvertBit (RT Professional)
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)

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 b_value y muestra
el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Invert variable
invertBit(b_value);
//print current and saved value

printf ("Current value: %d\r\n, Saved value: %d\r\n",b_value, b_saved);
...
}
1.1.20 InvertBitInTag (RT Professional)
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
Tag
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".
Ejemplo
El siguiente código de programa invierte un bit en la posición indicada bitposition de la variable
bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
//Invert bit in bitposition

InvertBitInTag (bvalue, bitposition);
printf ("Current value: %d\r\n, Saved value: %d\r\n",bvalue, bsaved);
...
}
1.1.21 IsUserAuthorized (RT Professional)
Descripción
Comprueba si un operador posee la autorización indicada.
Sintaxis
BOOL IsUserAuthorized (DWORD 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.
1.1.22 LinearScaling (RT Professional)
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.

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.

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.23 ReportJob (RT Professional)
Descripción
Según el valor del parámetro Name of method se inicia un trabajo de impresión o bien la vista
preliminar de un trabajo de impresión.
Sintaxis
void ReportJob(LPCSTR Print job name, LPCSTR Name of method)
Parámetros
Print job name

Puntero hacia el nombre del trabajo de impresión.
Name of method
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.
{
char* pszPrintjobName;
char* printmethod;
//Get the print method

printf("Input PRINTJOB for printing or PREVIEW for a quick view");
scanf ("%s",&printmethod);
//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
...
}
}
1.1.24 ResetBit (RT Professional)
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).
Ejemplo
El siguiente código de programa pone a 0 el valor de la variable booleana b_value con la
función ResetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 1;
//Reset bit
ResetBit (b_value);

...
}
1.1.25 ResetBitInTag (RT Professional)
Descripción
Pone un bit a 0 (FALSE) en las variables indicadas.
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".
Ejemplo
El siguiente código de programa pone a 0 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
//Reset bit in bitposition

ResetBitInTag (bvalue, bitposition);

...
}
1.1.26 SetBit (RT Professional)
Descripción
Ajusta a "1" (TRUE) el valor de una variable del tipo "Bool".

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 b_saved.
{
BOOL b_value = 0;
//Set bit
SetBit (b_value);

...
}
1.1.27 SetBitInTag (RT Professional)
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).
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
{
BYTE bvalue;

SetBitInTag (bvalue, bitposition);

...
}

1.1.28 SetLanguageByLocaleID (RT Professional)
Descripción
Modifica la configuración de idioma en runtime.
Sintaxis
BOOL SetLanguageByLocaleID (DWORD 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 = SetLanguage(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 34)
1.1.29 SetProp (RT Professional)
1.1.29.1 SetPropBOOL (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "BOOL".

Sintaxis
BOOL SetPropBOOL(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, BOOL Value)
Parámetros
Screen name
Object

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" );
}
...
}
1.1.29.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(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, char* Value)
Parámetros
Screen name
Object


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" );
}
...
}
1.1.29.3 SetPropDouble (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "Double".

Sintaxis
BOOL SetPropDouble(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, double Value)
Parámetros
Screen name
Object

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" );
}
...
}
1.1.29.4 SetPropLong (RT Professional)
Descripción
Establece una propiedad de objeto con el tipo de datos "long".
Sintaxis
BOOL SetPropLong(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, long Value)
Parámetros
Screen name
Object


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" );
}
...
}
1.1.30 SetPropertyByConstant (RT Professional)
Descripción
Define el valor de una propiedad de objeto como cadena de caracteres.


DefinirPropiedadVíaConstante (Nombre de imagen, Objeto, Nombre de la propiedad, Valor)

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

...
}
Como alternativa, puede utilizar en lugar del segundo parámetro (Objeto) la contraseña NULL
o bien un string de espacios en blanco.
1.1.31 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, Nombre
de imagen de destino, Objeto de destino, Nombre de la propiedad de destino)

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 cuya propiedad se transfiere al objeto de destino.
Nombre de la propiedad al que se transfiere el objeto de destino.
Nombre de imagen de destino

Nombre de la imagen en el que está contenido el objeto de destino.
Objeto de destino
Nombre del objeto de destino al que se transfiere la 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");

...
}
1.1.32 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, Nombre de la propiedad, Nombre
de 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
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");

...
}

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


...
}
1.1.33 SetPropertyByTagIndirect (RT Professional)
Descripción
Define el valor de una propiedad de objeto por medio de una variable. La variable contiene el
nombre de variable que determina la propiedad del objeto.

DefinirPropiedadIndirectamenteVíaVariable (Nombre de imagen, Objeto, Nombre de la
propiedad, Nombre de 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
Nombre de variable
Nombre de la variable que, a su vez, contiene el nombre de la variable que determina la
propiedad del objeto.
Ejemplo
SetPropertyByTagIndirect: .
SetPropertyByTagIndirect (GetParentScreen(screenName), GetParentScreenWindow(screenName),

"ScreenName", "HMI_value_1");

...
}
1.1.34 SetTag (RT Professional)
1.1.34.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
Sintaxis
BOOL<Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBit (Tag Tag_Name, short int 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
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 = SetTagBit("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
bvalue = GetTagBit("gs_tag_bit");
printf ("Value of gs_tag_bit: %d\r\n", bvalue);
}
else
{
// failed
}
...
}
1.1.34.2 SetTagDateTime (RT Professional)
Función
Establece el valor de una variable del tipo de datos "Fecha/hora".
Sintaxis
BOOL SetTagDateTime(Tag Tag_Name, SYSTEMTIME 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
1.1.34.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(DWORD* pdwState, const char* 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);
...
}
1.1.34.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(const char* 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;
//Speicher für den Variablenwert wird
//durch die Funktion mit SysMalloc angelegt
double dbVar3Value;
BOOL ok;
ok=GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,


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


ción
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 Tag_Name, short int value, PDWORD 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 la variable en la que se guarda el estado de la variable.
{
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
}
...
}
1.1.34.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 Tag_Name, short int value, PDWORD 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 la variable en la que se guarda el estado de la variable.

{
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
}
...
}
1.1.34.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 (LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD
dwState, LPCMN_ERROR 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
...
}
}

1.1.34.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(LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD
dwState, LPCMN_ERROR 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
...
}
}
1.1.34.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 Tag_Name, short int 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
}
...
}
1.1.34.10 SetTag (RT Professional)
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.
Ejemplo
El siguiente código de programa ajusta con la función SetTag el valor de las variables
{
BOOL ok;
BOOL bvalue;

ok = SetTag("gs_tag_bit", TRUE);
//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}
1.1.34.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, 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
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);
...
}

1.1.34.12 SetTagByTagIndirect (RT Professional)
Descripción
Define el valor de variable por medio del valor de una variable indirecta. La modificación se
registra adicionalmente 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 variable
Nombre de la variable cuyo valor se define por medio de una variable indirecta.
Nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.

Ejemplo
El siguiente código de programa devuelve el valor de la variable "@LocalMachineName" al
hacer clic en cualquier tecla.
{
char* rt_value;
SetTagByTagIndirect (rt_value, "@LocalMachineName", hmiWithoutOperatorEvent);
...
}

1.1.34.13 SetTagIndirect (RT Professional)
Descripción
Define el nombre indirecto para una variable.

DefinirVariableIndirectamente (Nombre de variable (salida), LpValue)

SetTagIndirect (Tag_name, Value, With_or_without_operator_event)
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.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.
{
BYTE result;
BYTE value;
SetTagIndirect ("result", "value", hmiWithoutOperatorEvent);

...
}
1.1.34.14 SetTagIndirectByProperty (RT Professional)
Descripción
Define un nombre de variable por medio del valor de una propiedad de objeto. La modificación


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
Nombre de la variable cuyo nombre se define por medio de la propiedad de objeto.
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad proporciona el nombre de variable.
Nombre de la propiedad que proporciona el nombre de variable.

Ejemplo
El siguiente código de programa ajusta la variable "rt_value_property" al valor de la propiedad
"FlashingEnabled" al hacer clic en la tecla objectName.
{
Int rt_value_property;
SetTagIndirectByProperty ("rt_value_property", screenName, objectName, "FlashingEnabled",
...
}

1.1.34.15 SetTagIndirectByTagIndirect (RT Professional)
Descripción

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

SetTagIndirectByTagIndirect (Tag_name, Source_tag_name,
Parámetros
Nombre de variable
Nombre de la variable indirecta cuyo valor se define por medio de una variable indirecta.
nombre de variable

Ejemplo
El siguiente código de programa ajusta la variable "rt_value" al valor de la variable "value" al
hacer clic en la tecla objectName.
{
Int rt_value;
Int value;
SetTagIndirectByTagIndirect ("rt_value", "value", hmiWithoutOperatorEvent);

...
}

1.1.34.16 SetTagIndirectWithOperatorInputAlarm (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

LpValue
1.1.34.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 variable (salida), LpValue)

SetTagWithOperatorEvent (Tag_name, Value)

Parámetros

Nombre de la variable cuyo valor se define.
LpValue
El valor que se escribe la variable.
Ejemplo
{
BYTE result;
BYTE value;
SetTagWithOperatorEvent ("result", "value");

...
}
1.1.35 StartProgram (RT Professional)
Descripción
Inicia el programa indicado con los parámetros especificados.
Sintaxis
void StartProgram(Program_name,Program_parameter,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 (hmiShowMinimizedAndInaktive) = 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);
...
}
1.1.36 StopRuntime (RT Professional)
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);
1.1.37 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 28)
1.1.38 TriggerOperatorEvent (RT Professional)
Descripción
La función de sistema TriggerOperatorEvent lanza un aviso de operador.
Sintaxis
int TriggerOperatorEvent( DWORD dwFlags, DWORD dwMsgNum, char* lpszObjectName,
DWORD dwMyTextID, double doValueOld, double doValueNew, char* 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
1.1.39 UA (Recipe) (RT Professional)
1.1.39.1 uaAddArchive (RT Professional)
Descripción
Agregar una nueva receta. Equivale a la configuración de una nueva receta con el editor
"Recetas".

Sintaxis
LONG uaAddArchive (
UAHCONFIG hConfig,
UACONFIGARCHIVE* pArchive )
Parámetros
UAHCONFIG hConfig
Handle de configuración para la receta. Este handle se crea con uaQueryConfiguration.
UACONFIGARCHIVE* pArchive
Puntero hacia el búfer para la memoria de la configuración de receta
Valor de retorno
Índice de la nueva receta. Un error corresponde a -1.
Consulte también
uaQueryConfiguration (Página 166)
1.1.39.2 uaAddField (RT Professional)
Descripción
Agregar un nuevo campo de datos.
Sintaxis
LONG uaAddField (
UAHCONFIG hConfig,
long lArchive,
UACONFIGFIELD* pField )
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))
UACONFIGFIELD* pArchive
Puntero sobre el búfer de la configuración de campo
Valor de retorno
Índice del nuevo campo. Un valor de -1 indica un error.
1.1.39.3 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
1.1.39.4 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
1.1.39.5 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
1.1.39.6 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() .
1.1.39.7 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
1.1.39.8 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
1.1.39.9 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.

1.1.39.10 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
1.1.39.11 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
1.1.39.12 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
1.1.39.13 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

1.1.39.14 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
1.1.39.15 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
1.1.39.16 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
1.1.39.17 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.
1.1.39.18 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 );
1.1.39.19 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
1.1.39.20 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

1.1.39.21 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.
1.1.39.22 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
1.1.39.23 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
1.1.39.24 uaArchiveMoveNext (RT Professional)
Descripción
Ir al siguiente registro.
Sintaxis
BOOL uaArchiveMoveNext (

Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
FALSE
Error
1.1.39.25 uaArchiveMovePrevious (RT Professional)
Descripción
Ir al registro anterior.
Sintaxis
BOOL uaArchiveMovePrevious (
Parámetros
UAHARCHIVE hArchive
Valor de retorno
TRUE
FALSE
Error

1.1.39.26 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
1.1.39.27 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
1.1.39.28 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
1.1.39.29 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
1.1.39.30 uaArchiveSetFieldValueDate (RT Professional)
Descripción
Escribe la fecha y la hora en un campo en el registro actual.
Sintaxis
BOOL uaArchiveSetFieldValueDate (
LONG lField,
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
1.1.39.31 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

1.1.39.32 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
1.1.39.33 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
1.1.39.34 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
1.1.39.35 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
1.1.39.36 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

1.1.39.37 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.
1.1.39.38 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
1.1.39.39 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
1.1.39.40 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
1.1.39.41 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
1.1.39.42 uaGetArchive (RT Professional)
Descripción
Lee la configuración de la receta.
Sintaxis
BOOL uaGetArchive (
UAHCONFIG hConfig,
long lArchive,
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Puntero hacia el búfer para recibir la configuración de la receta

Valor de retorno
TRUE
acceso correcto a la receta
FALSE
Error
1.1.39.43 uaGetField (RT Professional)
Descripción:
Lee la configuración del campo.
Sintaxis
BOOL uaGetField (
UAHCONFIG hConfig,
long lArchive,
long lField,
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

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

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

1.1.39.47 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.
1.1.39.48 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 (0... uaGetNumArchives() -1)
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().
1.1.39.49 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 (
LPCSTR pszName,

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().
1.1.39.50 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
Consulte también
uaAddArchive (Página 129)
1.1.39.51 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.
1.1.39.52 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
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

1.1.39.53 uaRemoveAllArchives (RT Professional)
Descripción
Borra todas las recetas que no se utilizan en vistas.
Sintaxis
BOOL uaRemoveAllArchives
( UAHCONFIG hConfig )
Parámetros
UAHCONFIG hConfig
Valor de retorno
TRUE
Borrado correcto
FALSE
Error
Observación
A continuación puede consultar con "uaGetNumArchives()" si se han borrado todas las recetas.
1.1.39.54 uaRemoveAllFields (RT Professional)
Descripción
Elimina todos los campos
Sintaxis
BOOL uaRemoveAllFields (
UAHCONFIG hConfig,
long lArchive )

Parámetros
UAHCONFIG hConfig,
long lArchive,
Valor de retorno
TRUE
Eliminación correcta de campos
FALSE
Error
1.1.39.55 uaRemoveArchive (RT Professional)
Descripción
uaRemoveArchive borra toda la receta configurada.
Sintaxis
BOOL uaRemoveArchive (
UAHCONFIG hConfig,
long lArchive )
Parámetros
UAHCONFIG hConfig,
long lArchive,
Valor de retorno
TRUE
borrado correcto de la receta.
FALSE
Error

1.1.39.56 uaRemoveField (RT Professional)
Descripción
Elimina un campo.
Sintaxis
BOOL uaRemoveField (
UAHCONFIG hConfig,
long lArchive,
long lField )
Parámetros
UAHCONFIG hConfig,
long lArchive,
long lField,
Valor de retorno
TRUE
Eliminación correcta del campo
FALSE
error
1.1.39.57 uaSetArchive (RT Professional)
Descripción:
Establece la configuración de una receta.
Sintaxis
BOOL uaSetArchive (

UAHCONFIG hConfig,
long lArchive,
)
Parámetros
UAHCONFIG hConfig,
long lArchive,
Puntero hacia el búfer pArchive con la configuración de la receta.
Valor de retorno
TRUE
acceso correcto a la receta.
FALSE
1.1.39.58 uaSetField (RT Professional)
Descripción
Pone configuración de campo.
Sintaxis
BOOL uaSetField (
UAHCONFIG hConfig,
long lArchive,
long lField,

1.2 C-bib (RT Professional)
Parámetros
UAHCONFIG hConfig,
long lArchive,
long lField,
UACONFIGFIELD* pField
Puntero sobre el búfer de la configuración de campo
Valor de retorno
TRUE
Acceso correcto a la receta.
FALSE
Error
1.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.
1.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.

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

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

1.3 Definición de estructura (RT Professional)
1.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".
1.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.
1.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.
1.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
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
1.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.

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

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

1.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 ).
1.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) 2
2.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.
Volumen del suministro

Runtime API está formado por los siguientes componentes:
● Documentación de las funciones API
● Ejemplos en C y C++
● Archivos Include y Lib

API de runtime (RT Professional)
2.2 Funciones de la gestión de datos (RT Professional)
Ejemplos en C y C++
Encontrará ejemplos en el directorio "%ProgramFiles%\SIEMENS\Automation\SCADA-
RT_V11\WINCC\samples"
Archivos Include y Lib

Para generar códigos con capacidad funcional 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
2.2.1 Principios básicos (RT Professional)
2.2.1.1 Sinopsis de las estructuras (RT Professional)
Sinopsis
DM_CONNECTION_DATA (Página 214) Datos de conexión

DM_CONNKEY (Página 215) Listar datos de conexión (estructura de filtro)
DM_CYCLE_INFO (Página 216) Ciclos de actualización
DM_DATA_SERVICE (Página 217) Canal de transporte de datos
DM_DIRECTORY_INFO (Página 218) Nombres de ruta y archivo de los datos de confi‐
guración
DM_DLGOPTIONS (Página 219) Especificaciones de los cuadros de diálogo
DM_MACHINE_TABLE (Página 221) Conversión de formato
DM_PROJECT_INFO (Página 222) Información del proyecto
DM_SD_TARGET_APP (Página 226) Especificación de aplicaciones
DM_SD_TARGET_MACHINE (Página 225) Información del equipo
DM_SEND_DATA_STRUCT (Página 223) Especificación de interlocutores en el intercambio
de datos
DM_TYPEREF (Página 227) Referencia del tipo de variable
DM_VAR_UPDATE_STRUCTEX (Página 230) Determinar valores de variables
DM_VAR_UPDATE_STRUCT (Página 228) Determinar valores de variables
DM_VARFILTER (Página 233) Selección de variables
DM_VARGRP_DATA (Página 235) Información sobre un grupo de variables
DM_VARGRPKEY (Página 236) Especificación de un grupo de variables
DM_VARIABLE_DATA4 (Página 239) Con información sobre una variable
DM_VARIABLE_DATA (Página 237) Con información sobre una variable

DM_FORMAT_INFO (Página 221) Conversión de formato

DM_VARKEY (Página 242) Especificación de una variable
DM_VARLIMIT (Página 244) Valores límite de una variable
MCP_NEWVARIABLE_DATA_4 (Página 248) Definición de una variable
MCP_NEWVARIABLE_DATA_5 (Página 250) Definición de una variable
MCP_NEWVARIABLE_DATA_EX4 (Página 254) Definición de una variable
MCP_NEWVARIABLE_DATA_EX (Página 252) Definición de una variable
MCP_NEWVARIABLE_DATA (Página 245) Definición de una variable
MCP_VARIABLE_COMMON_EX (Página 258) Descripción de una variable
MCP_VARIABLE_COMMON (Página 257) Descripción de una variable
MCP_VARIABLE_LIMITS_EX (Página 265) Valores límite de una variable
MCP_VARIABLE_LIMITS5 (Página 263) Valores límite de una variable
MCP_VARIABLE_LIMITS (Página 261) Valores límite de una variable
MCP_VARIABLE_PROTOCOL_EX (Página 268) Tratamiento de valores límite de una variable
MCP_VARIABLE_PROTOCOL (Página 266) Tratamiento de valores límite de una variable
MCP_VARIABLE_SCALES (Página 269) Escalamiento de una variable
2.2.1.2 Sinopsis de las funciones (RT Professional)
Sinopsis
DM_ENUM_CYCLES_PROC (Página 292) Listar ciclos de actualización (Callback)

DM_ENUM_FORMATS_PROC (Página 289) Listar conversiones de formato (Callback)
DM_NOTIFY_PROC (Página 282) Función de notificación
DMActivateRTProject (Página 270) Activar el proyecto
DMChangeDataLocale (Página 278) Cambio de idioma (informar a aplicaciones)
DMConnect (Página 279) Establecer conexión con el administrador de datos
DMDeactivateRTProject (Página 285) Desactivar un proyecto runtime
DMDisconnect (Página 286) Deshacer conexión con el administrador de datos
DMEnumNumberFormats (Página 287) Listar conversiones de formato
DMEnumUpdateCycles (Página 290) Listar ciclos de actualización
DMExitWinCCEx (Página 294) Finalizar WinCC con valores predeterminados
DMExitWinCC (Página 293) Finalizar WinCC
DMGetConnectionState (Página 298) Consultar conexión con el administrador de datos
DMGetHotkey (Página 300) Determinar ID de tecla de acceso directo
DMGetMachineInfo (Página 301) Consultar los parámetros de arranque de una apli‐
cación
DMGetMachineTable (Página 302) Consultar lista de equipos
Consulte también
DMGetDataLocale (Página 299)

2.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
2.2.1.4 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
DM_NOTIFY_SERVERUP 0x00000023
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"
2.2.1.5 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 out of memory
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 1138)
2.2.1.6 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)
2.2.2 Estructuras (RT Professional)
2.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;

Miembros
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ágina 447) Listar datos de conexión (Callback)
Consulte también
DM_ENUM_CONNECTION_PROC (Página 447)
2.2.2.2 DM_CONNKEY (RT Professional)
Declaración
typedef struct {
CHAR szName[ MAX_DM_CONNECTION_NAME + 1 ];
LPVOID lpvUserData;
}
DM_CONNKEY;

Miembros
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 444) Listar datos de conexión
Consulte también
DMEnumConnectionData (Página 444)
2.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 292)
2.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;
Miembros
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 320) Listar canales de transporte de datos (Callback),

instalar canal de transporte de datos (Callback)
Consulte también
DM_DATA_SERVICE_PROC (Página 320)
2.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 la librería más allá del 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 309) Determinar los nombres de ruta y archivo de los

datos de configuración
Consulte también
DMGetProjectDirectory (Página 309)
2.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;

Miembros
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
por NULL.
lpfnDropTarget
por NULL.
lpvUser
Puntero a datos específicos de aplicación.
Archivos necesarios
dmclient.h
Funciones API
DMShowVarDatabase (Página 411) Abrir cuadro de diálogo de selección de variables

DMShowVarDatabaseMulti (Página 416) Abrir cuadro de diálogo de selección de variables
Consulte también
DMShowVarDatabase (Página 411)
DMShowVarDatabaseMulti (Página 416)

2.2.2.7 DM_FORMAT_INFO (RT Professional)
Declaración
typedef struct {
DWORD dwID;
char szName[MAX_DM_FORMAT_NAME + 1];
}
DM_FORMAT_INFO;
Miembros
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 289)
2.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;

Miembros
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 225) 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 302) Consultar lista de equipos
Consulte también
DM_SD_TARGET_MACHINE (Página 225)
DMGetMachineTable (Página 302)
2.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;
Miembros
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 307)
DMEnumOpenedProjects (Página 306) Determinar información del proyecto
Consulte también
DM_ENUM_OPENED_PROJECTS_PROC (Página 307)
DMEnumOpenedProjects (Página 306)
DMGetProjectInformation (Página 310)
2.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;

Miembros
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 225) 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 226) 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 324) Intercambio de datos con aplicaciones
Consulte también
DMSendApplicationData (Página 324)
DM_SD_TARGET_MACHINE (Página 225)
DM_SD_TARGET_APP (Página 226)
2.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;

Miembros
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 221) y DM_SEND_DATA_STRUCT (Página 223).
Archivos necesarios
dmclient.h
Consulte también
DM_MACHINE_TABLE (Página 221)
DM_SEND_DATA_STRUCT (Página 223)
2.2.2.12 DM_SD_TARGET_APP (RT Professional)
Declaración
typedef struct {
char szAppName[MAX_DM_APP_NAME + 1];
}
DM_SD_TARGET_APP;
Miembros
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 223).
Archivos necesarios
dmclient.h
Consulte también
2.2.2.13 DM_TYPEREF (RT Professional)
Declaración
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;
Miembros
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 8 bits juego de caracteres
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 228) y DM_VARIABLE_DATA (Página 237).
Archivos necesarios
dmclient.h
Funciones API
DMGetVarType (Página 379) Determinar el tipo de datos de una variable
Consulte también
DM_VAR_UPDATE_STRUCT (Página 228)
DMGetVarType (Página 379)
DM_VARIABLE_DATA (Página 237)
DM_VAR_UPDATE_STRUCTEX (Página 230)
DM_VARIABLE_DATA4 (Página 239)
2.2.2.14 DM_VAR_UPDATE_STRUCT (RT Professional)
Declaración
typedef struct {
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;

Miembros
dmTypeRef
La estructura DM_TYPEREF (Página 227) 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 242) 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 informe
DM_VARSTATE_HARDWARE_ERROR (0x0004) Defecto del módulo de red
DM_VARSTATE_MAX_LIMIT (0x0008) Límite superior configurado excedido
DM_VARSTATE_MIN_LIMIT (0x0010) Límite inferior configurado excedido
DM_VARSTATE_MAX_RANGE (0x0020) Límite de formato rebasado por ex‐
ceso
DM_VARSTATE_MIN_RANGE (0x0040) Límite de formato rebasado por de‐
fecto
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 requeridos
dmclient.h
Funciones API
DM_NOTIFY_VARIABLE_PROC (Página 459) Determinar valores de variables (Callback)

DMGetValue (Página 342) Determinar valores de variables
Consulte también
DM_NOTIFY_VARIABLE_PROC (Página 459)
DM_VARKEY (Página 242)
DMGetValue (Página 342)
DM_TYPEREF (Página 227)
2.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 242) 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 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
defecto
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_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_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
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 informe 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 rebasado por ex‐ Uncertain, engineering unit range viola‐
ceso tion, high limit gesetzt, 0x56
DM_VARSTATE_MIN_RANGE (0x0040) Límite de formato rebasado por de‐ Uncertain, engineering unit range viola‐
fecto 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 reba‐ La imagen en Limit-Bit HIGH, 0x01, jun‐
sado por exceso 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 rebasa‐ La imagen en Limit-Bit LOW, 0x02, junto
do por defecto 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ágina 470) Determinar valores de variables (Callback)

DMGetValueEx (Página 344) Determinar valores de variables

Consulte también
DM_NOTIFY_VARIABLEEX_PROC (Página 470)
DMGetValueEx (Página 344)
2.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.

DM_VARTYPE_FLOAT Número en coma flotante de 32 bits IEEE 754
DM_VARTYPE_DOUBLE Número en coma flotante de 64 bits IEEE 754
DM_VARTYPE_TEXT_8 Variable de texto de juego de caracteres 8 bits
DM_VARTYPE_TEXT_16 Variable de texto de juego de caracteres 16 bits
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 338) Listar nombres de variables

Consulte también
DMEnumVariables (Página 338)
2.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;
Miembros
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 337) Listar información sobre un grupo de variables

(Callback)
Consulte también
DM_ENUM_VARGRP_PROC (Página 337)
2.2.2.18 DM_VARGRPKEY (RT Professional)
Declaración
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARGRPKEY;
Miembros
szName
Nombre del grupo de variables
lpvUserData
Archivos necesarios
dmclient.h

Funciones API
DMEnumVarGrpData (Página 334) Listar información sobre un grupo de variables
Consulte también
DMEnumVarGrpData (Página 334)
2.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 244) 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 la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos 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 328) Listar información sobre una variable (Callback)
Consulte también
DM_ENUM_VARIABLE_PROC (Página 328)
DM_VARLIMIT (Página 244)
DMEnumVarData (Página 326)
2.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;

Miembros
dmTypeRef
dmVarLimit
La estructura DM_VARLIMIT (Página 244) 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 el evento para el que se genera una entrada de protocolo:
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
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
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 269) con la descripción de la escala de las
variables.
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 332) Listar información sobre una variable (Callback)
Consulte también
DMEnumVarData4 (Página 330)
DM_ENUM_VARIABLE_PROC4 (Página 332)
MCP_VARIABLE_SCALES (Página 269)
2.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;
Miembros
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 228).
Archivos necesarios
dmclient.h
Funciones API
DM_ENUM_TYPEMEMBERS_PROC_EX (Pági‐ Listar variables de una variable estructurada (Call‐

na 436) back)
DM_ENUM_TYPEMEMBERS_PROC (Pági‐ Listar variables de una variable estructurada (Call‐
na 431) back)
DM_ENUM_VAR_PROC (Página 340) Listar nombres de variables (Callback)
DM_NOTIFY_SELECT_VAR_PROC (Página 422) Abrir cuadro de diálogo de selección de variables
(Callback)
DMEnumVarData (Página 326) Listar información sobre una variable
DMGetValueWait (Página 355) Determinar los valores de las variables con actua‐
lización
DMGetVarLimits (Página 373) Determinar los valores límite de una variable
DMGetVarInfo (Página 361) Determinar ID de variables, determinar nombre de
variables
DMGetVarType (Página 379) Determinar el tipo de datos de una variable
DMSetValue (Página 386) Modificar valores de variables
DMSetValueMessage (Página 392) Modificar valores de variables con salida de avisos
DMSetValueWait (Página 395) Modificar valores de variables con aviso
DMSetValueWaitMessage (Página 401) Modificar valores de variables con aviso y salida
de avisos
DMStartVarUpdate (Página 457) Definir variables de actualización
Consulte también
DMStartVarUpdate (Página 457)
DMGetValueWait (Página 355)
DMGetVarInfo (Página 361)

DMGetVarLimits (Página 373)

DMSetValue (Página 386)
DMSetValueMessage (Página 392)
DMSetValueWait (Página 395)
DMSetValueWaitMessage (Página 401)
DM_ENUM_VAR_PROC (Página 340)
DM_ENUM_TYPEMEMBERS_PROC (Página 431)
DM_ENUM_TYPEMEMBERS_PROC_EX (Página 436)
DM_NOTIFY_SELECT_VAR_PROC (Página 422)
DMStartVarUpdateEx (Página 461)
DMGetValueWaitEx (Página 357)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Página 439)
MSG_CSDATA_STRUCT_PLUS (Página 1039)
2.2.2.22 DM_VARLIMIT (RT Professional)
Declaración
typedef struct {
VARIANT dmMaxRange;
VARIANT dmMinRange;
VARIANT dmMaxLimit;
VARIANT dmMinLimit;
}
DM_VARLIMIT;
Miembros
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 237). Todos los
VARIANT deben volver a habilitarse con VariantClear(&dmxxx) después del uso.
Archivos necesarios
dmclient.h
Funciones API
DMGetVarLimits (Página 373) Determinar los valores límite de una variable
Consulte también
2.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 257) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL (Página 266) con la descripción del tratamiento del
rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS (Página 261) con los valores límite de la variable.

szSpecific
Parámetros.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX (Página 252) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Funciones API
GAPICreateNewVariable (Página 423) Crear variable
Consulte también
GAPICreateNewVariable (Página 423)
MCP_VARIABLE_PROTOCOL (Página 266)
MCP_VARIABLE_COMMON (Página 257)
MCP_VARIABLE_LIMITS (Página 261)
MCP_NEWVARIABLE_DATA_EX (Página 252)

2.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 261) con los valores límite de la variable.
szSpecific
Parámetros.
Scaling
Estructura MCP_VARIABLE_SCALES (Página 269) con la descripción del escalamiento de
la variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX4 (Página 254) tiene un uso similar en la
Archivos necesarios
dmclient.h
Funciones API
GAPICreateNewVariable4 (Página 425) Crear variable

GAPICreateNewVariableEx4 (Página 428) Crear variable con ID de Creator

Consulte también
GAPICreateNewVariable4 (Página 425)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
GAPICreateNewVariableEx4 (Página 428)
2.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 263) con los valores límite de la variable.
szSpecific
Parámetros.
Scaling
la variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX4 (Página 254) tiene un uso similar en la

Archivos necesarios
dmclient.h
Funciones API
GAPICreateNewVariable5 (Página 426) Crear variable con ID de Creator
Consulte también
MCP_VARIABLE_LIMITS5 (Página 263)
2.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 258) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL_EX (Página 268) con la descripción del tratamiento
del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS_EX (Página 265) con los valores límite de la variable.
szSpecific
Parámetros.
Observaciones
La estructura MCP_NEWVARIABLE_DATA (Página 245) 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 436) back)
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
MCP_VARIABLE_COMMON_EX (Página 258)
MCP_VARIABLE_LIMITS_EX (Página 265)
MCP_VARIABLE_PROTOCOL_EX (Página 268)
2.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 258) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL_EX (Página 268) con la descripción del tratamiento
del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS_EX (Página 265) con los valores límite de la variable.

szSpecific
Parámetros.
Scaling
la variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_4 (Página 248) 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 439) back)
Consulte también
MCP_NEWVARIABLE_DATA_4 (Página 248)

2.2.2.28 MCP_VARIABLE_COMMON (RT Professional)
Declaración
typedef struct {
DWORD dwVarType;
DWORD dwVarLength;
DWORD dwFormat;
}
MCP_VARIABLE_COMMON;
Miembros
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 245) y MCP_NEWVARIABLE_DATA_4 (Página 248).
La estructura MCP_VARIABLE_COMMON_EX (Página 258) tiene un uso similar en la
Archivos necesarios
dmclient.h
Consulte también
2.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;

Miembros
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 252).
La estructura MCP_VARIABLE_COMMON (Página 257) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también

2.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;
Miembros
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 265) tiene un uso similar en la
Archivos necesarios
dmclient.h
Consulte también

2.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;
Miembros
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 250) y es necesario para poder especificar variables de texto con valor inicial y
sustitutivo con la función GAPICreateNewVariable5 (Página 426).
Archivos necesarios
dmclient.h
Consulte también

2.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;
Miembros
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 252).
La estructura MCP_VARIABLE_LIMITS (Página 261) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también
2.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;

Miembros
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 268) tiene un uso similar en la
Archivos necesarios
dmclient.h
Consulte también

2.2.2.34 MCP_VARIABLE_PROTOCOL_EX (RT Professional)
Declaración
typedef struct {
DWORD dwProtocolFlags
}
MCP_VARIABLE_PROTOCOL_EX;
Miembros
dwProtocolFlags
Con el parámetro dwProtocolFlags se determina en qué evento debe generarse una entrada
de protocolo:
MCP_VARPROT_TOPLIMITERR Se genera una entrada de protocolo si el valor de

la variable excede el valor límite superior.
MCP_VARPROT_BOTTEMLIMITERR Se genera una entrada de protocolo si el valor de
la variable excede el valor límite inferior.
MCP_VARPROT_TRANSFORMATIONERR Se crea una entrada de protocolo cuando aparece
un error de conversión.
MCP_VARPROT_WRITEERR Se genera una entrada de protocolo en cada ac‐
ceso de escritura no válido.
MCP_VARPROT_WRITEERRAPPLICATION Se crea una entrada de protocolo en cada acceso
de escritura no válido en la aplicación.
MCP_VARPROT_WRITEERRPROCESS Se crea una entrada de protocolo 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 252).
La estructura MCP_VARIABLE_PROTOCOL (Página 266) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también

2.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;
Miembros
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 248).
Archivos necesarios
dmclient.h
Consulte también


2.2.3 Funciones generales (RT Professional)
2.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ámetro
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
2.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ámetro
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
fallo, 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;
}
2.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,
Parámetro
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 será notificada a través de la función Callback DM_NOTIFY_PROC
(Página 282) 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
Funciones utilizadas
AUTOHOTSPOT Establecer conexión con el administrador de datos
Consulte también
DM_NOTIFY_PROC (Página 282)
DMGetRuntimeProject (Página 312)
2.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ámetro
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 las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
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
Puntero a los datos del mensaje 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
Conexión con el administrador de datos establecida.
FALSE
Error.

Observación
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 286) Deshacer conexión con el administrador de datos

DMGetConnectionState (Página 298) Comprobar conexión con el administrador de da‐
tos
DM_NOTIFY_PROC (Página 282) Función de notificación
Ejemplos
Connection to DM (Página 477)"DM01.cpp"
Consulte también
DM_NOTIFY_PROC (Página 282)
DMDisconnect (Página 286)
DMGetConnectionState (Página 298)
Connection to DM (Página 477)
APConnect (Página 609)
2.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ámetro
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.
la llamada de función DMConnect.
Archivos necesarios
dmclient.h

Ejemplos
AUTOHOTSPOT"DM01.cpp"
Consulte también
DMConnect (Página 279)
2.2.3.6 DMDeactivateRTProject (RT Professional)
Utilización
El proyecto ubicado en el modo runtime se desactiva.
Declaración
BOOL DMDeactivateRTProject (
Parámetro
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 489)"TESTCDoc.cpp"
Consulte también
OnTestDeactivateRuntimeProject (Página 489)
2.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ámetro
lpdmError
Valor de retorno
TRUE
Conexión finalizada.
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 477)"DM01.cpp"
Consulte también
2.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ámetro
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
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
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 289)
2.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ámetro
lpdmFormat
Puntero a una estructura del tipo DM_FORMAT_INFO (Página 221) 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 287) Listar conversiones de formato
Consulte también
DMEnumNumberFormats (Página 287)
DM_FORMAT_INFO (Página 221)
2.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ámetro
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 497)"TESTCDoc.cpp"
Consulte también
DM_ENUM_CYCLES_PROC (Página 292)
OnTestUpdateCycles (Página 497)
2.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ámetro
lpdmCycle
Puntero a una estructura del tipo DM_CYCLE_INFO (Página 216) 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 290) Listar ciclos de actualización
Consulte también
DMEnumUpdateCycles (Página 290)
DM_CYCLE_INFO (Página 216)
2.2.3.12 DMExitWinCC (RT Professional)
Utilización
Esta función finaliza WinCC.
Declaración
BOOL DMExitWinCC (
VOID);

Parámetro
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 294) Finalizar WinCC con valores predeterminados
Ejemplos
OnTestWinCCShutdown (Página 514)"TESTCDoc.cpp"
Consulte también
OnTestWinCCShutdown (Página 514)
DMExitWinCCEx (Página 294)
2.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ámetro
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 293) Finalizar WinCC
Consulte también
DMExitWinCC (Página 293)
2.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ámetro
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
DM_E_PARAM Error de parámetro

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

2.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ámetro
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
2.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ámetro
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
2.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ámetro
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
2.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ámetro
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
2.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ámetro
lpdwProjectFile
lpdmMachineTable
Puntero a la estructura DM_MACHINE_TABLE (Página 221), en la que se depositan 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 492)"TESTCDoc.cpp"
Consulte también
DM_MACHINE_TABLE (Página 221)
OnTestMachines (Página 492)
DMActivateRTProject (Página 270)
2.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ámetro
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
DM_E_PARAM Parámetro error
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!");
}
}

2.2.4 Funciones para la administración de proyectos (RT Professional)
2.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ámetro
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 307)
Ejemplos
Enum open projects (Página 482)"DM01.cpp"
OnTestOpenProjects (Página 496)"TESTCDoc.cpp"
Consulte también
DM_PROJECT_INFO (Página 222)
Enum open projects (Página 482)
OnTestOpenProjects (Página 496)
DMChangeDataLocale (Página 278)
2.2.4.2 DM_ENUM_OPENED_PROJECTS_PROC (RT Professional)
Descripción
Para poder evaluar los proyectos listados en el sistema, es preciso facilitar 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ámetro
lpInfo
Puntero a una estructura del tipo DM_PROJECT_INFO (Página 222) 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 306) Listar proyectos (abiertos)

Ejemplos
Enum open projects "DM01.cpp"
Consulte también
Enum open projects (Página 482)
2.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ámetro
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 218), en la que se deposita la
indicación de la ruta 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 494)"TESTCDoc.cpp"
Consulte también
DM_DIRECTORY_INFO (Página 218)
OnTestProjectPaths (Página 494)
2.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ámetro
lpszProjectFile
RT con DMGetRuntimeProject.
lpProjectInfo
Puntero a la estructura DM_PROJECT_INFO (Página 222), en la que debe depositarse 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 488)"DM01.cpp"
OnTestProjectInfo (Página 492)"TESTCDoc.cpp"
Consulte también
Inquire project informations (Página 488)
OnTestProjectInfo (Página 492)

2.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ámetro
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 516)"DM02.cpp"
Write tag (Página 521)"DM02.cpp"
OnTestRuntimeProject (Página 496)"TESTCDoc.cpp"
Consulte también
Read tag (Página 516)
Write tag (Página 521)
OnTestRuntimeProject (Página 496)
DMChangeDataLocale (Página 278)
2.2.4.6 DMOpenProjectDocPlus (RT Professional)
Utilización
Abre el proyecto indicado en lpszProjectFile.
Declaración
BOOL DMOpenProjectDocPlus (
Parámetro
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
2.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ámetro
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 515)"DM01.cpp"
OnTestOpenProject (Página 495)"TESTCDoc.cpp"
Consulte también
Open project by means of dialog (Página 515)
OnTestOpenProject (Página 495)
2.2.5 Canales de transporte de datos (RT Professional)
2.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ámetro
lpdmError
Valor de retorno
TRUE
Cola de espera de notificaciones borrada.

FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
2.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ámetro
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 319)
DMInstallDataService (Página 322) Instalar canal de transporte de datos
Consulte también
DM_ENUM_DATA_SERVICE_PROC (Página 319)
DMInstallDataService (Página 322)

2.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ámetro
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 320), en la que
se ponen a disposición más datos de un servicio.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota

Archivos necesarios
dmclient.h
DMEnumDataServices (Página 317) Listar canales de transporte de datos
Consulte también
DMEnumDataServices (Página 317)
2.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ámetro
lpds
Puntero a una estructura del tipo DM_DATA_SERVICE (Página 217) 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 322) Instalar canal de transporte de datos

DM_ENUM_DATA_SERVICE_PROC (Pági‐ Listar canales de transporte de datos (Callback)
na 319)
Consulte también
DM_ENUM_DATA_SERVICE_PROC (Página 319)
DM_DATA_SERVICE (Página 217)
DMInstallDataService (Página 322)
2.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ámetro
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
2.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ámetro
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.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
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 320) Listar canales de transporte de datos (Callback)

Instalar canal de transporte de datos (Callback)
Consulte también
DMEnumDataServices (Página 317)
2.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ámetro
lpdmSendData
Puntero a la estructura DM_SEND_DATA_STRUCT (Página 223).
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
2.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ámetro
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
2.2.6 Funciones para procesar variables (RT Professional)
2.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ámetro
lpszProjectFile
lpdmVarKey
Puntero al principio de un campo de estructuras del tipo DM_VARKEY (Página 242) sobre el
que deben especificarse 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 237) 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
2.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ámetro
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 242) para especificar las variables
que hay que listar.
lpdmVarData
Puntero a una estructura del tipo DM_VARIABLE_DATA (Página 237) 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 326) Listar información sobre una variable
Consulte también
2.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ámetro
lpszProjectFile
lpdmVarKey
Puntero al principio de un campo de estructuras del tipo DM_VARKEY (Página 242) sobre el
que deben especificarse 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_VARKEYdefectuosa, debe transmitir en Callback una estructura del
tipo DM_VARIABLE_DATA4 (Página 239) 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ágina 332) Listar información sobre una variable (Callback)
Ejemplos
Enum Data of Tags (Página 480)"DM01.cpp"
Consulte también
Enum Data of Tags (Página 480)
2.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ámetro
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 242) para especificar las variables
que hay que listar.
lpdmVarData
Puntero a una estructura del tipo DM_VARIABLE_DATA4 (Página 239) 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 330) Listar información sobre una variable
Ejemplos
Enum Data of Tags (Página 480)"DM01.cpp"
Consulte también
Enum Data of Tags (Página 480)

2.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ámetro
lpszProjectFile
lpdmVarGrpKey
Puntero a la primera estructura del tipo DM_VARGRPKEY (Página 236) ,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 337)
Ejemplos
OnTestEnumGroupsAll (Página 489)"TESTCDoc.cpp"
Consulte también
DM_VARGRPKEY (Página 236)
DM_ENUM_VARGRP_PROC (Página 337)
OnTestEnumGroupsAll (Página 489)
2.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ámetro
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

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)
2.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ámetro
lpdmVarGrpData
Puntero a una estructura del tipo DM_VARGRP_DATA (Página 235) 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 334) Listar información sobre un grupo de variables
Consulte también
DM_VARGRP_DATA (Página 235)
2.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ámetro
lpszProjectFile
lpdmVarFilter
Puntero a la estructura DM_VARFILTER (Página 233), en la que se depositan 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 340) Listar nombres de variables (Callback)
Ejemplos
OnTestEnumVariables (Página 490)"TESTCDoc.cpp"
Consulte también
DM_VARFILTER (Página 233)
DM_ENUM_VAR_PROC (Página 340)
OnTestEnumVariables (Página 490)
2.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 242) 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 338) Listar nombres de variables
Consulte también

2.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ámetro
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) 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 228) 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 aplica la actualización de la variable al ciclo solicitado, sin embargo
deja a la aplicación la responsabilidad sobre el cálculo de tiempo de lectura de 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 516)"DM02.cpp"
OnTestVariablenGetvalue (Página 500)"TESTCDoc.cpp"
Consulte también
Read tag (Página 516)
OnTestVariablenGetvalue (Página 500)

2.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ámetro
lpdmVarKey
dwItems
lpdmvus
Puntero a la primera de las estructuras DM_VAR_UPDATE_STRUCTEX (Página 230) 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 aplica la actualización de la variable al ciclo solicitado, sin embargo
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 No hay memoria suficiente
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
lización
Consulte también
2.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ámetro
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

Observación
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 aplica la actualización de la variable al ciclo solicitado, sin embargo
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

DM_E_OOM out of memory
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;
}

2.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, además proporciona en la estructura
DM_VAR_UPDATE_STRUCTEX de la función Callback DM_NOTIFY_VARIABLEEX_PROC
el Quality Code.
Declaración
BOOL DMGetValueWait (
LPDWORD pdwTAID,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
Parámetro
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 es llamada
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.
lpvUser
lpdmError
Valor de retorno
TRUE
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
DM_NOTIFY_VARIABLE_PROC (Página 459) Determinar los valores de las variables con actua‐
lización (Callback)

DMGetValueWaitEx (Página 357) Determinar los valores de las variables con actua‐
lización
AUTOHOTSPOT Modificar valores de variables con aviso
Ejemplos
OnTestVariablenGetvaluewait (Página 503)"TESTCDoc.cpp"
Consulte también
OnTestVariablenGetvaluewait (Página 503)
2.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ámetro
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.
lpvUser
lpdmError

Valor de retorno
TRUE
FALSE
Error.
DM_NOTIFY_VARIABLEEX_PROC (Página 470) Determinar los valores de las variables con notifi‐
cación (Callback)
DMGetValueEx (Página 344) Determinar valores de variables
Consulte también
2.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ámetro
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".
2.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ámetro
lpszProjectFile
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242) 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 507)"TESTCDoc.cpp"
Consulte también
OnTestVariablenGetVarInfo (Página 507)
2.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
Observación
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");
2.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ámetro
lpszProjectFile
lpdmVarKey
Puntero a estructuras del tipo DM_VARKEY (Página 242) para especificar variables.
dwItems
lpdmVarLimit
Puntero a estructuras del tipo DM_VARLIMIT (Página 244) en el que se agregan 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 Exceder el límite superior de la conversión de for‐

mato
DM_E_MIN_RANGE Exceder el límite inferior de la conversión de for‐
mato
DM_E_MAX_LIMIT Exceder el límite superior de las variables
DM_E_MIN_LIMIT Exceder el límite inferior de las variables
DM_E_INVALID_TYPE Tipo de variable no válido
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenGetvarlimits (Página 508)"TESTCDoc.cpp"
Consulte también
OnTestVariablenGetvarlimits (Página 508)

2.2.6.19 DMGetVarLimitsExStr (RT Professional)
Declaración
BOOL DMGetVarLimitsExStr (
LPDM_VARLIMIT lpdmVarLimit,
LPCMN_ERROR lpdmError );
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ámetro
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
Observación
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
DM_E_MAX_RANGE Límite superior de la conversión de formato reba‐

sado por exceso
DM_E_MIN_RANGE Límite inferior de la conversión de formato reba‐
sado por defecto
DM_E_MAX_LIMIT Límite superior de la variable rebasado por exceso
DM_E_MIN_LIMIT Límite inferior de la variable rebasado por defecto
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");
2.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ámetro
lpszProjectFile
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242) con la clave de variable para la que se
determina el tipo.
dwItems
lpdmTypeRef
Puntero a la lista de estructuras DM_TYPEREF (Página 227) para retornar las indicaciones
del 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 509)"TESTCDoc.cpp"
Consulte también
OnTestVariablenGetvartype (Página 509)
2.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ámetro
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
Observación
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");
2.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ámetro
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) 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_HARDWARE_ERROR (0x0004) Defecto del módulo de red
DM_VARSTATE_MAX_LIMIT (0x0008) Límite superior configurado excedido
DM_VARSTATE_MIN_LIMIT (0x0010) Límite inferior configurado excedido
DM_VARSTATE_MAX_RANGE (0x0020) Límite de formato rebasado por exceso
DM_VARSTATE_MIN_RANGE (0x0040) Límite de formato rebasado por defec‐
to
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
DM_E_MAX_LIMIT Exceder el límite superior de las variables

DM_E_MIN_LIMIT Exceder el límite inferior de las variables
DM_E_MAX_RANGE Exceder el límite superior de la conversión de for‐
mato
DM_E_MIN_RANGE Exceder el límite inferior de la conversión de for‐
mato
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 521)"DM02.cpp"
OnTestVariablenSetvalue (Página 511)"TESTCDoc.cpp"

Consulte también
Write tag (Página 521)
OnTestVariablenSetvalue (Página 511)
2.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ámetro
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
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 defecto
to
SION_ERROR sión (en combinación con DM_VARS‐
TATE_..._RANGE)
DM_VARSTATE_INVALID_KEY (0x0800) Variable no encontrada/no existente
DM_VARSTATE_TIMEOUT (0x2000) Timeout/ninguna respuesta del canal
lpdmError
Valor de retorno
TRUE
FALSE
Error

Observación
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
DM_E_MAX_LIMIT Límite superior de la variable rebasado por exceso

DM_E_MIN_LIMIT Límite inferior de la variable rebasado por defecto
DM_E_MAX_RANGE Límite superior de la conversión de formato reba‐
sado por exceso
DM_E_MIN_RANGE Límite inferior de la conversión de formato reba‐
sado por defecto
DM_E_ACCESS_FAULT Acceso en 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
2.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ámetro
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242) que identifica 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

2.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ámetro
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
Observación
"DMSetValueExStr".
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll

de avisos
2.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ámetro
pdwTAID
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) 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.

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 406) Modificar valores de variables (Callback)
Ejemplos
OnTestVariablenSetvaluewait (Página 512)"TESTCDoc.cpp"

Consulte también
DM_COMPLETITION_PROC (Página 406)
OnTestVariablenSetvaluewait (Página 512)
2.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ámetro
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
por exceso
por defecto
to
SION_ERROR sión (en combinación con DM_VARS‐
TATE_..._RANGE)


DM_VARSTATE_INVALID_KEY (0x0800) Variable no encontrada/no existente
DM_VARSTATE_TIMEOUT (0x2000) Timeout/ninguna respuesta del canal
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.
Observación
"DMSetValueExStr".

Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll

de avisos
DM_COMPLETITION_PROC Modificar valores de variables (Callback)
Ejemplos
2.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ámetro
pdwTAID
lpdmVarKey
Puntero a las estructuras DM_VARKEY (Página 242) 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
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 406) Modificar valores de variables (Callback)


Consulte también
OnTestVariablenSetvaluewait (Página 512)
DM_COMPLETITION_PROC (Página 406)
2.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ámetro
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
que se proporciona de nuevo en la función Callback.
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
Observación
"DMSetValueExStr".
Mensajes de error

Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
DM_COMPLETITION_PROC Modificar valores de variables (Callback)

2.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ámetro
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
por exceso
por defecto
to
DM_VARSTATE_CONVERSION_ERROR (0x0080) Visualización de errores de conver‐
sión (en combinación con DM_VARS‐
TATE_..._RANGE)
DM_VARSTATE_TIMEOUT (0x2000) Timeout / ninguna respuesta del canal
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.
Archivos necesarios
dmclient.h

de avisos
Consulte también
2.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ámetro
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");
}
2.2.6.32 DMShowVarDatabase (RT Professional)
Utilización
La función abre el 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ámetro
lpszProjectFile


hwndParent
lpdmOptions
Puntero a la estructura DM_DLGOPTIONS (Página 219) con preajustes 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 233). 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 242). 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 219)
2.2.6.33 DMShowVarDatabaseExStr (RT Professional)
Declaración
BOOL DMShowVarDatabaseExStr (
HWND hwndParent,
LPTSTR* lppszVariableName,
LPDWORD lpdwVarNameCharCount,
LPDWORD lpdwVariableID,
Descripción
La función abre el cuadro de diálogo de selección de variables para el proyecto especificado.
A diferencia de "ShowVarDatabaseMultiExStr", solo puede seleccionarse una variable.
Parámetro
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);
}
2.2.6.34 DMShowVarDatabaseMulti (RT Professional)
Utilización
La función abre el diálogo de selección de variables para el proyecto especificado. 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ámetro
lpszProjectFile
hwndParent
lpdmOptions
Puntero a la estructura DM_DLGOPTIONS (Página 219) con preajustes 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 233). 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ágina 422) Abrir cuadro de diálogo de selección de variables
(Callback)
Consulte también
DM_DLGOPTIONS (Página 219)
DM_NOTIFY_SELECT_VAR_PROC (Página 422)
2.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
La función abre el cuadro de diálogo de selección de variables para el proyecto especificado.
A diferencia de "ShowVarDatabaseExStr", se pueden seleccionar varias variables.
Parámetro
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;
}
2.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ámetro
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) 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
2.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 245) 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

Consulte también


2.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ámetro
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_4 (Página 248) con los datos de las
variables.
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
2.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ámetro
dwCreatorID
sistemas.
pData
variables.
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 263)
2.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
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

2.2.7 Funciones para procesar variables estructuradas (RT Professional)
2.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ámetro
lpszProjectFile
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno en el proyecto
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 431) (Callback)
GAPIEnumTypeMembersEx (Pági‐ Listar variables de una variable estructurada
na 433)
GAPIEnumTypeMembersEx4 (Pági‐ Listar variables de una variable estructurada
na 437)
Consulte también
DM_ENUM_TYPEMEMBERS_PROC (Página 431)
GAPIEnumTypeMembersEx (Página 433)
GAPIEnumTypeMembersEx4 (Página 437)
2.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ámetro
lpszStructTypeName
Puntero al nombre de las variables pertenecientes a una variable estructurada.
lpvUser
Puntero a datos específicos de aplicación. Este puntero vuelve a estar disponible en la función
Callback.
Valor de retorno
TRUE
FALSE
La enumeración se interrumpirá.
Nota
A ser posible, sólo deben copiarse datos. Los siguientes tipos de llamadas de función dentro
de Callback pueden producir Deadlocks o Stackoverflow:
● Funciones ODK de la misma DLL
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
GAPIEnumTypeMembers (Página 430) Listar variables de una variable estructurada
Consulte también
GAPIEnumTypeMembers (Página 430)

2.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ámetro
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 436)
GAPIEnumTypeMembersEx4 (Página 437) Listar variables de una variable estructurada
Consulte también
2.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ámetro
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
2.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ámetro
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 252) 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 433)
Consulte también
2.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ámetro
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 439) back)
Consulte también
2.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ámetro
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) con las claves (ID
y nombre) de una variable
lpdmVarDataEx
Puntero a una estructura del tipo MCP_NEWVARIABLE_DATA_EX4 (Página 254) con la
descripción de una variable.
lpvUser
función Callback.

Valor de retorno
TRUE
FALSE
Nota
Archivos necesarios
dmclient.h
GAPIEnumTypeMembersEx4 (Pági‐ Listar variables de una variable estructurada

na 437)
Consulte también
2.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ámetro
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 442)
Ejemplos
Enumerate all structured types (Página 484)"DM01.cpp"
Consulte también
DM_ENUM_TYPES_PROC (Página 442)
Enumerate all structured types (Página 484)
2.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ámetro
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 440) Listar tipos de variables estructuradas
Ejemplos
Enumerate all structured types (Página 484)"DM01.cpp"
Consulte también
GAPIEnumTypes (Página 440)
Enumerate all structured types (Página 484)

2.2.8 Funciones para procesar conexiones (RT Professional)
2.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ámetro
lpszProjectFile
lpdmConnKey
Puntero a la primera de las estructuras del tipo DM_CONNKEY (Página 215). 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ágina 447) Listar datos de conexión (Callback)
Ejemplos
Enumerate all connections (Página 486)"DM01.cpp"
OnTestEnumConnectionDataAll (Página 491)"TESTCDoc.cpp"
Consulte también
DM_CONNKEY (Página 215)
Enumerate all connections (Página 486)
OnTestEnumConnectionDataAll (Página 491)
2.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ámetro
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)
2.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ámetro
lpdmConData
Puntero a una estructura del tipo DM_CONNECTION_DATA (Página 214) en la que están
guardados los datos de una conexión lógica.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE
Nota

Archivos necesarios
dmclient.h
DMEnumConnectionData (Página 444) Listar datos de conexión
Ejemplos
Enumerate all connections (Página 486)"DM01.cpp"
Consulte también
DM_CONNECTION_DATA (Página 214)
Enumerate all connections (Página 486)
2.2.9 Funciones de la plataforma de trabajo (RT Professional)
2.2.9.1 DMGetOSVersion (RT Professional)
Utilización
Determina el sistema operativo que se utiliza en el PC.
Declaración
DWORD DMGetOSVersion (
VOID);
Parámetro
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
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
2.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ámetro
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 497)"TESTCDoc.cpp"
Consulte también
OnTestSystemLocale (Página 497)
2.2.9.3 DMSetLanguage (RT Professional)
Utilización
Inicia el cambio del idioma de configuración.
Declaración
BOOL DMSetLanguage (
DWORD dwLocaleID,
Parámetro
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
2.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ámetro
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

2.2.10 Funciones para actualizar variables (RT Professional)
2.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ámetro
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 498)"TESTCDoc.cpp"
Consulte también
OnTestVariablenBeginstartvarupdate (Página 498)
DMEndStartVarUpdate (Página 454)
DMResumeVarUpdate (Página 455)
DMStopVarUpdate (Página 473)
DMSuspendVarUpdate (Página 474)
2.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ámetro
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 453) Iniciar solicitud de actualización

Ejemplos
OnTestVariablenEndstartvarupdate (Página 499)"TESTCDoc.cpp"
Consulte también
OnTestVariablenEndstartvarupdate (Página 499)
DMBeginStartVarUpdate (Página 453)
2.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ámetro
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 474) Interrumpir la actualización de variables
Ejemplos
OnTestVariablenResumevarupdate (Página 510)"TESTCDoc.cpp"

Consulte también
OnTestVariablenResumevarupdate (Página 510)
2.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ámetro
dwTAID
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) 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 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.
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 459) Definir variables de actualización (Callback)
Consulte también
2.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ámetro
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 228)
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
Observación
Nota
WinCC.
Archivos necesarios
dmclient.h

lización
Consulte también
2.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ámetro
dwTAID
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) 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 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
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.
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ágina 470) Definir variables de actualización (Callback)
Consulte también
2.2.10.7 DMStartVarUpdateExStr (RT Professional)
Declaración
BOOL DMStartVarUpdateExStr (
DWORD dwTAID,
DWORD dwFlags,
LPVARIANT lpvCookie,
DWORD dwCycle,
DM_NOTIFY_VARIABLEEX_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
Descripción

Parámetro
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
"Ciclo de usuario 1" (p. ej., 2000) Índice: 11


lpfnVariable
Puntero a la función Callback "DM_NOTIFY_VARIABLEEX_PROC" para transferir datos a
través del administrador de datos.
Con "lpfnVariable" == "NULL", la actualización en la memoria imagen de proceso del
administrador de datos se ejecuta al menos en el ciclo solicitado siempre que sea posible
físicamente en función de la carga momentánea del sistema, el rendimiento del equipo, el
medio de transmisión, etc. No obstante, la determinación del correspondiente valor debe
efectuarse 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);
}
2.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ámetro
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 230) 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
Observación
Nota
WinCC.

Archivos necesarios
dmclient.h
DMGetValueWaitEx (Página 357) Determinar los valores de las variables con actua‐
lización
DMStartVarUpdateEx (Página 461) Definir variables de actualización
Consulte también
2.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ámetro
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 513)"TESTCDoc.cpp"
Consulte también
OnTestVariablenStopallupdates (Página 513)
2.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ámetro
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 513)"TESTCDoc.cpp"
Consulte también
OnTestVariablenStopvarupdate (Página 513)
2.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ámetro
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 455) Continuar la actualización de variables
Ejemplos
OnTestVariablenSuspendvarupdate (Página 514)"TESTCDoc.cpp"

Consulte también
OnTestVariablenSuspendvarupdate (Página 514)

2.2.11 Ejemplos (RT Professional)
2.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 286)
DMGetConnectionState (Página 298)

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

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

2.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 440)
DM_ENUM_TYPES_PROC (Página 442)

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

2.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
2.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"));
}
}
2.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
2.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) );
//--------------------------------------------------
// Inicialización del filtro //
//--------------------------------------------------
// //
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

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

2.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( "equipo : %s, tipo : %s, ubicación : %s" ),
dmMachineTable.tm[i].szMachineName,
dmMachineTable.tm[i].fServer ? _T( "Server" ) : _T( "Cliente o ES" ),
dmMachineTable.tm[i].fLocal ? _T( "local" ) : _T( "remote" ));
PutStr( strData);
}
}
}
Consulte también
2.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

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

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

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

2.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 449)
2.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 290)
2.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

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

2.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 ):\tValor = %u"),
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal);
break;
case DM_VARTYPE_SBYTE:

strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tValor = %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 ):\tValor = %f"),
lpdmvus2->dmValue.fltVal);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tValor = %f"),
lpdmvus2->dmValue.dblVal);
break;
case DM_VARTYPE_TEXT_8:
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tValor = %s"),
lpdmvus2->dmValue.bstrVal);
break;
/*
strData.Format(_T("GetValue: Variable: %s\t( ID = %d ):\tValor = %s"),
lpdmvus2->dmValue.bstrVal);
break;
*/
default:

strData.Format(_T("Tipo de variable desconocido"));

}
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

2.2.11.22 OnTestVariablenGetvaluewait (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenGetvaluewait (MCP)}
//{{FUNCTION}DMGetValueWait (MCP)}
//{{FUNCTION}(END)}
//-----< Notification-Callback para 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 ):\tValor = TRUE,
Estado=%04x"),
lpdmvus2->dwState);
}
else
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = FALSE,
Estado=%04x"),
lpdmvus2->dwState);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %u, Estado=
%04x"),
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SBYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %d, Estado=
%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 ):\tValor = %f, Estado=
%04x"),
lpdmvus2->dmValue.fltVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %f, Estado=
%04x"),
lpdmvus2->dmValue.dblVal,
lpdmvus2->dwState);
break;
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %s, Estado=
%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:Dato sin formato\nValues:%02x %02x %02x %02x
\n"),
pArray[0],
pArray[1],
pArray[2],
pArray[3]);
SafeArrayUnaccessData(lpdmvus2->dmValue.parray);
}
else
{
strData.Format(_T("Error de SafeArrayAccessData\n"));
}
break;
}
default:
strData.Format(_T("GetValueWait: Tipo de variable desconocido"));
}
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

2.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: Nombre de variable: %s, VarID:%lu."),
lpdmVarKey[i].szName,
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
}
Consulte también
DMGetVarInfo (Página 361)

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

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

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

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

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

2.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 472)
2.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 473)
2.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
2.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 293)

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

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

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

2.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 570) Mostrar sistema gráfico

PDLRT_CALLBACK (Pági‐ Función Callback de las funciones de runtime
na 571)
PDLRTClosePicture (Pági‐ Cerrar imagen
na 558)
PDLRTDisableClosePicture (Pá‐ Impedir cerrar imagen
gina 560)
PDLRTEnableClosePicture (Pá‐ Habilitar imagen para cierre
gina 562)
PDLRTGetCursorKeys (Pági‐ Consultar teclas de control del cursor
na 573)

PDLRTGetDefPropEx (Pági‐ Consultar valores predeterminados de las propiedades del objeto

na 582)
PDLRTGetPropEx (Página 584) Consultar valores predeterminados de las propiedades del objeto
PDLRTGetFocus (Página 575) Consultar foco de entrada
PDLRTGetLink (Página 592) Consultar enlace entre propiedad de objeto y variable
PDLRTGotoPicture (Página 563) Consultar memoria de imágenes
PDLRTInquireFreeArea (Pági‐ Determinar área libre de una ventana
na 565)
PDLRTOpenPicture (Pági‐ Cambio de imagen raíz en runtime
na 566)
PDLRTPictureNavigation (Pági‐ Activar y desactivar navegación por imágenes
na 569)
PDLRTSetCursorKeys (Pági‐ Definir teclas de control del cursor
na 577)
PDLRTSetFocus (Página 579) Definir foco de entrada
PDLRTSetLink (Página 594) Definir enlace entre propiedad de objeto y variable
PDLRTSetMultiLink (Pági‐ Definir enlace entre propiedad de objeto y variable (varias variables)
na 596)
PDLRTSetPropEx (Página 587) Definir propiedad del objeto
Sinopsis
FOCUSINFO (Página 558) Datos de foco de entrada

LINKINFO (Página 554) Enlaces de propiedades de objetos y variables
MULTILINK (Página 556) Enlaces de propiedades de objetos y variables
MULTILINKINFO (Pági‐ Enlaces de propiedades de objetos y variables
na 557)
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
2.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
2.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
2.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,
ble Lines neas visibles
"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
2.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.
2.3.2.1 LINKINFO (RT Professional)
Declaración
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Miembros
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.
"En caso de modificación" Índice: 0

"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 592) Consultar enlace entre propiedad de objeto y variable

Consulte también
PDLRTGetLink (Página 592)
PDLRTSetLink (Página 594)

2.3.2.2 MULTILINK (RT Professional)
Declaración
typedef struct {
DWORD wArraySize;
LPMULTILINKINFO pLinkArray;
}
MULTILINK;
Miembros
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 557)
con información sobre el enlace entre una propiedad de objeto y una variable.
Archivos necesarios
pdlrtapi.h
Funciones API
PDLRTSetMultiLink (Página 596) Definir enlace entre propiedad de objeto y variable (varias va‐
riables)
Consulte también
PDLRTSetMultiLink (Página 596)
MULTILINKINFO (Página 557)

2.3.2.3 MULTILINKINFO (RT Professional)
Declaración
typedef struct {
char* pszObjectName,
char* pszPropertyName,
LINKTYPE LinkType;
DWORD dwCycle;
char* pszLinkName;
}
MULTILINKINFO;
Miembros
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.
"En caso de modificación" Índice: 0

"250 ms" Índice: 1
: :
pszLinkName
Puntero al nombre de la conexión
Observaciones
La estructura MULTILINKINFO forma parte de la estructura MULTILINK (Página 556).
Archivos necesarios
pdlrtapi.h

Consulte también
MULTILINK (Página 556)
2.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;
Miembros
szPicture
Nombre de imagen
szObject
Nombre de objeto
Funciones API
Consulte también
PDLRTGetFocus (Página 575)
2.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ámetro
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 571) Función Callback de las funciones de runtime
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
2.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ámetro
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

2.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ámetro
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
2.3.3.4 PDLRTGotoPicture (RT Professional)
Utilización
Carga la imagen indicada.
Declaración
BOOL PDLRTGotoPicture (
PDLRTGotoPict nextPict,

Parámetro
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 569)
Consulte también
PDLRTPictureNavigation (Página 569)

2.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ámetro
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
2.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ámetro
adrMode
lpszWName
El parámetro debe proporcionarse actualmente con el nombre de la imagen.
lpszPictureFileName
El parámetro debe proporcionarse actualmente con 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
2.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ámetro
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 563) Cargar la imagen especificada
Consulte también
PDLRTGotoPicture (Página 563)
2.3.3.8 PDLRTShowApp (RT Professional)
Utilización
Con la función, la ventana de runtime puesta en segundo plano pasa a la superficie del
escritorio.
Declaración
BOOL PDLRTShowApp (
PDLRT_CALLBACK pfn,
LPVOID pvUser,
Parámetro
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 571) Función Callback
Consulte también
2.3.3.9 PDLRT_CALLBACK (RT Professional)
Descripción
Si su aplicación en runtime debe ser informada asíncronamente de la ejecución de funciones
AP, deberá poner a disposición 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ámetro
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 riesgo de que la función asíncrona escriba datos en el puntero
de datos que ya no es válido, si el procesamiento que llama ya ha finalizado o ha dejado el
á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 558)
PDLRTDisableClosePicture (Página 560)
PDLRTEnableClosePicture (Página 562)

PDLRTInquireFreeArea (Página 565)

PDLRTOpenPicture (Página 566)
PDLRTShowApp (Página 570)
PDLRTSetPropEx (Página 587)
PDLRTGetPropEx (Página 584)
PDLRTGetDefPropEx (Página 582)
PDLRTSetFocus (Página 579)
PDLRTSetCursorKeys (Página 577)
PDLRTGetCursorKeys (Página 573)
2.3.4 Funciones para influir en el cursor de runtime (RT Professional)
2.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ámetro
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ágina 577) Definir teclas de control del cursor

Consulte también
PDLRTSetCursorKeys (Página 577)
2.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ámetro
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 558), en la que se depositan 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 579) Definir foco de entrada

Consulte también
FOCUSINFO (Página 558)
PDLRTSetFocus (Página 579)
2.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ámetro
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ágina 573) Consultar teclas de control del cursor

Consulte también
PDLRTGetCursorKeys (Página 573)
2.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ámetro
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

2.3.5 Funciones para editar propiedades de objeto (RT Professional)
2.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ámetro
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
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento
definidoconadrMode .

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
por NULL.
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
2.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ámetro
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
por NULL.
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 587) Ajustar propiedad

Consulte también
PDLRTSetPropEx (Página 587)
2.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 584) 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 584)

2.3.6 Funciones para editar dinámicas (RT Professional)
2.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ámetro
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 554), 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 dinámicas
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll


Consulte también
LINKINFO (Página 554)
2.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ámetro
adrMode
que editar.


lpszPictureName
lpszObjectName
con adrMode.

lpszPropName
Puntero al nombre de la propiedad del objeto.
pLink
Puntero a la estructura LINKINFO (Página 554), 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_LINK_NOT_SET La propiedad no pudo conectarse
Archivos necesarios
pdlrtapi.h

pdlrt_s.lib
pdlrtapi.dll
PDLRTGetLink (Página 592) Determinar enlace entre propiedad de objeto y variable

PDLRTSetMultiLink (Página 596) Definir enlace entre propiedad de objeto y variable (varias va‐
riables)
Consulte también
LINKINFO (Página 554)
2.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ámetro
adrMode
que editar.



lpszPictureName
pMultiLink
Puntero a la estructura MULTILINK (Página 556), 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 sólo un enlace, se proporciona FALSE.
FALSE
Error.
Mensajes de error

PDLRT_LINK_NOT_SET La propiedad no pudo conectarse
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib

2.4 Funciones del scripting (RT Professional)
pdlrtapi.dll

Consulte también
MULTILINK (Página 556)
Sinopsis
AP_RT_PROC (Página 614) Función de notificación de las funciones runtime

APActive (Página 625) Activar acción
APCompile (Página 617) Compilar código fuente
APCompileEx (Página 619) Compilar código fuente
APConnect (Página 609) Dar de alta aplicación
APDisconnect (Página 611) Dar de baja aplicación
APEndAct (Página 627) Dar de baja la acción del control de acciones
APFreeResultStruct (Página 629) Habilitar memoria de resultados de acción
APInactive (Página 630) Desactivar acciones
APSetLanguage (Página 613) Definir el idioma de los textos de error
APStart (Página 632) Iniciar acción
APTransact (Página 634) Dar de alta acciones para su ejecución
GSCGenCompile (Página 622) Compilar acción
GSCGenCompileUserFunctions (Pá‐ Compilar funciones de usuario
gina 623)
GSCGenGetActionStream (Pági‐ Determinar stream de acción
na 624)

Sinopsis
AP_ACT_KEY (Página 603) Identificación de acción

AP_ACT_RESULT_STRUCT (Página 605) Resultado de la acción
CREATE_USER_HEADER_FILE (Página 606) Crear archivo de encabezado de funciones de
usuario
GENERATE_COMPILE (Página 607) Crear acción
GET_ACTION_STREAM (Página 608) 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
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"
2.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 un 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 625)
APInactive (Página 630)
APStart (Página 632)
APTransact (Página 634)
2.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
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
dwreserved
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Archivos requeridos
ap_def.h
Funciones API
APFreeResultStruct (Página 629) Habilitar memoria de resultados de acción

Consulte también
APFreeResultStruct (Página 629)
2.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 en el directorio de inicio, a partir del cual se buscan las funciones de usuario con
terminación "\"
pszHeaderFileName
Puntero en el nombre del Header-File.

bShowDlg
Mostrar diálogo con indicación de progreso
pszWindowText
Puntero en la rotulación del diálogo. Default:BROWSER
Archivos requeridos
capigsc.h
Funciones API
GSCGenCompileUserFunctions (Página 623) Compilar funciones de usuario
Consulte también
GSCGenCompileUserFunctions (Página 623)
2.4.2.4 GENERATE_COMPILE (RT Professional)
Declaración
typedef struct {
char* pszProjectName;
LPACTION pAction;
} GENERATE_COMPILE ;
Members
pszProjectName
Puntero en el nombre del proyecto
pAction
Puntero en stream de acción válido con source code
Archivos requeridos
capigsc.h
GSCGenCompile (Página 622) Compilar acción

Consulte también
GSCGenCompile (Página 622)
2.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 requeridos
capigsc.h
Funciones API
GSCGenGetActionStream (Página 624) Determinar stream de acción
Consulte también
GSCGenGetActionStream (Página 624)

2.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ámetro
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.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el 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
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
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 Asignación incorrecta 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 requeridos
ap_def.h
apcli_S.lib
apclient.dll

APDisconnect (Página 611) Finalizar la conexión con el controlador de la ac‐
ción
APTransact (Página 634) Registrar acción para su ejecución
AP_RT_PROC (Página 614) Función Callback

Ejemplos
Establish connection to script programming (Página 636)"AP01.cpp"
Consulte también
AP_RT_PROC (Página 614)
APDisconnect (Página 611)
Establish connection to script programming (Página 636)
2.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ámetro
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.
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
Observación
Nota
No se debe utilizar la llamada 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 Asignación incorrecta 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 requeridos
ap_def.h
apcli_S.lib
apclient.dll

APConnect (Página 609) Establecer la conexión con el controlador de la

acción
APTransact (Página 634) Registrar acción para su ejecución
Ejemplos
Consulte también
2.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ámetro
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 requeridos
ap_def.h
apcli_S.lib
apclient.dll
Consulte también
2.4.3.4 AP_RT_PROC (RT Professional)
Descripción
Si se debe informar asíncronamente a su aplicación en Runtime acerca de la ejecución de
funciones AP, debe preparar 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ámetro
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

Observación
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 609) Dar de alta aplicación
APDisconnect (Página 611) Dar de baja aplicación
APEndAct (Página 627) Dar de baja la acción del control de acciones
Ejemplos
Consulte también
APEndAct (Página 627)


2.4.4 Funciones para editar Source Code (RT Professional)
2.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ámetro
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 en el código fuente a 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
pError
Valor de retorno
TRUE
Código fuente compilado con éxito
FALSE
Error
Archivos requeridos
ap_def.h
apcli_S.lib

apclient.dll
APCompileEx (Página 619) Compilar código fuente

APFreePCode Habilitar memoria de código fuente
Consulte también
APCompileEx (Página 619)
2.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ámetro
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
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 617) Compilar código fuente

APFreePCode Habilitar memoria de código fuente
Consulte también
APCompile (Página 617)

2.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ámetro
lpGenCompile
Puntero en la estructura GENERATE_COMPILE (Página 607).
hWndParent
Handle en la ventana donde se ejecutarán las salidas de estado.
plErrors
Puntero en la variable para retorno del número de errores
plWarnings
Puntero en la variable para retorno del número de advertencias
lpfnAllocAppMem
Puntero en una función con la cual se asigna memoria en la aplicación llamante.
lpdmError
Valor de retorno
Puntero en el 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.
Observación
La acción compilada está disponible después de iniciar nuevamente Runtime.

Archivos requeridos
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
GENERATE_COMPILE (Página 607)
2.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ámetro
pGenCUHF
Puntero en la estructura CREATE_USER_HEADER_FILE (Página 606).
hWndParent
Handle en la ventana donde se ejecutarán las salidas de estado.
lpdmError
Valor de retorno
TRUE
Funciones de usuario compiladas
FALSE
Error

Observación
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 requeridos
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
CREATE_USER_HEADER_FILE (Página 606)
2.4.5 Funciones para editar acciones (RT Professional)
2.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ámetro
pGenGAS
Puntero en una estructura tipo GET_ACTION_STREAM (Página 608), a través de la cual se
especifica la función o acción.
lpfnAllocAppMem
Puntero en una función con la cual se asigna memoria en la aplicación llamante.

lpdmError
Valor de retorno
Puntero en el stream de acción.
Archivos requeridos
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
GET_ACTION_STREAM (Página 608)
2.4.6 Funciones de la programación de acción (RT Professional)
2.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ámetro
lpapActKey
Puntero en 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 AP_ACT_KEY (Página 603).
fpAppBack
Su función Callback para la llamada asíncrona. Cuando se utiliza con NULL, la llamada se
ejecuta de forma sincrónica.
pdwOrderId
lpvUser
pError
Valor de retorno
TRUE
Acción activada.

FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll

APTransact (Página 634) Registrar una acción para su ejecución
Consulte también
AP_ACT_KEY (Página 603)
2.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ámetro
fpAppBack
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 requeridos
ap_def.h
apcli_S.lib
apclient.dll


Consulte también
2.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ámetro
lpvPcode
Puntero en la primera de las estructuras dwItem del tipo AP_ACT_RESULT_STRUCT
(Página 605).
dwItems
Número de estructuras AP_ACT_RESULT_STRUCT.
Valor de retorno
TRUE
Memoria habilitada.
FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll

APStart (Página 632) Ejecución de la acción iniciada
Consulte también
AP_ACT_RESULT_STRUCT (Página 605)
2.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ámetro
lpapActKey
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ


dwItems
fpAppBack
pdwOrderId
lpvUser
pError
Valor de retorno
TRUE
Acción desactivada.
FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
APActive (Página 625) Activar acciones


Consulte también
2.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ámetro
lpapActKey
$3B$&7B.(<
$3B$&7B.(<

$3B$&7B.(<Q
$FWLRQVWUHDP

$FWLRQVWUHDP
$FWLRQVWUHDPQ


dwItems
fpAppBack
fAppResult
Su función Callback para resultados de acción de ejecución cíclica. En la función Callback se
suministran las estructuras del tipo AP_ACT_RESULT_STRUCT (Página 605). En una
llamada sincrónica, lpapars se ocupa con el resultado.
pdwOrderId
lpapars
Puntero en el resultado de acción en una llamada sincrónica. Conforme al número de acciones
iniciadas se devuelve un Array de estructuras del tipo AP_ACT_RESULT_STRUCT
(Página 605). 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.

Observación
Con APStart se pueden iniciar únicamente acciones no desactivadas previamente con
APInactive.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
APFreeResultStruct (Página 629) Habilitar memoria

Consulte también
APFreeResultStruct (Página 629)
AP_ACT_RESULT_STRUCT (Página 605)
2.4.6.6 APTransact (RT Professional)
Utilización
Declaración
Parámetro
xxx
xxx

lpdmError
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 627)

2.4.7.1 Establish connection to script programming (RT Professional)
Sinopsis
//
====================================================================
=
// 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"),
Error.dwError1, Error.dwError2,
Error.szErrorText);
}
else
{
_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"),
Error.dwError1, Error.dwError2,
Error.szErrorText);
}
else
{
_T("APDisconnect"));

2.5 Funciones de la administración de usuarios (RT Professional)
}
ODKTrace(szText);
}
//
--------------------------------------------------------------------
Consulte también
Sinopsis
PWGEN_ENUM_GROUPS_CALLBACK (Pági‐ Listar grupos de usuarios (Callback)

na 660)
PWGEN_ENUM_LEVELS_CALLBACK (Pági‐ Listar niveles de autorización (Callback)
na 666)
PWGEN_ENUM_USERS_CALLBACK (Pági‐ Listar usuarios (Callback)
na 655)
PWGENAddGroup (Página 657) Crear un grupo de usuarios
PWGENAddPermLevel (Página 661) Crear nivel de autorización
PWGENAddUser (Página 646) Crear un usuario
PWGENAddUserEx (Página 648) Crear un usuario
PWGENChangePassword (Página 650) Cambiar la contraseña
PWGENCheckPermission (Página 662) Comprobar las autorizaciones de un usuario
PWGENCheckUser (Página 651) Comprobar usuario
PWGENConnect (Página 643) Establecer conexión con la base de datos
PWGENDeletePermLevel (Página 664) Borrar nivel de autorización
PWGENDeleteUser (Página 652) Borrar usuario o grupo de usuarios
PWGENDisconnect (Página 645) Deshacer conexión con la base de datos
PWGENEnumGroups (Página 658) Listar grupos de usuarios
PWGENEnumPermLevels (Página 665) Listar niveles de autorización
PWGENEnumUsers (Página 654) Listar usuarios

PWGENReadUserPerm (Página 668) Determinar autorizaciones de usuario

PWRTCheckPermission (Página 669) Comprobar autorización de área
PWRTCheckPermissionOnPicture (Página 670) Comprobar nivel de autorización
PWRTGetCurrentUser (Página 674) Determinar nombre de usuario
PWRTGetLoginPriority (Página 675) GetLoginPriority
PWRTIsLoggedInByCard (Página 676) Inicio de sesión con tarjeta inteligente
PWRTLogin (Página 677) Inicio de sesión con diálogo
PWRTLogout (Página 679) Cerrar sesión
PWRTLogoutEx (Página 680) Cerrar sesión
PWRTPermissionLevelDialog (Página 671) Seleccionar nivel de autorización
PWRTPermissionLevelDialogEx (Página 672) Seleccionar nivel de autorización
PWRTPermissionToString (Página 673) Determinar descripción textual del nivel de autori‐
zación
PWRTSilentLogin (Página 681) Inicio de sesión
PWRTSilentLoginEx (Página 682) Inicio de sesión
Sinopsis
PWGEN_GROUPINFO (Página 641) Información de grupos de usuarios

PWGEN_LEVELINFO (Página 642) Información de niveles de autorización
PWGEN_USERINFO (Página 642) 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
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
PWGEN_API_EXIST_PASSWORD 0x10000072L

Tamaños de cadena y matriz
MAX_LOGIN 25
MAX_PASS 25
MAX_LEVEL 70
2.5.2.1 PWGEN_GROUPINFO (RT Professional)
Declaración
typedef struct {
TCHAR name[MAX_LOGIN];
int expiration_time;
}
PWGEN_GROUPINFO;
Miembros
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 660)
Consulte también
PWGEN_ENUM_GROUPS_CALLBACK (Página 660)

2.5.2.2 PWGEN_LEVELINFO (RT Professional)
Declaración
typedef struct {
int levelNumber;
DWORD dwTextID;
}
PWGEN_LEVELINFO;
Miembros
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 666)
Consulte también
PWGEN_ENUM_LEVELS_CALLBACK (Página 666)
2.5.2.3 PWGEN_USERINFO (RT Professional)
Declaración
typedef struct {
TCHAR login[MAX_LOGIN];
TCHAR group[MAX_LOGIN];
int expiration_time;
}
PWGEN_USERINFO;

Miembros
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 655)
Consulte también
PWGEN_ENUM_USERS_CALLBACK (Página 655)
2.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ámetro
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
de error, el sistema escribe la información de error en esta estructura.
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
Funciones similares
PWGENDisconnect (Página 645) Deshacer conexión con la base de datos

Consulte también
PWGENDisconnect (Página 645)
2.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ámetro
err
Valor de retorno
TRUE
Conexión deshecha
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
Funciones similares
PWGENConnect (Página 643) Registrar conexión con la base de datos.
Consulte también
PWGENConnect (Página 643)
2.5.4 Funciones para editar usuarios (RT Professional)
2.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ámetro
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

Funciones similares
PWGENAddUserEx (Página 648) Crear un usuario
Consulte también
PWGENAddUserEx (Página 648)
2.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ámetro
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
Funciones similares
PWGENAddUser (Página 646) Crear un usuario
Consulte también
PWGENAddUser (Página 646)

2.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ámetro
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
2.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ámetro
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
2.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ámetro
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
2.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ámetro
dwCount
Puntero en el lugar de memoria en el 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
Funciones similares
PWGEN_ENUM_USERS_CALLBACK (Pági‐ Listar usuarios (Callback)

na 655)
Consulte también
PWGEN_ENUM_USERS_CALLBACK (Página 655)
2.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ámetro
lpUserInfo
Puntero hacia una estructura del tipo PWGEN_USERINFO (Página 642) 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 654) Listar usuarios
Consulte también
PWGENEnumUsers (Página 654)
PWGEN_USERINFO (Página 642)

2.5.5 Funciones para editar grupos de usuarios (RT Professional)
2.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ámetro
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
Funciones similares
PWGENDeleteUser (Página 652) Crear un usuario
Consulte también
PWGENDeleteUser (Página 652)
2.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ámetro
dwCount
Puntero en el lugar de memoria en el 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
Funciones similares
PWGEN_ENUM_GROUPS_CALLBACK (Pági‐ Listar grupos de usuarios (Callback)

na 660)

Consulte también
PWGEN_ENUM_GROUPS_CALLBACK (Página 660)
2.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ámetro
lpUserInfo
Puntero hacia una estructura del tipo PWGEN_GROUPINFO (Página 641) con los datos de
un grupo de usuarios.
lpUser
función Callback.
Valor de retorno
TRUE
Listado de los grupos de usuarios
FALSE
Error
Nota

Archivos necesarios
usegenap.h
PWGENEnumGroups (Página 658) Listar grupos de usuarios
Consulte también
PWGENEnumGroups (Página 658)
PWGEN_GROUPINFO (Página 641)
2.5.6 Funciones para editar autorizaciones (RT Professional)
2.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ámetro
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
2.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ámetro
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
2.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ámetro
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
2.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ámetro
dwCount
Puntero en el lugar 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
Funciones similares
PWGEN_ENUM_LEVELS_CALLBACK (Pági‐ Listar autorizaciones (Callback)

na 666)
Consulte también
PWGEN_ENUM_LEVELS_CALLBACK (Página 666)
2.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ámetro
lpLevelInfo
Puntero hacia una estructura del tipo PWGEN_LEVELINFO (Página 642) 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 665) Listar niveles de autorización

Consulte también
PWGENEnumPermLevels (Página 665)
PWGEN_LEVELINFO (Página 642)
2.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 autorización,
LPDWORD areaperms )
Parámetro
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
Errores
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
2.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ámetro
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 684)"PWRTBunch.cpp"
Consulte también
PWRT check permission (Página 684)
2.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ámetro
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 685)"PWRTBunch.cpp"
Consulte también
Checks admission of a certain level for a picture (Página 685)
2.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ámetro
Ninguno

Funciones similares
PWRTPermissionLevelDialogEx (Página 672) Seleccionar autorización a través del diálogo
Ejemplos
Permission level query through a dialog with specifying a possible error
(Página 687)"PWRTBunch.cpp"
Consulte también
Permission level query through a dialog with specifying a possible error (Página 687)
PWRTPermissionLevelDialogEx (Página 672)
PWRTPermissionToString (Página 673)
2.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ámetro
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
Permission level query through a dialog with specifying a possible error
(Página 687)"PWRTBunch.cpp"
Consulte también
PWRTPermissionLevelDialog (Página 671)
Permission level query through a dialog with specifying a possible error (Página 687)
2.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 671) Seleccionar nivel de autorización
Ejemplos
Gets a string associated with the permission number (Página 686). "PWRTBunch.cpp"
Consulte también
Gets a string associated with the permission number (Página 686)
2.5.7 Funciones para iniciar y cerrar sesión (RT Professional)
2.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ámetro
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 688)"PWRTBunch.cpp"
Consulte también
Return the name of the current user (Página 688)
2.5.7.2 PWRTGetLoginPriority (RT Professional)
Descripción
Comprobación del inicio de sesión sin diálogo.
Declaración
LONG PWRTGetLoginPriority (
)

Parámetro
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 689)"PWRTBunch.cpp"
Consulte también
Queries the current login priority (Página 689)
2.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ámetro
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 689)"PWRTBunch.cpp"
Consulte también
Checks for the user has been logged on by card (Página 689)
2.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ámetro
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
Funciones similares
PWRTSilentLogin (Página 681) Login
Ejemplos
PWRT login - dialog provided by WinCC itself (Página 690)"PWRTBunch.cpp"
Consulte también
PWRTSilentLogin (Página 681)
PWRT login - dialog provided by WinCC itself (Página 690)
PWRTSilentLoginEx (Página 682)

2.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ámetro
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
Funciones similares
PWRTLogoutEx (Página 680) Cerrar sesión de usuario con nivel de prioridad
Ejemplos
PWRT logout (Página 691)"PWRTBunch.cpp"
Consulte también
PWRT logout (Página 691)
PWRTLogoutEx (Página 680)

2.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ámetro
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
Funciones similares
PWRTLogout (Página 679) Cerrar una sesión de usuario
Ejemplos
Silent logout with priority level (Página 692)"PWRTBunch.cpp"

Consulte también
Silent logout with priority level (Página 692)
PWRTLogout (Página 679)
2.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ámetro
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
Funciones similares

PWRTSilentLoginEx (Página 682) Inicio de sesión con nivel de prioridad
Ejemplos
Login without using a dialog (Página 693)"PWRTBunch.cpp"
Consulte también
PWRTLogin (Página 677)
Login without using a dialog (Página 693)
2.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ámetro
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
Funciones similares

PWRTSilentLogin (Página 681) Inicio de sesión sin diálogo
Ejemplos
Silent login with priority level (Página 694)"PWRTBunch.cpp"
Consulte también
Silent login with priority level (Página 694)

2.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 669)
2.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 670)
2.5.8.3 Gets a string associated with the permission number (RT Professional)
Sinopsis
//{{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 673)

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

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

2.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 675)
2.5.8.7 Checks for the user has been logged on by card (RT Professional)
Sinopsis
//{{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 676)
2.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
2.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 679)

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

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

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

2.6 Funciones del sistema de texto (RT Professional)
Declaración
TXT_ENUM_INFOTEXTS_PROC (Página 707) Listar textos informativos (Callback)

TXT_ENUM_LANGUAGES_PROC (Página 715) Listar idiomas configurados (Callback)
TXTCloseProject (Página 698) Cerrar librería de textos
TXTEnumInfoText (Página 705) Listar textos informativos
TXTEnumLanguages (Página 713) Listar idiomas configurados
TXTGetFont (Página 716) Determinar el juego de caracteres de un idioma
TXTGetMaxTextID (Página 700) Determinar ID de texto (máximo)
TXTOpenProject (Página 701) Abrir librería de textos
TXTRTConnect (Página 703) Mantener la conexión con el servidor de textos
TXTRTDisconnect (Página 704) Autorizar la conexión con el servidor de textos
TXTRTGetInfoText (Página 710) Leer textos informativos
TXTRTGetInfoTextMC (Página 711) Leer textos informativos del servidor de textos
TXTRTGetLanguageID (Página 719) Determinar idiomas activados
TXTRTSetLanguage (Página 721) Cambio de idioma de los textos de mensajes de
error
TXTShowLanguagesDialog (Página 718) Mostrar idiomas (instalados)
TXTUpdateRuntime (Página 708) 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
2.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
2.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ámetro
lpszProjectFile
Puntero en el 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
Funciones similares
TXTOpenProject (Página 701) Abre la librería de textos
Ejemplos
Obtener texto de ayuda (Página 722)"TX01.cpp"
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXTOpenProject (Página 701)
Obtener texto de ayuda (Página 722)
Enumerar textos de ayuda (Página 724)
2.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ámetro
lplMaxTextID
Puntero en el 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
2.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ámetro
lpszProjectFile
lpszDSNName
Puntero en el 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
Funciones similares
TXTCloseProject (Página 698) Cierra la librería de textos
Ejemplos
Obtener texto de ayuda (Página 722)"TX01.cpp"

Consulte también
TXTCloseProject (Página 698)
2.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ámetro
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

Funciones similares
TXTRTDisconnect (Página 704) Autorizar la conexión con el servidor de texto
Consulte también
TXTRTDisconnect (Página 704)
2.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ámetro
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
Funciones similares
TXTRTConnect (Página 703) Mantener la conexión con el servidor de texto
Consulte también
TXTRTConnect (Página 703)
2.6.3 Funciones para la edición de textos de ayuda (RT Professional)
2.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ámetro
lpszProjectFile
dwLocale
Código del idioma cuyos textos informativos deben enumerarse.

lpdwItems
Puntero en una variable de palabra doble de la aplicación que contiene la cantidad de textos
informativos enumerados después de la llamada.
lpszFilter
Puntero en 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

Funciones similares
TXT_ENUM_INFOTEXTS_PROC (Página 707) Listar textos informativos (Callback)
Ejemplos
Consulte también
TXT_ENUM_INFOTEXTS_PROC (Página 707)
2.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ámetro
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
Observación
Nota
● Funciones en las que se accede a un bucle de mensaje, por ejemplo: GetMessage
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
TXTEnumInfoText (Página 705) Listar textos informativos
Ejemplos
Consulte también
TXTEnumInfoText (Página 705)
2.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ámetro
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

2.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ámetro
dwTextID
ID del texto que hay que leer
lpszBuffer
Puntero en un búfer en el que se debe almacenar el texto informativo.
pdwSize
Puntero en el DWORD que contiene el tamaño del búfer
lpdmError
Valor de retorno
TRUE
Texto informativo determinado
FALSE
Error

Observación
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 requeridos
text_rt.h
text_rt.lib
text_rt.dll
AUTOHOTSPOT Leer tooltips del servidor de textos
Ejemplos
Obtener texto de ayuda (Página 722) "TX01.cpp"
Consulte también
2.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 en un búfer en el que se debe almacenar el texto informativo.
pdwSize
Puntero en el DWORD que contiene el tamaño del búfer
lpszServer
Puntero en el nombre simbólico del servidor de texto (sin separadores de servidor :: )
lpdmError
Valor de retorno
TRUE
Texto informativo determinado
FALSE
Error
Observación
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 requeridos
text_rt.h
text_rt.lib
text_rt.dll
AUTOHOTSPOT Leer tooltips
Consulte también
2.6.4 Funciones para la edición de idiomas (RT Professional)
2.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ámetro
lpszProjectFile
lpdwItems
Puntero en 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
Funciones similares
TXT_ENUM_LANGUAGES_PROC (Página 715) Listar idiomas configurados (Callback)

Ejemplos
Consulte también
TXT_ENUM_LANGUAGES_PROC (Página 715)
2.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ámetro
dwLocaleID
Código de idioma
lpszName
Puntero en el nombre del idioma.
lpvUser
función Callback.
Valor de retorno
TRUE
FALSE

Observación
Nota
● Funciones en las que se accede a un bucle de mensaje, por ejemplo: GetMessage
Archivos necesarios
text_cs.h
TXTEnumLanguages (Página 713) Listar idiomas configurados
Ejemplos
Consulte también
TXTEnumLanguages (Página 713)
2.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ámetro
lpszProjectFile
dwLocale
Código de los idiomas de los que se debe tomar la fuente.
lplf
Puntero en 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

2.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ámetro
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 en el código del idioma que se va a instalar.

lplf
Puntero en 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
2.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ámetro
lpchLanguageID
Puntero en 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

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

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

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

2.7 Funciones del sistema de informes (RT Professional)
Consulte también
TXTEnumInfoText (Página 705)
TXT_ENUM_INFOTEXTS_PROC (Página 707)
TXT_ENUM_LANGUAGES_PROC (Página 715)
TXTEnumLanguages (Página 713)
Sinopsis
RPJAttach (Página 739) Establecer conexión

RPJCallJobMethod (Página 762) Llamar método de trabajo de impresión
RPJCreateJob (Página 749) Crear trabajo de impresión
RPJCreatePropertyHandle (Página 752) Generar handle de una propiedad de trabajo de
impresión
RPJDeleteJob (Página 751) Borrar trabajo de impresión
RPJDeletePropertyHandle (Página 753) Borrar handle de una propiedad de trabajo de im‐
presión
RPJDetach (Página 740) Deshacer conexión
RPJGetJobMethodAt (Página 763) Determinar nombre de un método de trabajo de
impresión
RPJGetJobNameAt (Página 755) Determinar nombre de un trabajo de impresión
RPJGetJobPropertyAt (Página 765) Determinar nombre de propiedades de trabajo de
impresión
RPJGetJobProps (Página 767) Determinar propiedades del trabajo de impresión
RPJGetNumJobMethods (Página 764) Determinar cantidad de un método de trabajo de
impresión
RPJGetNumJobProperties (Página 768) Determinar cantidad de propiedades de trabajo de
impresión
RPJGetNumJobs (Página 756) Determinar cantidad de trabajos de impresión
RPJGetNumProjectProperties (Página 742) Determinar el número de propiedades del proyecto
RPJGetProjectPropertyAt (Página 743) Determinar nombre de propiedad y tipo en el pro‐
yecto por índice
RPJGetProjectProperty (Página 744) Determinar el valor de la propiedad en el proyecto

RPJGetProperty (Página 769) Determinar propiedad de trabajo de impresión

RPJJobLock (Página 757) Bloquear trabajo de impresión para otros accesos
RPJJobUnlockAll (Página 760) Anular todos los bloqueos del trabajo de impresión
RPJJobUnlock (Página 759) Anular un bloqueo del trabajo de impresión
RPJMemFree (Página 741) Habilitar memoria
RPJProjectLock (Página 745) Bloquear el acceso a la lista de trabajos de impre‐
sión del proyecto
RPJProjectUnlockAll (Página 748) Anular todos los bloqueos de la lista de trabajos
de impresión del proyecto
RPJProjectUnlock (Página 747) Anular un bloqueo de la lista de trabajos de impre‐
sión del proyecto
RPJPropertyClear (Página 772) Borrar handle de una propiedad de trabajo de im‐
presión
RPJSetProperty (Página 774) 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
2.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
2.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");
}
}

2.7.2 Funciones para establecer una conexión (RT Professional)
2.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ámetro
pcmnerror
Valor de retorno
TRUE
Conexión establecida.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
RPJDetach (Página 740) Deshacer conexión
Consulte también
RPJDetach (Página 740)

2.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ámetro
pcmnerror
Valor de retorno
TRUE
La conexión se ha deshecho de nuevo.
FALSE
Errores
Comentario
Nota
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
RPJAttach (Página 739) Establecer conexión

Consulte también
RPJAttach (Página 739)
2.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ámetro
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
2.7.3 Funciones para editar propiedades del proyecto (RT Professional)
2.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ámetro
pszReserved
pdwNumProperties
Puntero en 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
2.7.3.2 RPJGetProjectPropertyAt (RT Professional)
Descripción
La función determina el nombre y tipo de una propiedad con el índice del proyecto.
Declaración
BOOL RPJGetProjectPropertyAt (
LPCSTR pszReserved,
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPrpType,
Parámetro
pszReserved
dwPropIndex
Índice de las propiedades del proyecto desde el que se ha de devolver la información.
pszBuffer
Puntero en 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 en 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
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
2.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ámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos 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
2.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ámetro
pszProjectName
y la extensión.
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
Funciones similares
RPJProjectUnlock (Página 747) Eliminar un bloqueo

RPJProjectUnlockAll (Página 748) Eliminar todos los bloqueos
Consulte también
RPJProjectUnlock (Página 747)
RPJProjectUnlockAll (Página 748)
2.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ámetro
pszProjectName
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
Funciones similares
RPJProjectLock (Página 745) Crear bloqueo

RPJProjectUnlockAll (Página 748) Eliminar todos los bloqueos
Consulte también
RPJProjectLock (Página 745)
RPJProjectUnlockAll (Página 748)
2.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ámetro
pszProjectName
y 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
Funciones similares
RPJProjectLock (Página 745) Crear bloqueo

RPJProjectUnlock (Página 747) Eliminar un bloqueo
Consulte también
RPJProjectLock (Página 745)
RPJProjectUnlock (Página 747)
2.7.4 Funciones para editar trabajos de impresión (RT Professional)
2.7.4.1 RPJCreateJob (RT Professional)
Descripción
Crea un nuevo trabajo de impresión.

Declaración
BOOL RPJCreateJob (
LPCSTR pszJobName,
Parámetro
pszProjectName
y la extensión.
pszJobName
Puntero en el 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
Funciones similares
RPJDeleteJob (Página 751) Borrar trabajo de impresión
Consulte también
RPJDeleteJob (Página 751)

2.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ámetro
pszProjectName
y la extensión.
pszJobName
Puntero en el 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
Funciones similares
RPJCreateJob (Página 749) Crear trabajo de impresión

Consulte también
RPJCreateJob (Página 749)
2.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ámetro
pszProjectName
y 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

Funciones similares
RPJDeletePropertyHandle (Página 753) Borrar Handle

RPJPropertyClear (Página 772) Inicializar área de memoria
RPJGetJobProps (Página 767) Calcular propiedades de trabajo de impresión
RPJSetProperty (Página 774) Definir propiedades de trabajo de impresión
Ejemplos
Show print job preview (Página 791)"RD02.cpp"
Modify print job properties (Página 786)"RD02.cpp"
Obtener nombres de trabajo de impresión (Página 780)"RD02.cpp"
Obtener nombre de método del trabajo de impresión (Página 777)"RD02.cpp"
Obtener propiedades del trabajo de impresión (Página 783)"RD02.cpp"
Consulte también
Obtener nombre de método del trabajo de impresión (Página 777)
Obtener nombres de trabajo de impresión (Página 780)
Obtener propiedades del trabajo de impresión (Página 783)
Modify print job properties (Página 786)
Show print job preview (Página 791)
RPJDeletePropertyHandle (Página 753)
RPJGetProperty (Página 769)
RPJGetJobProps (Página 767)
RPJSetProperty (Página 774)
RPJPropertyClear (Página 772)
2.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ámetro
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
Funciones similares
RPJCreatePropertyHandle (Página 752) Crear Handle
Ejemplos

Consulte también
RPJCreatePropertyHandle (Página 752)
2.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ámetro
PszProjectName
y la extensión.
dwJobIndex
Índice del trabajo de impresión del que debe determinarse el nombre.
pszBuffer
Puntero en 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
2.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ámetro
pszProjectName
y la extensión.
pdwNumJobs
Puntero en el lugar de memoria en el 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
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
2.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ámetro
pszProjectName
y la extensión.
pszJobName
Puntero en el 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
Funciones similares
RPJJobUnlock (Página 759) Eliminar un bloqueo

RPJJobUnlockAll (Página 760) Eliminar todos los bloqueos
Consulte también
RPJJobUnlockAll (Página 760)
RPJJobUnlock (Página 759)
2.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ámetro
pszProjectName
y la extensión.
pszJobName
Puntero en el 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
Funciones similares
RPJJobLock (Página 757) Crear bloqueo

RPJJobUnlockAll (Página 760) Eliminar todos los bloqueos
Consulte también
RPJJobUnlockAll (Página 760)
RPJJobLock (Página 757)
2.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ámetro
pszProjectName
y 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
Funciones similares
RPJJobLock (Página 757) Crear bloqueo

RPJJobUnlock (Página 759) Eliminar un bloqueo

Consulte también
RPJJobUnlock (Página 759)
RPJJobLock (Página 757)
2.7.5 Funciones para editar métodos de trabajos de impresión (RT Professional)
2.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ámetro
hproperties
pszMethodName
Puntero en el 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
2.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ámetro
dwMethodIndex
Índice del método de impresión cuyo nombre se va a determinar.
pszBuffer
Puntero en 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
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Consulte también
2.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ámetro
pdwNumMethods
Puntero en un lugar de memoria en el 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
2.7.6 Funciones para editar propiedades de trabajo de impresión (RT Professional)
2.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ámetro
dwPropIndex
Índice de las propiedades de trabajo de impresión cuyo nombre debe determinarse.
pszBuffer
Puntero en el búfer que acepta 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 en un lugar de memoria en el que se almacena el tipo de propiedades 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
2.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ámetro
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
Funciones similares

Ejemplos
Consulte también
2.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ámetro
pdwNumProperties
Puntero en un lugar de memoria en el 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
2.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ámetro
hproperties
pszPropName
Puntero en el 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 en el 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 vtPropVT_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á señalar 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
Errores

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
Funciones similares

Ejemplos
Consulte también
2.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ámetro
hproperties
pcmnerror
Valor de retorno
TRUE
Memoria inicializada.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también

2.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ámetro
hproperties
Handle de las propiedades de trabajo de impresión. El Handle se crea con la función
pszPropName
Puntero en el 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 en el 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 vtPropVT_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á señalar a una estructura
SYSTEMTIME.
dwReserved

pcmnerror
Valor de retorno
TRUE
Propiedad de trabajo de impresión modificada temporalmente
FALSE
Errores
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
Funciones similares

Ejemplos
Consulte también

2.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 763)
RPJGetNumJobMethods (Página 764)

2.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 755)
RPJGetNumJobs (Página 756)

2.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 765)
RPJGetNumJobProperties (Página 768)

2.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);
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
{
_T("RPJDeletePropertyHandle")); }
ODKTrace(szText);
}

Consulte también

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

2.8 Funciones para variables y ficheros (RT Professional)
Consulte también
RPJCallJobMethod (Página 762)
Resumen
TLG_ENUM_ARCHIV_CALLBACK (Página 870) Listar ficheros (Callback)

TLG_ENUM_PROJECT_NAME_CALLBACK (Pá‐ Listar proyectos (Callback)
gina 860)
AUTOHOTSPOT Listar entradas en plantillas de curvas (Callback)
TLG_ENUM_TIME_NAME_CALLBACK (Pági‐ Listar objetos de tiempo (Callback)
na 906)
TLG_ENUM_VARIABLE_NAME_CALLBACK (Pá‐ Listar variables (Callback)
gina 863)
TLG_ENUMBACKUP_ENTRIES (Página 913) Listar copias de seguridad (Callback)
TLG_ENUMTABLES (Página 877) Listar ficheros (Callback)
TLG_ENUMTIMES_CALLBACK (Página 909) Listar objetos de tiempo (Callback)
TLG_ENUMVARIABLES (Página 866) Listar variables (Callback)
TLG_GETARCHIVDATA_CALLBACK (Pági‐ Leer datos de un fichero (Callback)
na 882)
TLGChangeLanguage (Página 852) Cambio de idioma
TLGCloseProject (Página 856) Cerrar proyecto
TLGCloseWindow (Página 896) Cerrar trabajo de impresión/diagnóstico de script
TLGConnect (Página 853) Establecer conexión con Tag Logging RT
TLGCSConnectEx (Página 849) Establecer conexión con Tag Logging CS
TLGCSConnect (Página 848) Establecer conexión con Tag Logging CS
TLGDisconnect (Página 854) Deshacer conexión con Tag Logging RT
TLGDrawCurvesInDC (Página 897) Representar curvas
TLGEnumArchives (Página 869) Listar ficheros
TLGEnumArchivsEx (Página 873) Listar ficheros
TLGEnumArchivs (Página 871) Listar ficheros
TLGEnumArchivsSel (Página 875) Listar ficheros

TLGEnumBackupEntries (Página 912) Listar copias de seguridad

TLGEnumProject (Página 859) Listar proyectos
TLGEnumTime (Página 905) Listar objetos de tiempo
TLGEnumTimes (Página 907) Listar objetos de tiempo
TLGEnumVariablesEx (Página 864) Listar variables
TLGEnumVariables (Página 861) Listar variables
TLGExport (Página 915) Trasvasar fichero
TLGFreeMemory (Página 879) Habilitar memoria
TLGGetArchivDataEx (Página 883) Leer datos de un fichero
TLGGetArchivData (Página 880) Leer datos de un fichero
TLGGetBackupSize (Página 916) Determinar el tamaño de un registro exportado
TLGGetClosestTimeEx (Página 888) Determinar el momento de archivación
TLGGetClosestTime (Página 886) Determinar el momento de archivación
TLGInsertArchivData (Página 890) Insertar datos en un fichero
TLGInsertTemplateItem (Página 899) Escribir entadas en plantillas de ventanas de cur‐
vas, escribir entradas en plantillas de ventanas de
tablas
TLGLockArchiv (Página 892) Habilitar fichero, bloquear fichero
TLGLockVariable (Página 893) Habilitar variable, bloquear variable
TLGOpenProject (Página 857) Abrir un proyecto
TLGPressToolbarButton (Página 900) Activar botones de la barra de herramientas
TLGReadArchiv (Página 895) Leer parámetros de fichero
TLGReadTime (Página 910) Determinar parámetros del objeto de tiempo
TLGReadVariable (Página 867) Determinar parámetros de las variables
TLGSetRulerWindowVisible (Página 902) Mostrar también la ventana de líneas de lectura
TLGShowWindow (Página 903) Mostrar trabajo de impresión/diagnóstico de script
Sinopsis
TLG_ARCHIV_STR (Página 808) Parámetros de fichero

TLG_ARCHIVDATARAW (Página 811) Datos de fichero
TLG_BACKUP_TABLE_INFO (Página 814) Información sobre la tabla de trasvase.
TLG_CURVESCALEX (Página 816) Escala del eje x
TLG_CURVESCALEY (Página 821) Escala del eje y
TLG_GETARCHIVDATA (Página 825) Datos de fichero de ficheros de valores de proce‐
so, datos de fichero de ficheros comprimidos
TLG_IO_BACKUP_SELECT (Página 826) Criterios de selección para funciones de copia de
seguridad
TLG_PROT_CURVE_INFOS (Página 827) Estructura de informe de curvas
TLG_TABLE_INFO (Página 830) Estructura de informe de tablas
TLG_SCAL_STR (Página 829) Valores límite de una variable
TLG_TABLESCALE (Página 831) Columna de tabla (propiedades)

TLG_TEMPLATEITEM_INFO (Página 834) Curva (propiedades) Columna de tabla (propieda‐

des)
TLG_TIME_STR (Página 836) Objeto de tiempo
TLG_TIMEDATA (Página 837) Objeto de tiempo
TLG_TPLITEM_CURVE (Página 838) Curva (propiedades)
TLG_TPLITEM_INFO (Página 839) Curva (propiedades) Columna de tabla (propieda‐
des)
TLG_TPLITEM_TABLE (Página 840) Columna de tabla (propiedades)
TLG_VAR_STR (Página 841) Variable (propiedades)
TLG_VARIABLE_INFO (Página 847) 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.

2.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 archivo
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 Archivo 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 siguientes, el cual identifica el tipo de fichero.
TLG_RECORD_TYP_CIRCULAR Fichero circular

TLG_RECORD_TYP_FOLLOW Fichero siguiente
dwFillMessage
Parámetro para ficheros circulares, siguientes y comprimidos, 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
szSendAct
szRecAct
dwRecItems
Observación
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 siguiente).
Archivos requeridos
pde_def.h
Funciones API
Consulte también
TLGReadArchiv (Página 895)

2.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
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_HARDWARE_ERROR 0x0004 Módulo de red defectuoso
DM_VARSTATE_MAX_LIMIT 0x0008 Rebase por exceso del límite superior configurado
DM_VARSTATE_MIN_LIMIT 0x0010 Rebase por defecto del límite inferior configurado
DM_VARSTATE_MAX_RANGE 0x0020 Rebase por exceso del límite de formato
DM_VARSTATE_MIN_RANGE 0x0040 Rebase por defecto del límite de formato
DM_VARSTATE_CONVERSION_ERROR 0x0080 Visualización de error de conversión, en combinación con
MAX/MIN_RANGE
DM_VARSTATE_STARTUP_VALUE 0x0100 Valor de inicialización de las variables
DM_VARSTATE_DEFAULT_VALUE 0x0200 Valor sustitutivo de las variables
DM_VARSTATE_INVALID_KEY 0x0800 Variable no encontrada o no existente
DM_VARSTATE_ACCESS_FAULT 0x1000 Acceso a variable no autorizado
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 a Profibus PA/OPC

DM_VARSTATE_SERVERDOWN Servidor down Bad, out of service, 0x1C
(0x4000)
DM_VARSTATE_HARDWARE_ERROR Módulo de red defectuoso Bad, device failure, 0x0C
(0x0004)
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 autoriza‐ Bad, configuration error, value not accep‐
(0x1000) do ted, 0x04
DM_VARSTATE_MAX_RANGE Rebase por exceso del límite Uncertain, engineering unit range violation,
(0x0020) de formato high limit activado, 0x56
DM_VARSTATE_MIN_RANGE Rebase por defecto del límite Uncertain, engineering unit range violation,
(0x0040) de formato low limit activado, 0x55
DM_VARSTATE_CONVERSION_ERROR Visualización de error de con‐ Uncertain, engineering unit range violation,
(0x0080) versión activado sin límites, 0x54
DM_VARSTATE_MAX_LIMIT Rebase por exceso del límite Proyectar sobre el Limit-Bit HIGH, 0x01
(0x0008) superior configurado vincular con operación lógica O con el es‐
tado de la variable, p.ej. "good (cascade),
ok" arroja como resultado 0xC2

Estado de variable WinCC Quality Code a Profibus PA/OPC

DM_VARSTATE_MIN_LIMIT Rebase por defecto del límite Proyectar sobre el Limit-BitLOW, 0x02
(0x0010) inferior configurado vincular con operación lógica O con el es‐
tado de la variable, p.ej. "good (cascade),
ok"arroja como resultado 0xC1
DM_VARSTATE_STARTUP_VALUE Valor de inicialización de las Uncertain, initial value, 0x4C
(0x0100) variables
DM_VARSTATE_DEFAULT_VALUE Valor sustitutivo de las varia‐ Uncertain, substitute-set, 0x48
(0x0200) bles
Observación
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 requeridos
pdertdef.h
pdert.h
dmdefs.h
Funciones API
Consulte también
TLGGetArchivDataEx (Página 883)

2.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 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 requeridos
pdertdef.h
Funciones API
Consulte también
TLG_ENUMBACKUP_ENTRIES (Página 913)

2.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
relevantes.
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
dwAxisLocation
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
fGridLinesFine
fGridLinesBigVisible

fGridLinesFineVisible
fPercent
fLimitRange
fSubstitute
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
doGridFine
doShowDigits
Número de decimales
doLimitUpper1
doLimitUpper2

doLimitUpper3
doLimitLower1
doLimitLower2
doLimitLower3
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
doLimitRangeTo
crColor
El valor crColor de 32 bits específico de Windows determina el color de representación de la
curva.
crColorTimeOverlapped
El parámetro se reserva para futuras ampliaciones.
crColorTimeJump
crColorLimitUpper1
crColorLimitUpper2
crColorLimitUpper3
crColorLimitLower1

crColorLimitLower2
crColorLimitLower3
szSelectSQL
szText;
Título del eje x.
szFunction
szDLL
Observación
TLG_CURVESCALEX es empleado por la estructura TLG_TPLITEM_CURVE (Página 838).
Archivos requeridos
pdertdef.h
Consulte también
TLG_TPLITEM_CURVE (Página 838)

2.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
dwAxisLocation
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
fLimitRange
fSubstitute
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
doLimitUpper2
doLimitUpper3
doLimitLower1
doLimitLower2
doLimitLower3
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
doLimitRangeTo

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 ];
szText[ TLG_MAX_STD_TEXT_NAME ];
Título del eje y.
Observación
TLG_CURVESCALEY es empleado por la estructura AUTOHOTSPOT.
Archivos requeridos
pdertdef.h
Consulte también

2.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 en el nombre del fichero desde el cual se han leído los datos.
lpszVarName
Puntero en el nombre de variable cuyos valores han sido leídos.
stTime
Valor x del valor de fichero.
doValue
Valor y del valor de fichero.
dwFlags
Archivos requeridos
pdertdef.h
Funciones API
TLG_GETARCHIVDATA_CALLBACK (Pági‐ Leer datos de un fichero (Callback)

na 882)
Consulte también
TLG_GETARCHIVDATA_CALLBACK (Página 882)

2.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 requeridos
pdertdef.h
Funciones API
TLGGetBackupSize (Página 916) Determinar el tamaño de un registro exportado

TLGExport (Página 915) Exportar datos de fichero
Consulte también
TLGGetBackupSize (Página 916)
TLGExport (Página 915)

2.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
Observación
TLG_PROT_CURVE_INFOS es utilizado por las estructuras TLG_TABLESCALE
(Página 831) y TLG_TPLITEM_INFO (Página 839).
Archivos requeridos
pdertdef.h
Funciones API
TLGDrawCurvesInDC (Página 897) Representar curvas
Consulte también
TLGDrawCurvesInDC (Página 897)
TLG_TABLESCALE (Página 831)
TLG_TPLITEM_INFO (Página 839)

2.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
doScalArcUpper
szStructName
Nombre de la estructura de escala para los valores de variable.
Observación
La estructura TLG_SCAL_STR se utiliza dentro de la estructura TLG_VAR_STR (Página 841)
para futuras ampliaciones.
Archivos requeridos
pde_def.h
Consulte también
TLG_VAR_STR (Página 841)

2.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 Archivo 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 siguiente
Ficheros requeridos
pdertdef.h
Funciones API

Consulte también
TLG_ENUMTABLES (Página 877)
2.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
stFrom
Instante de inicio del área de representación.
stTo
Instante final del área de representación.
doFrom
doTo
doShowDigits
Número de decimales de salida.
doLimitUpper1
doLimitUpper2
dpoLimitUper3
doLimitLower1
doLimitLower2

doLimitLower3
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
Observación
TLG_TABLESCALE es empleado por la estructura TLG_TEMPLATEITEM_INFO
(Página 834).
Archivos requeridos
pdertdef.h
Consulte también
TLG_PROT_CURVE_INFOS (Página 827)

TLG_TEMPLATEITEM_INFO (Página 834)

TLG_TPLITEM_TABLE (Página 840)
2.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 839) con las propiedades de una plantilla
de curva / columna.
Archivos requeridos
pdertdef.h
Funciones API
TLG_TABLESCALE (Página 831) Columna de tabla (propiedades) (estructura)

Consulte también
TLGInsertTemplateItem (Página 899)
2.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.
Observación
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 requeridos
pde_def.h
Funciones API
TLGReadTime (Página 910) Determinar parámetros del objeto de tiempo
Consulte también
TLGReadTime (Página 910)
2.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 requeridos
pdertdef.h

Funciones API
Consulte también
TLG_ENUMTIMES_CALLBACK (Página 909)
2.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 816) contiene los datos para la escala del eje X
de una curva.
csy
La estructura TLG_CURVESCALEY (Página 821) contiene los datos para la escala del eje Y
de una curva.
Descripción
TLG_TPLITEM_CURVE es empleado por la estructura TLG_TPLITEM_INFO (Página 839).
Archivos requeridos
pdertdef.h
Consulte también
TLG_CURVESCALEX (Página 816)
TLG_CURVESCALEY (Página 821)

2.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 de la estructuraTLG_TPLITEM_CURVE (Página 838).
tplTable
Las propiedades de una columna se leen de la estructuraTLG_TPLITEM_TABLE
(Página 840).
Observación
TLG_TPLITEM_INFO es empleado por la estructura TLG_TEMPLATEITEM_INFO
(Página 834).
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 requeridos
pdertdef.h
Consulte también
TLG_TPLITEM_TABLE (Página 840)

2.8.2.17 TLG_TPLITEM_TABLE (RT Professional)
Declaración
typedef struct {
TLG_TABLESCALE ts;
}
TLG_TPLITEM_TABLE;
Members
ts
TLG_TABLESCALE (Página 831) con las propiedades de una columna de tabla.
Descripción
TLG_TPLITEM_TABLE es empleado por la estructura TLG_TPLITEM_INFO (Página 839).
Por cuestiones de organización no es posible utilizar TLG_TABLESCALE directamente en la
estructura TLG_TPLITEM_INFO.
Archivos requeridos
pdertdef.h
Consulte también

2.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;
Observación
La asignación de los parámetros de la estructura TLG_VAR_STR se realiza en función 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 las variables de fichero / del grupo de variables.
Los caracteres : ? " ' \ * % y blanco no se pueden emplear en los nombres de variable de
fichero, ya que de lo contrario se suministra TLG_API_NAME_WRONG_CHAR.
szProcName
Parámetro global para el nombre de las variables de proceso
dwVarType
Parámetro global que identifica el tipo de variables 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 las variables 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 arranque.
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

szSourceArchiv
Nombre del fichero de origen.
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
el 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 829) con los valores límite de la variable.
RecordStruct
Archivos necesarios
pde_def.h
Funciones API
TLGReadVariable (Página 867) Determinar parámetros de las variables
Consulte también
TLGReadVariable (Página 867)
TLG_SCAL_STR (Página 829)

2.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 requeridos
pdertdef.h
pde_typ.h
Funciones API
Consulte también
TLG_ENUMVARIABLES (Página 866)

2.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ámetro
hwndParent
Handle de ventana de la ventana maestra.
lpError
Valor de retorno
TRUE
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll

TLGCSConnectEx (Página 849) Establecer una conexión con la base de datos de

proyecto
TLGCSDisConnect (Página 850) Establecer una conexión con la base de datos de
proyecto
Ejemplos
Enum all acquisition and archiving times (Página 922) "TL01.cpp"
Read parameters of time object (Página 936) "TL01.cpp"
Enum archives (Página 925) "TL01.cpp"
Read archive (Página 932) "TL01.cpp"
Consulte también
TLGCSConnectEx (Página 849)
Enum archives (Página 925)
TLGOpenProject (Página 857)
Read parameters of time object (Página 936)
Enum all acquisition and archiving times (Página 922)
Read archive (Página 932)
TLGCSDisConnect (Página 850)
2.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ámetro
hwndParent

dwMode
lpError
Valor de retorno
TRUE
Conexión establecida
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
TLGCSConnect (Página 848) Establecer una conexión con la base de datos de

proyecto
Consulte también
TLGCSConnect (Página 848)
2.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 finalizada.
FALSE
Errores
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll

proyecto
Ejemplos
Enum all acquisition and archiving times (Página 922) "TL01.cpp"
Read parameters of time object (Página 936) "TL01.cpp"
Enum archives (Página 925) "TL01.cpp"
Read archive (Página 932) "TL01.cpp"
Consulte también


2.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ámetro
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 asignación de parámetros no válida / incorrecta

TLG_API_NO_INTERFACE Acceso fallido 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 requeridos
pdertcli.h

pde_glob.h
pdertcli.lib
pdertcli.dll
2.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ámetro
hwndParent
lpError
Valor de retorno
TRUE
Conexión establecida
FALSE
Error
Observación
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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
TLGDisconnect (Página 854) cancelar conexión
Ejemplos
Enumerate archives (Página 930)"TL02.cpp"
Consulte también
Enumerate archives (Página 930)
TLGDisconnect (Página 854)
Edit curve template - Example 1 (Página 919)
2.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ámetro
lpError

Valor de retorno
TRUE
conexión interrumpida
FALSE
Error
Observación
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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
TLGConnect (Página 853) Establecer conexión
Ejemplos
Consulte también
TLGConnect (Página 853)

2.8.4 Funciones de administración del proyecto (RT Professional)
2.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ámetro
hProject
Handle de un proyecto abierto con TLGOpenProject.
lpoes
Valor de retorno
TRUE
Proyecto cerrado
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Ejemplos
Read parameters of time object (Página 936)"TL01.cpp"
Enum archives (Página 925)"TL01.cpp"

Read archive (Página 932)"TL01.cpp"
Consulte también
2.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ámetro
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
Observación
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_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_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 849) Establecer una conexión con la base de datos de
proyecto
Ejemplos


Enum variables of an archive (Página 928)"TL02.cpp"
Consulte también
TLGEnumProject (Página 859)
TLGCSConnectEx (Página 849)
Enum variables of an archive (Página 928)
2.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ámetro
lpCallbackFunc
Puntero en su función Callback llamada para cada proyecto abierto.
lpUser
lpoes

Valor de retorno
TRUE
Proyectos listados
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
TLG_ENUM_PROJECT_NAME_CALLBACK (Pá‐ Listar proyectos (Callback)

gina 860)
Consulte también
TLG_ENUM_PROJECT_NAME_CALLBACK (Página 860)
2.8.4.4 TLG_ENUM_PROJECT_NAME_CALLBACK (RT Professional)
Descripción
Para poder evaluar los proyectos listados por el sistema debe proporcionar una función
Callback del tipo TLG_ENUM_PROJECT_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_PROJECT_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetro
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 859)
2.8.5 Funciones para editar variables (RT Professional)
2.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ámetro
hProject
Handle del proyecto en el que se encuentra el fichero.
lpszArchivName
Puntero en el nombre del fichero
lpCallbackFunc
Puntero en su función Callback llamada para cada entrada de variable en el fichero.
lpUser
lpoes
Valor de retorno
TRUE
Variables de fichero listadas
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll

TLG_ENUM_VARIABLE_NAME_CALLBACK (Pá‐ Listar variables (Callback)

gina 863)
Consulte también
TLG_ENUM_VARIABLE_NAME_CALLBACK (Página 863)
2.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ámetro
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 861)
2.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ámetro
lpszArchiveName
Puntero en el nombre del archivo, cuyas variables se deben listar.

lpfnCallback
Puntero en su función Callback llamada para cada variable del fichero.
lpUser
lpError
Valor de retorno
TRUE
Variables listadas
FALSE
Error
Mensajes de error

Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
pdertcli.h
pdertcli.lib
pdertcli.dll
Ejemplos
Enum variables of an archive (Página 928) "TL02.cpp"

Consulte también
2.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ámetro
lpvi
Dirección de una estructura del tipo TLG_VARIABLE_INFO (Página 847) 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 864) Listar variables
Ejemplos
Enum variables of an archive (Página 928)"TL02.cpp"
Consulte también
TLGEnumVariablesEx (Página 864)
TLG_VARIABLE_INFO (Página 847)
TLGEnumArchivsEx (Página 873)
2.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ámetro
hProject
Handle del proyecto en que se encuentra la variable editar.
lpszArchivName

lpszVariableName
Puntero en el nombre de una variable del fichero.
lpVariable
Dirección de la estructura TLG_VAR_STR (Página 841) , desde la cual se deben leer los datos
de las variables.
lpoes
Valor de retorno
TRUE
Parámetros leídos
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll

TLGReadVariable6 Determinar parámetros de las variables
Ejemplos
Consulte también
TLG_VAR_STR (Página 841)
TLGEnumVariables (Página 861)

2.8.6 Funciones para editar ficheros (RT Professional)
2.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ámetro
hProject
Handle del proyecto en el que se encuentran los ficheros.
lpCallbackFunc
Puntero en su función Callback llamada para cada fichero.
lpUser
lpoes
Valor de retorno
TRUE
Ficheros listados
FALSE
Error
Archivos requeridos
pdecscli.h

pdecscli.lib
pdecscli.dll

TLG_ENUM_ARCHIV_CALLBACK (Página 870) Listar ficheros (Callback)
Ejemplos
Consulte también
TLG_ENUM_ARCHIV_CALLBACK (Página 870)
2.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ámetro
lpszName
El puntero lpszName remite al nombre del fichero.
lpUser
función Callback.

Valor de retorno
TRUE
FALSE
Observación
Nota
Archivos necesarios
pdecscli.h
Ejemplos
Consulte también
TLGEnumArchives (Página 869)
2.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ámetro
dwArchivTyp

NULL Se enumeran todos los ficheros.
lpfnCallback
lpUser
lpError
Valor de retorno
TRUE
Ficheros listados
FALSE
Error

Mensajes de error

Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
TLGEnumArchivsEx (Página 873) Listar ficheros

Ejemplos
Consulte también
TLGEnumArchivsSel (Página 875)
2.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ámetro
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 requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Consulte también
TLGEnumArchivs (Página 871)
2.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ámetro
dwArchivTyp

dwSaveTyp
dwSaveTyp identifica el tipo del fichero:
TLG_ARCTYP_ALL Ficheros circulares y siguientes

TLG_ARCTYP_CIRCULAR Ficheros circulares
TLG_ARCTYP_FOLLOW Ficheros siguientes
lpfnCallback
lpUser
lpError
Valor de retorno
TRUE
Los ficheros se listan.
FALSE
Error
Mensajes de error

TLG_API_INVALID_PARAM asignación de parámetros no válida o incorrecta
Archivos requeridos
pdertcli.h

pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

AUTOHOTSPOT Listar ficheros
Consulte también
TLG_TABLE_INFO (Página 830)
2.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ámetro
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 830).

lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Observación
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 830)
2.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ámetro
lpMemory
El puntero en el área de memoria a habilitar 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 requeridos
pdertcli.h
pdertcli.lib
pdertcli.dll
Consulte también
2.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ámetro
lpszArchivName
Puntero en el nombre del archivo del cual se deben leer datos.

lpszVarName
Puntero en el 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 en su función Callback llamada para cada punto de medición a leer.
lpUser
dwFlags
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 requeridos
pdertcli.h
pde_glob.h

pdertdef.h
pdertcli.lib
pdertcli.dll
TLG_GETARCHIVDATA_CALLBACK Leer datos de un fichero (Callback)

(Página 882)
Consulte también
TLG_GETARCHIVDATA_CALLBACK (Página 882)
2.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ámetro
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
Puntero en datos específicos de la aplicación. Este puntero se vuelve a proporcionar en la
función Callback.
Valor de retorno
TRUE
Se continúa la enumeración.

FALSE
Se cancela la enumeración.
Nota
Transferir, dentro de lo posible, únicamente datos. Los siguientes tipos de llamadas de función
dentro del Callback pueden provocar Deadlocks o Stackoverflow:
● Funciones en las cuales se accede a un Message Loop, p.ej. GetMessage
● Funciones API Runtime de la misma DLL
● Enumeraciones que llaman otras enumeraciones
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h

TLG_GETARCHIVDATA (Pági‐ Datos de fichero de archivos de datos de proceso (estructura)
na 825) Datos de fichero de ficheros comprimidos (estructura)
Consulte también
TLGGetArchivData (Página 880)
TLG_GETARCHIVDATA (Página 825)
2.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ámetro
lpszArchivName
Puntero en el nombre del fichero desde el cual se leen los datos.
lpszVarName
Puntero en el 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 811).
Nota
Se debe habilitar de nuevo la memoria asignada mediante TLGFreeMemory.
pdwNumberOfData
Puntero en la cantidad 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 recibirá los primeros 10.000. Para obtener los
siguientes debe añadir un milisegundo a la hora del último registro, indicando esta
circunstancia como hora de inicio en la nueva llamada de TLGGetArchivDataEx.
dwFlags
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 requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib

pdertcli.dll

TLGFreeMemory (Página 879) Habilitar memoria
Consulte también
TLGFreeMemory (Página 879)
TLGGetArchivData (Página 880)
TLG_ARCHIVDATARAW (Página 811)
2.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ámetro
lpszArchivName
lpszVarName
Puntero en el nombre de las variables
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.
Observación
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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

TLGGetClosestTimeEx (Página 888) Determinar el instante de archivación
Consulte también
TLGGetClosestTimeEx (Página 888)
2.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ámetro
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.
Observación
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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll

TLGGetClosestTime (Página 886) Determinar el instante de archivación
Consulte también
TLGGetClosestTime (Página 886)
2.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ámetro
lpszArchivName
Puntero al nombre del fichero
lpszVarName
Puntero al nombre de la variable

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
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0. Aquí puede
indicarse el flag 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 antiguos entre registros ya
existentes. Si se incorporan valores más antiguos que los actuales o no ordenados
temporalmente, los valores más antiguos se rechazan sin indicación de error.
lpError
Valor de retorno
TRUE
Valores de variable incorporados al fichero.
FALSE
Error
Observación
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.
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)
Mensajes de error

TLG_API_NO_INTERFACE Error en el acceso a interfaces COM subordinadas
disponible
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
2.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ámetro
hwnd
Handle de ventana de la ventana PDE Runtime.

lpszArchivName
Puntero en el nombre del fichero.
fLocked
TRUE: Bloquear fichero

FALSE: Habilitar fichero
lpError
Puntero en 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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
2.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ámetro
hwnd
Handle de ventana de la ventana PDE Runtime.
lpszArchivName
Para seleccionar un servidor determinado se puede anteponer "ServerPräfix::" al nombre de
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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
2.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ámetro
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 808) , en la cual se archivan los
parámetros del fichero.
lpoes

Valor de retorno
TRUE
Contenidos del fichero leídos
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll

TLGReadArchiv6 Leer parámetros de fichero
Ejemplos
Consulte también
TLG_ARCHIV_STR (Página 808)
2.8.7 Funciones para representación de curvas y tablas (RT Professional)
2.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 requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
2.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ámetro
hDC
Handle en la ventana maestra, en la que se debe representar la curva
lprect
Puntero en la estructura específica de Windows del tipo RECT con las indicaciones de tamaño
de la ventana.
lpci
Puntero en la primera estructura del tipo TLG_PROT_CURVE_INFOS (Página 827) 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 requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
2.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ámetro
lpszTemplateName
Puntero en el nombre de la plantilla de ventana a la que se desea añadir una plantilla de curva
o de tabla.
lpptii
Puntero en una estructura del tipo TLG_TEMPLATEITEM_INFO (Página 834) con los datos
de la plantilla de curva o tabla a añadir.
lpError

Valor de retorno
TRUE
Plantilla de ventana ampliada
FALSE
Error
Mensajes de error

activado
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Ejemplos
Edit curve template - Example 1 (Página 919)"TL02.cpp"
Consulte también
2.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ámetro
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.
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 requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
2.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ámetro
lpszTemplateName
Puntero en el 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
Observación
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 requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
2.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ámetro
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 requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
WinUser.h

2.8.8 Funciones para procesar sistemas de tiempo (RT Professional)
2.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ámetro
hProject
Handle del proyecto en el que se encuentran los objetos de tiempo a listar.
lpCallbackFunc
Puntero en su función Callback llamada una única vez para cada objeto de tiempo existente.
lpUser
lpoes
Valor de retorno
TRUE
Objetos de tiempo listados
FALSE
Error
Archivos requeridos
pdecscli.h

pdecscli.lib
pdecscli.dll
TLG_ENUM_TIME_NAME_CALLBACK (Pági‐ Listar objetos de tiempo (Callback)

na 906)
Ejemplos
Enum all acquisition and archiving times (Página 922)"TL01.cpp"
Consulte también
TLG_ENUM_TIME_NAME_CALLBACK (Página 906)
2.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ámetro
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 905) Listar objetos de tiempo
Ejemplos
Enum all acquisition and archiving times (Página 922)"TL01.cpp"
Consulte también
TLGEnumTime (Página 905)
2.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ámetro
lpfnCallback
Puntero en su función Callback,
lpUser
lpError
Valor de retorno
TRUE
Objetos de tiempo listados.
FALSE
Error
Mensajes de error

activado
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll

Consulte también
TLG_ENUMTIMES_CALLBACK (Página 909)
2.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ámetro
lpTime
Por cada objeto de tiempo el sistema reserva memoria con la longitud de la estructura
TLG_TIMEDATA (Página 837). 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 907) Listar objetos de tiempo
Consulte también
TLGEnumTimes (Página 907)
TLG_TIMEDATA (Página 837)
2.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ámetro
hProject
Handle del proyecto en el que se encuentra el objeto de tiempo a editar.
lpszTimeName
Puntero en el nombre del objeto de tiempo
lpTime
Dirección de la estructura TLG_TIME_STR (Página 836) , con los datos del objeto de tiempo.
lpoes
Valor de retorno
TRUE
Parámetros del objeto de tiempo leídos.
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Ejemplos
Consulte también
TLG_TIME_STR (Página 836)

2.8.9 Funciones para proteger y restaurar (RT Professional)
2.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ámetro
lpszArchivName
lpfnCallback
Puntero en su función Callback llamada para cada copia de seguridad existente.
lpUser
lpError
Valor de retorno
TRUE
Copias de seguridad listadas
FALSE
Error

Mensajes de error

Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_ENUMBACKUP_ENTRIES (Página 913)
2.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ámetro
lpbti
Por cada copia de seguridad el sistema reserva memoria con la longitud de la estructura
TLG_BACKUP_TABLE_INFO (Página 814). El puntero lpbti remite al comienzo del primer
elemento.
lpUser
función Callback.
Valor de retorno
TRUE
FALSE
Observación
Nota
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
TLGEnumBackupEntries (Página 912) Listar copias de seguridad
Consulte también
TLGEnumBackupEntries (Página 912)
TLG_BACKUP_TABLE_INFO (Página 814)

2.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ámetro
lpszArchivName
Puntero en el 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 en el nombre del fichero en el que se deben exportar los datos.
lpibs
Dirección de la estructura de entrega TLG_IO_BACKUP_SELECT (Página 826) para los
parámetros de selección.
dwJobFlags
El parámetro está previsto para futuras ampliaciones y se debe asignar con 0L.
dwFormatFlags
TLG_BAKFMT_CSV: Formato CSV (Comma Seperated Value)
lpError

Valor de retorno
TRUE
Datos de fichero transferidos
FALSE
Error
Observación
La utilización de esta función únicamente resulta adecuada para ficheros siguientes, ficheros
circulares y ficheros comprimidos.
Mensajes de error

Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_IO_BACKUP_SELECT (Página 826)
2.8.9.4 TLGGetBackupSize (RT Professional)
Descripción
El sistema ha dejado de soportar la función, devolviendo ésta el valor FALSE y el código de
error TLG_API_NOT_SUPPORTED.

Declaración
BOOL TLGGetBackupSize (
DWORD* lpdwSizeOfTable,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
Parámetro
lpszArchivName
lpdwSizeOfTable
Dirección de un DWORD, en el cual se escribe el tamaño en bytes de los datos seleccionados.
lpibs
Dirección de la estructura de entrega TLG_IO_BACKUP_SELECT (Página 826) para los
parámetros de selección.
dwJobFlags
Posibles identificadores específicos de petición:
TLG_BACKUP_EXPORT: Copia de seguridad sencilla sin borrar los datos fuente.

TLG_BACKUP_EVACUATE: Transferencia con borrado de Source
dwFormatFlags
TLG_BAKFMT_CSV: Formato CSV (Comma Seperated Value)-
lpError
Valor de retorno
TRUE
Tamaño de datos determinado
FALSE
Error

Mensajes de error

Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_IO_BACKUP_SELECT (Página 826)

2.8.10.1 Edit curve template - Example 1 (RT Professional)
Ejemplo
// =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// *********************************************************************
//#include "odkapi.h" // if console application
#include "TL02.h"
#include <string.h>
#include <stdlib.h>
#include <malloc.h>
#include <time.h>
// IMPLEMENTATION
//{{ODK_EXAMPLE}Edit curve template (example no. 1) (TLG)}
//{{FUNCTION}TLGConnect (TLG)}
//{{FUNCTION}TLGDisconnect (TLG)}
//{{FUNCTION}TLGInsertTemplateItem (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGInsertTemplateItem(void) ODK TL RT
// =====================================================================
// : Edit curve template
// : Defines a new curve with previous settings
// =====================================================================
void MyTLGInsertTemplateItem (void)
{
#define COLOR_RED 0x000000FF
// Color Nombre simb. Value (hexadecimal) Value (decimal)

// negro CO_BLACK 0x00000000 0
// blanco CO_WHITE 0x00FFFFFF 16777215
// rojo CO_RED 0x000000FF 255
// rojo oscuro CO_DKRED 0x00000080 128
// verde CO_GREEN 0x0000FF00 65280
// verde oscuro CO_DKGREEN 0x00008000 32768
// azul CO_BLUE 0x00FF0000 16711680
// azul oscuro CO_DKBLUE 0x00800000 8388608
// amarillo CO_YELLOW 0x0000FFFF 65535
// amarillo oscuro CO_DKYELLOW 0x00008080 32896
// cian CO_CYAN 0x00FFFF00 1048320
// cian oscuro CO_DKCYAN 0x00808000 8421376
// magenta CO_MAGENTA 0x00FF00FF 16711935
// magenta oscuro CO_DKMAGENTA 0x00800080 8388736
// gris claro CO_LTGRAY 0x00C0C0C0 12632256
// gris oscuro CO_DKGRAY 0x00808080 8421504

// scripts
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
HWND hwndParent = NULL;
TLG_TEMPLATEITEM_INFO TemplateItem;
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
memset(&TemplateItem, 0, sizeof(TLG_TEMPLATEITEM_INFO));
_tcsncpy_s(TemplateItem.szArchivName, _countof(TemplateItem.szArchivName),
_T("PLSMWA"), _TRUNCATE); // archive name
_tcsncpy_s(TemplateItem.szTemplateName, _countof(TemplateItem.szTemplateName),
_T("KV_PID1"), _TRUNCATE); // template for curve window
_tcsncpy_s(TemplateItem.szVariableName, _countof(TemplateItem.szVariableName),
_T("VPID1_X"), _TRUNCATE); // DM variable name
_tcsncpy_s(TemplateItem.szDMVariableName, _countof(TemplateItem.szDMVariableName),
_T("VPID1_X"), _TRUNCATE);
_tcsncpy_s(TemplateItem.szTemplateItemName,
_countof(TemplateItem.szTemplateItemName), _T("KPID3_X"), _TRUNCATE); // curve name
TemplateItem.dwTemplateTyp = TLG_TEMPLATE_CURVE;
TemplateItem.dwTemplateItemTyp = TLG_TEMPLATEITEM_CURVE;
TemplateItem.dwReadAccessLevel = 1;
TemplateItem.dwWriteAccessLevel = 1;
TemplateItem.dwArchivTyp = TLG_ARCTYP_PROCESS; //_USER, _PROCESS, _COMPRESS
_tcsncpy_s(TemplateItem.szTimeNameRange, _countof(TemplateItem.szTimeNameRange),
_T("500 ms"), _TRUNCATE);
TemplateItem.fVisible = TRUE;
TemplateItem.tplInfo.tplCurve.csx.dwDataTyp = TLG_DATATYP_TIMERANGE;
TemplateItem.tplInfo.tplCurve.csx.fAutoRange = TRUE;
TemplateItem.tplInfo.tplCurve.csx.fActualize = TRUE;
TemplateItem.tplInfo.tplCurve.csx.dwBufferSize = 10;
TemplateItem.tplInfo.tplCurve.csy.dwDataTyp = TLG_DATATYP_BLOCKDATA;
TemplateItem.tplInfo.tplCurve.csy.fAutoRange = TRUE;
TemplateItem.tplInfo.tplCurve.csy.crColor = COLOR_RED;
ret = TLGInsertTemplateItem(TemplateItem.szTemplateName, &TemplateItem, &Error);
if(FALSE == ret)
{
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("InsertItem:
TemplateItemName= %s "), TemplateItem.szTemplateItemName);

}
ODKTrace(szText);
// Disconnect
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
Consulte también
TLGInsertTemplateItem (Página 899)

2.8.10.2 Enum all acquisition and archiving times (RT Professional)
Ejemplo
/ =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// *********************************************************************
#include "stdlib.h"
#include "TL01.h"
#include "dm01.h"
// IMPLEMENTATION
// =====================================================================
// 4. Callback
// =====================================================================
//{{ODK_EXAMPLE}Enum all acquisition and archiving times (TLG)}
//{{FUNCTION}TLGCSConnect (TLG)}
//{{FUNCTION}TLGCSDisConnect (TLG)}
//{{FUNCTION}TLGEnumTime (TLG)}
//{{FUNCTION}TLG_ENUM_TIME_NAME_CALLBACK (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGEnumTime(void) ODK TL CS
// =====================================================================
// : Enum all acquisition and archiving times
// :
// =====================================================================
BOOL MyTLGEnumTimeNameCallback (LPTSTR szTime, PVOID lpUser)
{
TCHAR szText[255];
sprintf(szText,"...Enum Time %s", szTime);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumTime(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
HANDLE hProject;
CMN_ERROR Error;
PVOID pUser = NULL;
sprintf(szText, "TLGEnumTime");
ODKTrace(szText);
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)

{
sprintf(szText, "Error in TLGCSConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
else
{
sprintf(szText, " TLGCSConnect");
ODKTrace(szText);
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
ODKTrace(szText);
}
else //TLGOpenProject OK
{
sprintf(szText, " TLGOpenProject");
ODKTrace(szText);
// read projected archiving times
ret = TLGEnumTime(hProject, MyTLGEnumTimeNameCallback, pUser, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGEnumTime: E1= 0x%08lx ; E2= 0x%08lx ; %s",
}
else
{
sprintf(szText, " TLGEnumTime");
}
ODKTrace(szText);
//TLGCloseProject();
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
sprintf(szText, "Error in TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
}
else
{
sprintf(szText, " TLGCloseProject");
}
ODKTrace(szText);
}
// Disconnect

ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGCSDisConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
}
else
{
sprintf(szText, " TLGCSDisConnect");
}
ODKTrace(szText);
}
}
Consulte también
TLG_ENUM_TIME_NAME_CALLBACK (Página 906)
TLGEnumTime (Página 905)

2.8.10.3 Enum archives (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enum archives (TLG)}

//{{FUNCTION}TLGOpenProject (TLG)}
//{{FUNCTION}TLGCloseProject (TLG)}
//{{FUNCTION}TLGEnumArchives (TLG)}
//{{FUNCTION}TLG_ENUM_ARCHIV_CALLBACK (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGEnumArchives(void) ODK TL CS
// =====================================================================
// : Enum archives
// :
// =====================================================================
BOOL MyTLGEnumArchivCallback(LPTSTR szArchives, PVOID lpUser)
{
lpUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...Enum Archive=%s "),szArchives);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumArchives(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
HANDLE hProject;
PVOID pUser = NULL;
TCHAR szText[255];
TCHAR szArchivName[255];
_tcsncpy_s(szArchivName, _countof(szArchivName), _T("PLSMWA"), _TRUNCATE);
//TLGConnect
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
//TLGOpenProject
if (FALSE == ret)

{
TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
// TLGEnumArchives
ret = TLGEnumArchives(hProject, MyTLGEnumArchivCallback, pUser, &Error);
if (FALSE == ret)
{
TLGEnumArchives: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGEnumArchives"));
}
ODKTrace(szText);
}
//CloseProject
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCloseProject"));
}
ODKTrace(szText);
}
// Disconnect
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCSDisConnect"));
}
ODKTrace(szText);
}

Consulte también
TLGCloseProject (Página 856)
TLG_ENUM_ARCHIV_CALLBACK (Página 870)

2.8.10.4 Enum variables of an archive (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enum variables of a archive (TLG)}

//{{FUNCTION}TLG_ENUM_PROJECT_NAME_CALLBACK (TLG)}
//{{FUNCTION}TLGEnumVariablesEx (TLG)}
//{{FUNCTION}TLG_ENUMVARIABLES (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGEnumVariablesEx(void) ODK TL CS
// =====================================================================
// : Edit archive variables
// :
// =====================================================================
BOOL MyTLGEnumVariablesExCallback(PTLG_VARIABLE_INFO lpvi, LPVOID lpUser)
{
lpUser;
TCHAR szText[255];
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("Enum Variables %d %s "), lpvi-
>dwVariableTyp, lpvi->szVariableName);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumVariablesEx(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
CMN_ERROR Error;
HANDLE hProject = NULL;
VOID* pUser = NULL;
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));
ODKTrace(szText);
// Info
ret = TLGEnumVariablesEx (szArchivName, MyTLGEnumVariablesExCallback,
pUser, &Error );

if (FALSE == ret)
{
TLGEnumVariablesEx: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumVariablesEx: OK"));
}
ODKTrace(szText);
if(FALSE == ret)
{
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
Consulte también
TLGEnumVariablesEx (Página 864)

2.8.10.5 Enumerate archives (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Enumerate archives (TLG)}

//{{FUNCTION}TLGConnect (TLG)}
//{{FUNCTION}TLGDisconnect (TLG)}
//{{FUNCTION}TLGEnumArchivs (TLG)}
//{{FUNCTION}TLG_ENUMTABLES (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGEnumArchivs(void) ODK TL RT
// =====================================================================
// : Enumerate archives
// =====================================================================
BOOL MyTLGEnumTablesCallback(LPTSTR lpTableName, PTLG_TABLE_INFO lpti, PVOID lpUser)
{
lpUser;
TCHAR szText[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TableName=%s"), lpTableName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ...ArchivTyp=%d"), lpti-
>dwArchivTyp);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ...ArchivName=%s"),lpti-
>szArchivName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ...dwSaveTyp=%d"), lpti-
>dwSaveTyp);
ODKTrace(szText);
return TRUE;
}
void MyTLGEnumArchivs(void)
{
BOOL ret = FALSE;
//DWORD StartTime = 0;
//DWORD StopTime = 0;
void* lpUser = NULL;
CMN_ERROR Error;
TCHAR szText[255];
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));

ODKTrace(szText);
ret = TLGEnumArchivs(TLG_ARCTYP_PROCESS, MyTLGEnumTablesCallback, lpUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGEnumArchivs:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumArchivs: OK"));
}
ODKTrace(szText);
if(FALSE == ret)
{
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
}
}
Consulte también

2.8.10.6 Read archive (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Read archive (TLG)}

//{{FUNCTION}TLGReadArchiv (TLG)}
//{{FUNCTION}TLGReadVariable (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGReadArchiv(void) ODK TL CS
// =====================================================================
// : Read archive
// :
// =====================================================================
void MyTLGReadArchiv(void)
{
BOOL ret = FALSE;
CMN_ERROR Error;
HANDLE hProject;
//PVOID pUser = NULL;
TCHAR szText[255];
TCHAR szVarName[255];
TLG_ARCHIV_STR TLGArchivStruct;
TLG_VAR_STR TLGVarStruct;
_tcsncpy_s(szVarName, _countof(szVarName), _T("X"), _TRUNCATE);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else

{
// read
memset(&TLGArchivStruct,0,sizeof(TLG_ARCHIV_STR));
ret = TLGReadArchiv(hProject, szArchivName, &TLGArchivStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGReadArchiv:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadArchiv"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ArcName=%s Comments=
%s dwTyp=0x%04x dwRecSize=%d"),
TLGArchivStruct.szName,
TLGArchivStruct.szComment,
TLGArchivStruct.dwTyp,
TLGArchivStruct.dwRecordSize);
ODKTrace(szText);
}
memset(&TLGVarStruct, 0, sizeof(TLG_VAR_STR));
ret = TLGReadVariable(hProject, szArchivName, szVarName, &TLGVarStruct, &Error);
if (FALSE == ret)
{
TLGReadVariable: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadVariable"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szVarName=%s"),
TLGVarStruct.szVarName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szProcName=%s"),
TLGVarStruct.szProcName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwVarType=0x%04X"),
TLGVarStruct.dwVarType);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwArchivStyle=0x
%04X"), TLGVarStruct.dwArchivStyle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szWriteBackTo=%s"),
TLGVarStruct.szWriteBackTo);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwSupply=0x%04X"),
TLGVarStruct.dwSupply);
ODKTrace(szText);

_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" fLocked=%d"),

TLGVarStruct.fLocked);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szComment=%s"),
TLGVarStruct.szComment);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szRecordCycle=%s"),
TLGVarStruct.szRecordCycle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szArchivCycle=%s"),
TLGVarStruct.szArchivCycle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwMultiple=0x%04X"),
TLGVarStruct.dwMultiple);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwValueFlow=0x
%04X"), TLGVarStruct.dwValueFlow);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwValueFollow=0x
%04X"), TLGVarStruct.dwValueFollow);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwSaveByFault=0x
%04X"), TLGVarStruct.dwSaveByFault);
ODKTrace(szText);
}
}
//CloseProject
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
// Disconnect
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}

Consulte también

2.8.10.7 Read parameters of time object (RT Professional)
Ejemplo
//{{ODK_EXAMPLE}Read parameters of time object (TLG)}

//{{FUNCTION}TLGReadTime (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGReadTime(void) ODK TL CS
// =====================================================================
// : Reads the parameters of an already existing time object.
// :
// =====================================================================
void MyTLGReadTime(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
HANDLE hProject;
CMN_ERROR Error;
TLG_TIME_STR TLGTimeStruct;
TCHAR szTime[255];
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadTime"));
ODKTrace(szText);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGOpenProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
// read properties of selected time
memset(&TLGTimeStruct, 0, sizeof(TLG_TIME_STR));

_tcsncpy_s(szTime, _countof(szTime), _T("500 ms"), _TRUNCATE);

ret = TLGReadTime(hProject, szTime, &TLGTimeStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGReadTime:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...szTimeName = %s
"),TLGTimeStruct.szTimeName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...dwBasis = %10d
Millisec"), TLGTimeStruct.dwBasis);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("...dwFactor = %10d
"), TLGTimeStruct.dwFactor);
ODKTrace(szText);
}
// save changes permanent
ret = TLGSaveProject(hProject , &Error);
if (FALSE == ret)
{
TLGSaveProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGSaveProject"));
}
ODKTrace(szText);
//TLGCloseProject();
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
// Disconnect
if (FALSE == ret)
{

2.9 Funciones para recetas (RT Professional)
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect:

E1= 0x%08lx ; E2= 0x%08lx ; %s"),
}
else
{
}
ODKTrace(szText);
}
}
Consulte también
TLGReadTime (Página 910)
Sinopsis
uaSetLocalEvents (Página 950) Activa los eventos locales

uaArchiveClose (Página 961) Deshacer conexión con fichero de usuario actual
uaArchiveDelete (Página 962) Borrar registros en el fichero de usuario
uaArchiveExport (Página 963) Exportar fichero de usuario
uaArchiveGetCount (Página 975) Leer la cantidad de registros
uaArchiveGetFieldLength (Página 983) Leer la longitud de flag actual
uaArchiveGetFieldName (Página 984) Leer el nombre de campo actual
uaArchiveGetFields (Página 985) Determinar número de campos
uaArchiveGetFieldType (Página 986) Leer el tipo del campo actual
uaArchiveGetFieldValueDate (Página 987) Leer fecha y hora del campo de datos actual
uaArchiveGetFieldValueDouble (Página 988) Leer valor Double del campo de datos actual
uaArchiveGetFieldValueLong (Página 990) Leer valor Long del campo de datos actual

uaArchiveGetFieldValueString (Página 991) Leer cadena del campo de datos actual

uaArchiveGetFilter (Página 976) Leer ajuste de filtro
uaArchiveGetID (Página 965) Leer ID del campo de datos actual
uaArchiveGetName (Página 966) Lee el nombre del fichero
uaArchiveGetSort (Página 967) Leer clasificación del campo de datos actual
uaArchiveImport (Página 968) Importar fichero de usuario
uaArchiveInsert (Página 977) Insertar registro en el fichero de usuario
uaArchiveMoveFirst (Página 978) Posicionar en el primer registro
uaArchiveMoveLast (Página 979) Posicionar en el último registro
uaArchiveMoveNext (Página 980) Posicionar en el siguiente registro
uaArchiveMovePrevious (Página 981) Posicionar en el registro anterior
uaArchiveOpen (Página 969) Establecer conexión con fichero de usuario actual
uaArchiveReadTagValuesByName (Página 1004) Leer valores de variable a partir del nombre
uaArchiveReadTagValues (Página 1003) Leer valores de variable
uaArchiveRequery (Página 998) Recomenzar en fichero de usuario actual
uaArchiveSetFieldValueDate (Página 992) Escribir fecha y hora en el campo de datos actual
uaArchiveSetFieldValueDouble (Página 993) Escribir valor Double en el campo de datos actual
uaArchiveSetFieldValueLong (Página 994) Escribir valor Long en el campo de datos actual
uaArchiveSetFieldValueString (Página 996) Escribir cadena en el campo de datos actual
uaArchiveSetFilter (Página 999) Activar filtro
uaArchiveSetSort (Página 1001) Ajustar criterio de clasificación
uaArchiveUpdate (Página 971) Actualizar registro en el fichero de usuario
uaArchiveWriteTagValuesByName (Página 1007) Escribir registro a partir del nombre en variables
uaArchiveWriteTagValues (Página 1005) Escribir registro en variables
uaConnect (Página 951) Establecer conexión con un fichero de usuario
(Runtime)
uaDisconnect (Página 952) Deshacer conexión con fichero de usuario
uaGetArchive (Página 972) Leer configuración de fichero
uaGetField (Página 997) Leer configuración de campo
uaGetLastError (Página 946) Consultar último error de fichero de usuario
AUTOHOTSPOT Consultar el último error ocurrido de las funciones
COM
uaGetNumArchives (Página 973) Encontrar número de ficheros de usuario configu‐
rados
uaGetNumFields (Página 982) Determinar número de campos
uaIsActive (Página 948) Consultar si un fichero está abierto en runtime
uaOpenArchives (Página 974) Consultar cuántos ficheros de usuario están abier‐
tos en runtime
uaOpenViews (Página 1002) Consultar cuántas vistas de ficheros de usuario
están abiertas en runtime
uaQueryArchiveByName (Página 955) Establecer conexión con fichero de usuario por
nombre (runtime)
uaQueryArchive (Página 953) Establecer conexión con fichero de usuario (Run‐
time)
uaQueryConfiguration (Página 957) Consultar conexión con configuración

uaReleaseArchive (Página 958) Deshacer la conexión con el fichero de usuario

(Runtime)
uaReleaseConfiguration (Página 960) Deshacer la conexión con la configuración
Consulte también
uaUsers (Página 949)
2.9.1.2 Estructura de las recetas (RT Professional)
Introducción
Los ficheros de usuario son tablas individuales recogidas en la base de datos, que, con
excepción de la primera columna, tienen una estructura completamente libre. Los tipos de
datos están limitados a campos char, double, int y DateTime.
Las funciones Get y Set trabajan en un registro hRecord interno, que puede escribirse en el
fichero con Insert y Update.
Si el fichero de usuario se modifica directamente desde la base de datos (ODBC/ SQL), no
se realiza una sincronización online.
Configuración de los ficheros de usuario

El primer paso es la configuración de ficheros de usuario. Dicha configuración puede realizarse
con el editor User Archives, con las funciones de script o con las funciones API del User
Archives. En este caso, las funciones de script se corresponden con las funciones API.

Configuración con las funciones API de User Archives

La función UAQueryConfiguration proporciona un handle (UAHCONFIG) para las funciones
de configuración. Dicho handle permite llamar las funciones de configuración UASetArchive,
UAAddArchive, UASetField, UAAddField, etc.. La función "UAReleaseConfiguration" finaliza
la configuración de User Archives.
Estas funciones no están disponibles en proyectos multicliente.
Establecer conexión con User Archives

El siguiente paso consiste en llamar la función estándar UAConnect para establecer una
conexión con el componente User Archives. UAConnect genera el handle UAHCONNECT
con el que se pueden abrir y cerrar ficheros (no vistas).
Funciones de información en modo Runtime

La función UAIsActive muestra si un fichero está abierto de forma activa en runtime. UAUsers
devuelve el número de usuarios registrados, UAOpenArchives el número de ficheros abiertos
y UAOpenViews el número de vistas abiertas.
Abrir las funciones de runtime

Para el funcionamiento en modo Runtime es necesario que haya un fichero de usuario
configurable. Con las funciones UAQueryArchive y UAQueryArchiveByName se proporciona
un handle para las funciones de runtime. Tras abrir el fichero con la función UAArchiveOpen
se pueden utilizar las funciones de runtime de User Archives.
Funciones para el funcionamiento en modo Runtime

Con las funciones UAArchiveMoveNext, UAArchiveMovePrevious, UAArchiveMoveFirst y
UAArchiveMoveLast se mueve el puntero de posición. Con el handle hArchive se consigue
una asignación unívoca a un registro del fichero de usuario. Esta asignación permite además
un direccionamiento directo, como el necesario, por ejemplo, en el caso de máscaras de
pantalla.
La función UAArchiveUpdate guarda el registro temporal en el fichero y sobrescribe en éste
el registro en el que se encuentra el puntero de posición en ese momento. Antes hay que leer
este registro con las funciones UAArchiveMoveNext, UAArchiveMovePrevious,
UAArchiveMoveFirst o UAArchiveMoveLast.
Deshacer conexión con User Archives

La función UAArchiveClose cierra un fichero de usuario. La función UAReleaseArchive
deshace la conexión con el fichero actual y la función UADisconnect deshace finalmente la
conexión con los componentes del User Archives.

2.9.1.3 Dependencias de la secuencia de llamada de las funciones API (RT Professional)
Dependencias de la secuencia de llamada de las funciones de runtime

La función de User Archives UAConnect crea el handle UAHCONNECT. Éste es necesaria
para poder abrir y cerrar ficheros (no vistas) Por ello, primero es necesario llamar la función
UAConnect para obtener el handle UAHCONNECT. Con él se pueden llamar entonces las
funciones API inferiores para abrir y cerrar ficheros (no vistas). Para finalizar la configuración
hay que llamar UADisconnect.
Las funciones UAQueryArchive y UAQueryArchiveByName generan el handle UAHARCHIVE.
Éste es necesario para la función API de User Archives UAArchiveOpen, que abre el fichero
para el modo Runtime.
Handles para funciones de fichero en runtime
UAConnect Handle UAHCONNECT

--->
Necesario UAIsActive
para
UAUsers
UAOpenArchives
UAOpenViews
UAQueryArchive ---> Handle UAHAR‐
CHIVE
UAQueryArchiveByNa‐ Handle UAHAR‐
me ---> CHIVE
Necesario para:
UAArchiveOpen ---
>
Requisito para UAArchiveDelete
UAArchiveExport
UAArchiveGetCount
UAArchiveGetFieldLength
UAArchiveGetFields
UAArchiveGetFieldType
UAArchiveGetFieldValueDate
UAArchiveGetFieldValueDouble
UAArchiveGetFieldValueFloat
UAArchiveGetFieldValueLong
UAArchiveGetFieldValueString
UAArchiveGetFieldName
UAArchiveGetFilter
UAArchiveGetID
UAArchiveGetName

UAArchiveGetSort
UAArchiveImport
UAArchiveInsert
UAArchiveMoveFirst
UAArchiveMoveLast
UAArchiveMoveNext
UAArchiveMovePrevious
UAArchiveReadTagValues
UAArchiveReadTagValuesByNa‐
me
UAArchiveRequery
UAArchiveSetFieldValueDate
UAArchiveSetFieldValueDouble
UAArchiveSetFieldValueFloat
UAArchiveSetFieldValueLong
UAArchiveSetFieldValueString
UAArchiveSetFilter
UAArchiveSetSort
UAArchiveUpdate
UAArchiveWriteTagValues
UAArchiveWriteTagValuesByName
<--- UAArchiveClose
<--- UAReleaseAr‐
chive
<--- UADisconnect
Sinopsis
Los siguientes mensajes de error pueden consultarse con la función API UAGetLastError.
UA_ERROR_SUCCESS 0 Sin errores, todo correcto.

UA_ERROR_GENERIC 1 Error en función de configuración.
UA_ERROR_CONNECT_FAILED 100 No hay ninguna conexión Runtime establecida (sin
Runtime).
UA_ERROR_OPEN_FAILED 101 No es posible abrir el fichero.
UA_ERROR_CLOSE_FAILED 102 No es posible cerrar el fichero, o el handle no es
válido.
UA_ERROR_REQUERY_FAILED 103 No se ha podido ejecutar la reintegración en el fi‐
chero, p. ej. con un nuevo filtro / una nueva clasifi‐
cación.
UA_ERROR_MOVE_FAILED 104 No se ha podido ejecutar el nuevo posicionamiento
First, Last, Next o Previous.

UA_ERROR_INSERT_FAILED 105 No se ha podido insertar ningún registro en la po‐

sición indicada (comprobar posición).
UA_ERROR_UPDATE_FAILED 106 El registro indicado no se ha podido actualizar (blo‐
queado o no hay ningún registro en esa posición).
UA_ERROR_DELETE_FAILED 107 No se ha(n) podido borrar (todos) el/los registro(s).
UA_ERROR_IMPORT_FAILED 108 La importación de un fichero ha fallado (comprobar
formato, tamaño).
UA_ERROR_EXPORT_FAILED 109 La exportación del fichero de usuario no ha dado
resultado (comprobar el espacio).
UA_ERROR_READ_FAILED 110 No se ha podido ejecutar la lectura de variables.
UA_ERROR_WRITE_FAILED 111 No se ha podido ejecutar la escritura en variables.
UA_ERROR_GET_FAILED 112 No se ha podido ejecutar la lectura de la descrip‐
ción de fichero o campo, o bien de los valores del
registro.
UA_ERROR_SET_FAILED 113 No se ha podido ejecutar la escritura de la descrip‐
ción de fichero o campo, o bien de los valores del
registro.
UA_ERROR_INVALID_NAME 200 No es un nombre válido.
UA_ERROR_INVALID_TYPE 201 Se ha indicado un tipo erróneo
UA_ERROR_INVALID_NUMRECS 202 El número de registros no puede aplicarse así
UA_ERROR_INVALID_COMMTYPE 203 Se ha seleccionado una conexión errónea de No‐
ne / Raw / Direct
UA_ERROR_INVALID_LENGTH 204 Así no se aplica la longitud (de cadena) indicada
UA_ERROR_INVALID_PRECISION 205 Así no se aplica el número indicado de decimales.
UA_ERROR_NULL_POINTER 1000 Se ha transferido un puntero NULL
UA_ERROR_INVALID_POINTER 1001 El puntero especificado no es válido
UA_ERROR_INVALID_HANDLE 1002 El handle especificado no es válido
UA_ERROR_INVALID_INDEX 1003 El índice especificado no es válido
UA_ERROR_SERVER_UNKNOWN 1004 El servidor indicado y utilizado no es válido
Constantes de configuración:
Tipos de ficheros
UA_ARCHIVETYPE_UNKNOWN 0 Tipo de fichero desconocido

UA_ARCHIVETYPE_UNLIMITED 1 Fichero circular
UA_ARCHIVETYPE_LIMITED 2 Fichero con número de registros fijo

Flags de fichero
UA_ARCHIVEFLAG_ACCESS 0x00000001 También se genera una columna adicional con la

hora del último acceso
UA_ARCHIVEFLAG_USER 0x00000002 También se genera una columna adicional con el
nombre de usuario
Tipos de comunicación
UA_COMMTYPE_NONE 1 Ninguna conexión de variables

UA_COMMTYPE_RAW 2 Comunicación a través de variable de datos sin formato
UA_COMMTYPE_DIRECT 3 Comunicación a través de variable DM
Tipos de campos
UA_FIELDTYPE_INTEGER 1 Tipo de campo INT

UA_FIELDTYPE_DOUBLE 2 Tipo de campo double
UA_FIELDTYPE_FLOAT 3 Tipo de campo float
UA_FIELDTYPE_STRING 6 Tipo de campo String / ByteArray terminado en null
UA_FIELDTYPE_DATETIME 8 Tipo de campo para fecha y hora
Flags de campo
UA_FIELDFLAG_UNIQUE 0x00000001 El campo debe tener un valor unívoco

UA_FIELDFLAG_NOTNULL 0x00000002 El campo debe tener un valor
UA_FIELDFLAG_INDEX 0x00000010 El campo debe estar soportado por índice
Longitudes máximas
UA_MAXLEN_NAME 20 Longitud máxima del nombre de fichero o de campo

UA_MAXLEN_ALIAS 50 Longitud máxima del 2º nombre adicional o comentario
UA_MAXLEN_PLCID 8 Longitud máxima del nombre del dispositivo de comunica‐
ción
UA_MAXLEN_DMVARNAME 128 Longitud máxima del nombre de variable del administrador
de datos
UA_MAXLEN_VALUE 255 Longitud máxima para variable String
Constantes de parámetros:
Acciones
UA_ACTION_GENERIC 0 Configuración
UA_ACTION_INSERT 1 Pegar

UA_ACTION_UPDATE 2 Sincronizar/sobrescribir
UA_ACTION_DELETE 3 Borrar
Valores Move
UA_MOVE_FIRST 0 Posicionar en el primer registro

UA_MOVE_NEXT 1 Posicionar en el siguiente registro
UA_MOVE_PREVIOUS -1 Posicionar en el registro anterior
UA_MOVE_LAST 0x80000000 Posicionar en el último registro
Tipos de archivo de importación y exportación
UA_FILETYPE_DEFAULT 0 El ajuste predeterminado es el tipo de archivo CSV

UA_FILETYPE_CSV 1 Tipo de archivo (Comma-Seperated-Value)
2.9.2.1 uaGetLastError (RT Professional)
Descripción
Muchas funciones se basan en un valor booleano. TRUE significa un procesamiento de la
función sin errores. Cuando se retorna el valor FALSE, puede leerse el error de la última
función utilizada con la función uaGetLastError.
uaGetLastError entrega siempre el último error producido. En caso de saber exactamente en
cual función se ha producido un error, debe evaluarse el retorno después de cada llamada de
una función y llamarse en caso necesario uaGetLastError.
Ejemplo para funciones con valor de retorno
if ( uaArchiveGetFieldValueLong ( hArchive, Index, &IntValue ) == TRUE )

printf( "Field Value = %u\n", IntValue );
else
printf("Error calling uaArchiveGetFieldValueLong: %d / %08lx\n", uaGetLastError(),
uaGetLastHResult());

Ejemplo para funciones sin valor de retorno
uaArchiveGetFilter(hArchive, pszFilter, cMaxLen);

INT nUAError = uaGetLastError ( );
if ( UA_ERROR_SUCCESS != nUAError)
{
printf( "Filter = [%s]\n", pszFilter );
}
else
{
rintf("Error calling uaArchiveGetFilter: %d, hr=0x%08lX\n", nUAError,
uaGetLastHResult());
}
INT uaGetLastError()
Valor de retorno
Estado de fallo de la última función que se ha ejecutado. Las constantes de error y los
Predefines se encuentran predefinidos en CCUACAPI.H.
UA_ERROR_SUCCESS Sin errores, todo aceptable.

UA_ERROR_GENERIC Error en función de configuración.
UA_ERROR_CONNECT_FAILED Sin establecimiento de una conexión Runtime.
UA_ERROR_OPEN_FAILED No es posible abrir el fichero.
UA_ERROR_CLOSE_FAILED No es posible cerrar el fichero, o handle no es válido.
UA_ERROR_REQUERY_FAILED No se ha podido ejecutar la reintegración en el fichero, p.
ej. con un nuevo filtro / una nueva clasificación.
UA_ERROR_MOVE_FAILED No se ha podido ejecutar el nuevo posicionamiento First,
Last, Next o Previous.
UA_ERROR_INSERT_FAILED No se ha podido insertar el registro de datos en la posición
indicada. Compruebe la posición.
UA_ERROR_UPDATE_FAILED No se ha podido actualizar el registro de datos. El registro
de datos está bloqueado o en esta posición no se encuen‐
tra ningún registro de datos.
UA_ERROR_DELETE_FAILED No se ha(n) podido borrar (todos) el(los) registro(s) de da‐
tos.
UA_ERROR_IMPORT_FAILED No se ha podido importar exitosamente un fichero. Com‐
pruebe el formato y tamaño del fichero.
UA_ERROR_EXPORT_FAILED No se ha podido exportar exitosamente el fichero de usua‐
rio. Compruebe el tamaño de la posición de memoria.
UA_ERROR_READ_FAILED No se ha podido ejecutar la lectura de las variables.
UA_ERROR_WRITE_FAILED No se ha podido ejecutar la escritura en las variables.
UA_ERROR_GET_FAILED No se ha podido ejecutar la lectura de la descripción de
fichero / campo, o bien de los valores del registro de datos.
UA_ERROR_SET_FAILED No se ha podido ejecutar la escritura de la descripción de
fichero / campo, o bien de los valores del registro de datos.
UA_ERROR_INVALID_NAME No es un nombre válido.
UA_ERROR_INVALID_TYPE No es un tipo válido
UA_ERROR_INVALID_NUMRECS Cantidad de registros de datos no es válida.

UA_ERROR_INVALID_COMMTYPE Se ha seleccionado una conexión errónea de None / Raw /

Direct.
UA_ERROR_INVALID_LENGTH El largo (de string) indicado no es válido.
UA_ERROR_INVALID_PRECISION El número indicado de decimales no es válido
UA_ERROR_NULL_POINTER Se ha transferido un puntero CERO.
UA_ERROR_INVALID_POINTER El puntero especificado no es válido.
UA_ERROR_INVALID_HANDLE El handle especificado no es válido.
UA_ERROR_INVALID_INDEX El índice especificado no es válido
UA_ERROR_SERVER_UNKNOWN El servidor indicado y utilizado es desconocido.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
2.9.2.2 uaIsActive (RT Professional)
Descripción
Comprueba si se utiliza una receta en un Runtime activado.
Declaración
BOOL uaIsActive (
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
Valor de retorno
TRUE
Receta se utiliza en Runtime activado.
FALSE
Receta no se utiliza en Runtime activado.

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
uaConnect (Página 951) Establecer handle
Consulte también
uaConnect (Página 951)
2.9.2.3 uaUsers (RT Professional)
Descripción
Lista del número de todos los usuarios que están conectados con la receta a través de
uaConnect. Junta a las llamadas por el usuario, p. ej., mediante scripts, se consideran aquí
también las llamadas internas de WinCC.
Declaración
LONG uaUsers (
Parámetros
hConnect
Valor de retorno
Número de conexiones activas
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.2.4 uaSetLocalEvents (RT Professional)
Descripción
Coloca eventos locales.
Declaración
void uaSetLocalEvents (
UAHCONNECT hConnect
BOOL bLocalEvents )
Parámetros
hConnect
bLocalEvents
Evento local
Valor de retorno
Sin valor de retorno
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.3 Funciones para establecimiento de conexión (RT Professional)
2.9.3.1 uaConnect (RT Professional)
Descripción
Establece en Runtime la conexión con una receta.
Declaración
BOOL uaConnect (
UAHCONNECT* phConnect )
Parámetros
phConnect
Puntero sobre el handle de la receta.
Valor de retorno
TRUE
Conexión establecida con la receta
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observaciones
El handle suministrado es necesario para las funciones uaDisconnect, uaIsActive, uaUsers,
uaOpenViews, uaOpenArchives, uaQueryArchive y uaQueryArchiveByName.

uaDisconnect (Página 952) Interrumpir la conexión
Consulte también
uaIsActive (Página 948)
uaUsers (Página 949)
uaSetLocalEvents (Página 950)
uaDisconnect (Página 952)
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaOpenArchives (Página 974)
uaOpenViews (Página 1002)
2.9.3.2 uaDisconnect (RT Professional)
Descripción
Cuando en Runtime existe una conexión con una receta, se interrumpe la conexión.
Declaración
BOOL uaDisconnect (
Parámetros
hConnect
Valor de retorno
TRUE
Conexión interrumpida.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Consulte también
2.9.3.3 uaQueryArchive (RT Professional)
Descripción
Establece la conexión con una receta. uaQueryArchive crea el handle phArchive.
Declaración
BOOL uaQueryArchive (
LONG lArchive,
Parámetros
hConnect
lArchive
ID del fichero que debe conectarse.
phArchive
Puntero sobre el handle de la receta conectada.
Valor de retorno
TRUE

FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observaciones
Si solo hay disponible un índice de ficheros, la ID del fichero puede determinarse con la función
de configuración uaGetArchive.
Consulte también
uaReleaseArchive (Página 958)
uaArchiveClose (Página 961)
uaArchiveDelete (Página 962)
uaArchiveExport (Página 963)
uaArchiveGetID (Página 965)
uaArchiveGetName (Página 966)
uaArchiveGetSort (Página 967)
uaArchiveImport (Página 968)
uaArchiveOpen (Página 969)
uaArchiveUpdate (Página 971)
uaArchiveGetCount (Página 975)
uaArchiveGetFilter (Página 976)
uaArchiveInsert (Página 977)
uaArchiveMoveFirst (Página 978)
uaArchiveMoveLast (Página 979)
uaArchiveMoveNext (Página 980)
uaArchiveMovePrevious (Página 981)
uaArchiveGetFieldLength (Página 983)

uaArchiveGetFields (Página 985)

uaArchiveGetFieldType (Página 986)
uaArchiveGetFieldName (Página 984)
uaArchiveGetFieldValueDate (Página 987)
uaArchiveGetFieldValueDouble (Página 988)
uaArchiveGetFieldValueLong (Página 990)
uaArchiveSetFieldValueDate (Página 992)
uaArchiveSetFieldValueDouble (Página 993)
uaArchiveSetFieldValueLong (Página 994)
uaArchiveSetFieldValueString (Página 996)
uaArchiveRequery (Página 998)
uaArchiveSetFilter (Página 999)
uaArchiveSetSort (Página 1001)
uaArchiveReadTagValues (Página 1003)
uaArchiveReadTagValuesByName (Página 1004)
uaArchiveWriteTagValues (Página 1005)
uaArchiveWriteTagValuesByName (Página 1007)
2.9.3.4 uaQueryArchiveByName (RT Professional)
Descripción
Establece la conexión con una receta a través del nombre. uaQueryArchiveByName crea el
handle phArchive.
Declaración
BOOL uaQueryArchiveByName (
LPCSTR pszName,
Parámetros
hConnect

pszName
Nombre de la receta.
phArchive
Puntero sobre el handle de la receta conectada.
Valor de retorno
TRUE
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observaciones
Si solo hay disponible un índice de ficheros, el nombre del fichero puede determinarse con la
función de configuración uaGetArchive.
Consulte también
uaReleaseArchive (Página 958)
uaArchiveDelete (Página 962)
uaArchiveGetID (Página 965)
uaArchiveGetName (Página 966)
uaArchiveGetSort (Página 967)

uaArchiveUpdate (Página 971)

uaArchiveGetCount (Página 975)
uaArchiveGetFilter (Página 976)
uaArchiveInsert (Página 977)
uaArchiveMoveFirst (Página 978)
uaArchiveMoveLast (Página 979)
uaArchiveMoveNext (Página 980)
uaArchiveMovePrevious (Página 981)
uaArchiveGetFieldLength (Página 983)
uaArchiveGetFields (Página 985)
uaArchiveGetFieldType (Página 986)
uaArchiveGetFieldName (Página 984)
uaArchiveGetFieldValueDate (Página 987)
uaArchiveGetFieldValueDouble (Página 988)
uaArchiveGetFieldValueLong (Página 990)
uaArchiveSetFieldValueDate (Página 992)
uaArchiveSetFieldValueDouble (Página 993)
uaArchiveSetFieldValueLong (Página 994)
uaArchiveSetFieldValueString (Página 996)
uaArchiveRequery (Página 998)
uaArchiveSetFilter (Página 999)
uaArchiveSetSort (Página 1001)
2.9.3.5 uaQueryConfiguration (RT Professional)
Descripción
Establece la conexión con una receta para la configuración.

Declaración
BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )
Parámetros
phConfig
Puntero sobre el handle de la receta.
Valor de retorno
TRUE
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Consulte también
uaReleaseConfiguration (Página 960)
uaGetArchive (Página 972)
uaGetNumArchives (Página 973)
uaGetNumFields (Página 982)
uaGetField (Página 997)
2.9.3.6 uaReleaseArchive (RT Professional)
Descripción
Establece la conexión con la receta actualmente conectada.

Declaración
BOOL uaReleaseArchive (
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observación
En la interrupción exitosa de la conexión debe aplicarse el handle hArchive en NULL. En caso
de una utilización posterior del handle que ya no está válido, se genera el error
UA_ERROR_INVALID_HANDLE. Se evita una carga innecesaria de la memoria.
uaQueryArchive (Página 953) Establecer handle

uaQueryArchiveByName (Página 955) Establecer handle
Consulte también

2.9.3.7 uaReleaseConfiguration (RT Professional)
Descripción
Interrumpe la conexión después de la configuración de la receta.
Declaración
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )
Parámetros
hConfig
Handle sobre la receta. Este handle se establece con uaQueryConfiguration.
bSave
Determina que las modificaciones en la configuración se guardan antes de interrumpir la
conexión.
TRUE Guardar modificaciones

FALSE Rechazar modificaciones
Nota
¡bSave = TRUE se debe usar solamente cuando la receta no se utiliza en un WinCC Runtime
activado! Con la función uaIsActive se comprueba si Runtime está activo.
Valor de retorno
TRUE
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

uaQueryConfiguration (Página 957) Establecer handle
Consulte también
2.9.4 Funciones para la edición de recetas (RT Professional)
2.9.4.1 uaArchiveClose (RT Professional)
Descripción
Cierra una receta abierta.
Declaración
BOOL uaArchiveClose (
Parámetros
hArchive
Valor de retorno
TRUE
Receta cerrada.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


uaArchiveOpen (Página 969) Abrir receta
Consulte también
2.9.4.2 uaArchiveDelete (RT Professional)
Descripción
Borra los datos de una receta. La receta proyectada se conserva.
Declaración
BOOL uaArchiveDelete (
LPCSTR pszWhere )
Parámetros
hArchive
pszWhere
String con selección SQL de los registros de datos a borrar. El string corresponde a la
instrucción SQL DELETE FROM <archive> WHERE pszWhere.
Nota
Cuando pszWhere está vacío, se borra todo el fichero de usuario.
Valor de retorno
TRUE
Datos borrados.

FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.4.3 uaArchiveExport (RT Professional)
Descripción
Exporta los datos de una receta en un archivo CSV.
Declaración
BOOL uaArchiveExport (
LPCSTR pszDestination,
LONG lType,
LONG lOptions )
Parámetros
hArchive

pszDestination
Nombre del archivo de destino. En caso de llamada de la función en un cliente, la indicación
de ruta se refiere al servidor.
lType
Formato de nombre del archivo de destino. Los dos formatos disponibles son:
UA_FILETYPE_DEFAULT = 0 El formato de archivo predeterminado CSV prea‐

justado
UA_FILETYPE_CSV = 1 Formato de archivo CSV
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Datos exportados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

uaArchiveImport (Página 968) Importar datos
Consulte también

2.9.4.4 uaArchiveGetID (RT Professional)
Descripción
Lee el ID de una receta
Valor de retorno
"ID" del fichero de usuario
Declaración
LONG uaArchiveGetID (
Parámetros
hArchive
Valor de retorno
ID de la receta
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también

2.9.4.5 uaArchiveGetName (RT Professional)
Descripción
Lee el nombre de una receta.
Declaración
VOID uaArchiveGetName (
LPSTR pszName,
LONG cMaxLen )
Parámetros
hArchive
pszName
Puntero sobre el búfer para el nombre de la receta.
cMaxLen
Longitud máxima.
Valor de retorno
Sin valor de retorno.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


Ejemplo
char tank [40];

uaArchiveGetName( hArchive, tank, 39 );
Consulte también
2.9.4.6 uaArchiveGetSort (RT Professional)
Descripción
Lee el criterio de clasificación de la receta.
Declaración
VOID uaArchiveGetSort (
LPSTR pszSort,
LONG cMaxLen )
Parámetros
hArchive
pszSort
Criterio de clasificación como instrucción SQL.
cMaxLen
Longitud máxima.
Valor de retorno
Sin valor de retorno
Archivos requeridos
ccuacapi.h

ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.4.7 uaArchiveImport (RT Professional)
Descripción
Importa los datos de un archivo CSV en una receta. La estructura de la receta debe ser idéntica
al fichero CSV importado.
Declaración
BOOL uaArchiveImport (
LPCSTR pszSource,
LONG lType,
LONG lOptions )
Parámetros
hArchive
pszSource
Nombre del archivo con los datos a importar.
lType
Formato de datos del archivo de origen. Los dos formatos disponibles son:
UA_FILETYPE_DEFAULT = 0 El formato de archivo predeterminado CSV prea‐

justado
UA_FILETYPE_CSV = 1 Formato de archivo CSV

lOptions
Valor de retorno
TRUE
Datos importados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

uaArchiveExport (Página 963) Exportar datos
Consulte también
2.9.4.8 uaArchiveOpen (RT Professional)
Descripción
Abre una receta. La llamada de uaArchiveOpen se requiere para las operaciones de lectura
o escritura en la receta. Por ejemplo para la llamada de las funciones uaArchiveMoveNext,
uaArchiveDelete o uaArchiveUpdate.

Declaración
BOOL uaArchiveOpen (
Parámetros
hArchive
Valor de retorno
TRUE
Receta abierta.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

uaArchiveClose (Página 961) Cerrar la receta
Consulte también

2.9.4.9 uaArchiveUpdate (RT Professional)
Descripción
Actualiza una receta abierta. Los datos de receta modificados se adoptan en la base de datos.
La estructura de la receta permanece inalterada.
Declaración
BOOL uaArchiveUpdate (
U AHARCHIVE hArchive )
Parámetros
hArchive
Valor de retorno
TRUE
Datos de receta actualizados.
FALSE
En caso de una violación de consistencia se presenta el error Update_failed = 106. Una
violación de consistencia surge p. ej. cuando para un campo se ha activado la propiedad
"Campo debe poseer un valor", pero no se encuentra un valor en el campo.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


Consulte también
2.9.4.10 uaGetArchive (RT Professional)
Descripción
Lee la configuración de una receta.
Declaración
BOOL uaGetArchive (
UAHCONFIG hConfig,
Long lArchive,
Parámetros
hArchive
lArchive
Índice de la receta. Valor: 0... uaGetNumArchives() -1
pArchive
Puntero sobre el búfer para los datos de configuración.
Valor de retorno
TRUE
Acceso exitoso.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.4.11 uaGetNumArchives (RT Professional)
Descripción
Lee el número de las recetas actualmente configuradas.
Declaración
LONG uaGetNumArchives (
UAHCONFIG hConfig )
Parámetros
hConfig
Valor de retorno
Número de recetas configuradas. En caso de un error se retorna -1.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.4.12 uaOpenArchives (RT Professional)
Descripción
Determina el número de las recetas abiertas en Runtime.
Declaración
LONG uaOpenArchives (
Parámetros
hArchive
Handle sobre la receta. Este handle se establece con uaConnect.
Valor de retorno
Número de recetas abiertas.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Consulte también

2.9.5 Funciones para la edición de elementos de receta (RT Professional)
2.9.5.1 uaArchiveGetCount (RT Professional)
Descripción
Lee la cantidad de registros de datos.
Valor de retorno
Cantidad de registros de datos. Con "0", el fichero está vacío o se ha producido un error. Con
consulta se requiere con "uaGetLastError".
Declaración
LONG uaArchiveGetCount(
LONG * plCount )
Parámetros
hArchive
plCount
Puntero sobre una variable, en el cual se deposita el número de registros de datos.
Valor de retorno
Cantidad de registros de datos. Con 0, el fichero está vacío o se ha producido un error. La
consulta debe realizarse con uaGetLastError.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


Consulte también
2.9.5.2 uaArchiveGetFilter (RT Professional)
Descripción
Lee los criterios de selección del registro actual de datos.
Declaración
VOID uaArchiveGetFilter (
LPSTR pszFilter,
LONG cMaxLen )
Parámetros
hArchive
pszFilter
Criterio de selección como instrucción SQL.
cMaxLen
Longitud máxima.
Valor de retorno
Sin valor de retorno.
Archivos requeridos
ccuacapi.h
ccuacapi.lib

ccuacapi.dll

Consulte también
2.9.5.3 uaArchiveInsert (RT Professional)
Descripción
Añade el búfer local de registro de datos a la receta. Para que en el registro de datos se
encuentren datos apropiados, antes de acceder a uaArchiveInsert, se tienen que escribir los
campos del búfer local de registro de datos con las funciones uaArchiveSetFieldValue....
El campo "ID" debe escribirse con la función uaArchiveSetFieldValueLong con un ID todavía
no existente en el fichero o bien con 0."
Declaración
BOOL uaArchiveInsert (
Parámetros
hArchive
Valor de retorno
TRUE
Registro de datos añadido.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.5.4 uaArchiveMoveFirst (RT Professional)
Descripción
Va al primer registro.
Declaración
BOOL uaArchiveMoveFirst (
Parámetros
hArchive
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.5.5 uaArchiveMoveLast (RT Professional)
Descripción
Va al último registro.
Declaración
BOOL uaArchiveMoveLast (
Parámetros
hArchive
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.5.6 uaArchiveMoveNext (RT Professional)
Descripción
Ir al siguiente registro de datos.
Declaración
BOOL uaArchiveMoveNext (
Parámetros
hArchive
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.5.7 uaArchiveMovePrevious (RT Professional)
Descripción
Ir al registro de datos anterior.
Declaración
BOOL uaArchiveMovePrevious (
Parámetros
hArchive
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.5.8 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 … uaGetNumFields() -1".
Declaración
LONG uaGetNumFields (
UAHCONFIG honfig,
long lArchive )
Parámetros
hConfig
lArchive
Valor de retorno
Cantidad de campos configurados. En caso de un error se retorna -1.

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Consulte también
2.9.6 Funciones para la edición de campos (RT Professional)
2.9.6.1 uaArchiveGetFieldLength (RT Professional)
Descripción
Lee la longitud de un campo en el registro de datos actual.
Declaración
LONG uaArchiveGetFieldLength(
LONG lField )
Parámetros
hArchive
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
Valor de retorno
Longitud del campo actual.

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.2 uaArchiveGetFieldName (RT Professional)
Descripción
Lee el nombre de un campo en el registro de datos actual.
Declaración
VOID uaArchiveGetFieldName (
LONG lField,
LPCSTR pszName,
LONG cMaxLen )
Parámetros
hArchive
lField
pszName
Nombre de campo

cMaxLen
Longitud máxima
Valor de retorno
TRUE
Nombre leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
AUTOHOTSPOT Establecer handle

Consulte también
2.9.6.3 uaArchiveGetFields (RT Professional)
Descripción
Lee la cantidad de registros de datos configurados. Los campos "ID", "Último usuario" y "Último
acceso" se cuentan. En los accesos de Runtime se indican los índices de los campos
configurados con 1 ... N. El campo "ID" tiene el índice "0". Los campos "Último usuario" y
"Último acceso" se añaden al final de los campos configurados.
Declaración
LONG uaArchiveGetFields (

Parámetros
hArchive
Valor de retorno
Cantidad de campos configurados.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.4 uaArchiveGetFieldType (RT Professional)
Descripción
Lee el tipo de un campo en el registro de datos actual.
Declaración
LONG uaArchiveGetFieldType (
LONG lField )
Parámetros
hArchive

lField
Valor de retorno
Tipo del campo actual. Las denominaciones simbólicas para los tipos de campo son:
UA_FIELDTYPE_INTEGER
UA_FIELDTYPE_FLOAT
UA_FIELDTYPE_DOUBLE
UA_FIELDTYPE_STRING
UA_FIELDTYPE_DATETIME
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.5 uaArchiveGetFieldValueDate (RT Professional)
Descripción
Lee la fecha y la hora de un campo en el registro de datos actual.
Declaración
BOOL uaArchiveGetFieldValueDate (
LONG lField,

Parámetros
hArchive
lField
pstDateTime
Puntero sobre la variable del tipo SYSTEMTIME.
Valor de retorno
TRUE
Fecha y hora leídas.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.6 uaArchiveGetFieldValueDouble (RT Professional)
Descripción
Lee un valor del tipo de datos Double de un campo del registro actual de datos.

Declaración
BOOL uaArchiveGetFieldValueDouble (
LONG lField,
double* pdValue )
Parámetros
hArchive
lField
pdValue
Puntero sobre la variable para el valor del campo.
Valor de retorno
TRUE
Valor leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también

2.9.6.7 uaArchiveGetFieldValueLong (RT Professional)
Descripción
Lee un valor del tipo de datos Long de un campo del registro actual de datos.
Declaración
BOOL uaArchiveGetFieldValueLong (
LONG lField,
LONG* pdValue )
Parámetros
hArchive
lField
pdValue
Valor de retorno
TRUE
Valor leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


Consulte también
2.9.6.8 uaArchiveGetFieldValueString (RT Professional)
Descripción
Lee un valor del tipo de datos String de un campo del registro actual de datos.
Declaración
BOOL uaArchiveGetFieldValueString (
LONG lField,
LPSTR pszString,
LONG cMaxLen )
Parámetros
hArchive
lField
pszString
pdValue
Longitud máxima del string.
Valor de retorno
TRUE
Valor leído.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.9 uaArchiveSetFieldValueDate (RT Professional)
Descripción
Escribe la fecha y la hora en un campo en el registro de datos actual.
Declaración
BOOL uaArchiveSetFieldValueDate (
LONG lField,
Parámetros
hArchive
lField
pstDateTime
Fecha y hora.

Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.10 uaArchiveSetFieldValueDouble (RT Professional)
Descripción
Escribe un valor del tipo de datos Double en un campo en el registro actual de datos.
Declaración
BOOL uaArchiveSetFieldValueDouble (
LONG lField,
double dValue )
Parámetros
hArchive

lField
dValue
Valor que se va a escribir.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.6.11 uaArchiveSetFieldValueLong (RT Professional)
Descripción
Escribe un valor del tipo de datos Long en un campo en el registro actual de datos.

Declaración
BOOL uaArchiveSetFieldValueLong (
LONG lField,
LONG dValue )
Parámetros
hArchive
lField
dValue
Valor que se va a escribir.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también

2.9.6.12 uaArchiveSetFieldValueString (RT Professional)
Descripción
Escribe un valor del tipo de datos String en un campo en el registro actual de datos.
Declaración
BOOL uaArchiveSetFieldValueString (
LONG lField,
LPCSTR pszString )
Parámetros
hArchive
lField
pszString
Cadena de caracteres que se va a escribir.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


Consulte también
2.9.6.13 uaGetField (RT Professional)
Descripción
Lee la configuración de un campo.
Declaración
BOOL uaGetField (
UAHCONFIG hConfig,
Long lArchive,
Long lField,
Parámetros
hConfig
lArchive
lField
pField
Puntero sobre el búfer para los datos de configuración.
Valor de retorno
TRUE
Configuración leída.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Consulte también
2.9.7 Funciones para la filtración y clasificación (RT Professional)
2.9.7.1 uaArchiveRequery (RT Professional)
Descripción
Después de la llamada de uaArchiveSetFilter y uaArchiveSetSort debe cargarse la receta con
uaArchiveRequery.
Nota
Las funciones uaArchiveSetSort y uaArchiveSetFilter pueden usarse sin abrir la receta con
uaArchiveOpen. En este caso no debe acceder a uaArchiveRequery.
Declaración
BOOL uaArchiveRequery(
Parámetros
hArchive

Valor de retorno
TRUE
Receta nuevamente cargada.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observación
Accede también a uaArchiveRequery cuando ha ingresado vlaores en la indicación de receta
en Runtime.

Consulte también
2.9.7.2 uaArchiveSetFilter (RT Professional)
Descripción
Configura los criterios de selección para la receta. Las funciones pueden accederse también
sin abrir la receta con uaArchiveOpen.
Cuando ha abierto el fichero de usuario con uaArchiveOpen, debe cargar la receta
nuevamente con uaArchiveRequery después de la filtración.

Declaración
VOID uaArchiveSetFilter (
LPSTR pszFilter )
Parámetros
hArchive
pszFilter
Criterio de selección como criterio SQL.
Valor de retorno
TRUE
Criterios de selección modificados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también

2.9.7.3 uaArchiveSetSort (RT Professional)
Descripción
Configura la clasificación de una receta. Las funciones pueden accederse también sin abrir
la receta con uaArchiveOpen.
Cuando ha abierto una receta con uaArchiveOpen, debe cargar la receta nuevamente con
uaArchiveRequery después de la clasificación.
Declaración
BOOL uaArchiveSetSort (
LPSTR pszSort )
Parámetros
hArchive
pszSort
Criterio de clasificación como instrucción SQL.
Valor de retorno
TRUE
Clasificación exitosa.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll


Consulte también
2.9.8 Funciones para la edición de vistas de receta (RT Professional)
2.9.8.1 uaOpenViews (RT Professional)
Descripción
Entrega el número de vistas abiertas en Runtime.
Declaración
LONG uaOpenViews (
Parámetros
hArchive
Handle sobre la receta. Este handle se establece con uaConnect.
Valor de retorno
Número de vistas actualmente abiertas.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll

Consulte también
2.9.9 Funciones para la edición de variables (RT Professional)
2.9.9.1 uaArchiveReadTagValues (RT Professional)
Descripción
Lee los valores actuales de las variables de campos.
Declaración
BOOL uaArchiveReadTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
hArchive
pnFields
cFields
lOptions
Valor de retorno
TRUE
Datos leídos.
FALSE
Error

Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
uaArchiveWriteTagValues (Página 1005) Escribir valores

Consulte también
2.9.9.2 uaArchiveReadTagValuesByName (RT Professional)
Descripción
Lee los valores actuales de las variables.
Declaración
BOOL uaArchiveReadTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parámetros
hArchive
pszFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con NULL.
lOptions

Valor de retorno
TRUE
Datos leídos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
uaArchiveWriteTagValuesByName (Página 1007) Leer valores

Consulte también
2.9.9.3 uaArchiveWriteTagValues (RT Professional)
Descripción
Escribe los valores del registro de datos actual en la variable.
Declaración
BOOL uaArchiveWriteTagValues (
LONG* pnFields,
LONG cFields,
LONG lOptions )

Parámetros
hArchive
pnFields
cFields
lOptions
Valor de retorno
TRUE
Escribir datos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
uaArchiveReadTagValues (Página 1003) Leer valores

Consulte también

2.9.9.4 uaArchiveWriteTagValuesByName (RT Professional)
Descripción
Escribe los valores del registro de datos actual en la variable.
Declaración
BOOL uaArchiveWriteTagValuesByName (
LPCSTR pszFields,
LONG lOptions )
Parámetros
hArchive
pszFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con NULL.
lOptions
Valor de retorno
TRUE
Escribir datos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
uaArchiveReadTagValuesByName (Página 1004) Leer valores


2.10 Funciones para avisos (RT Professional)
Consulte también
Sinopsis
MSG_SERVICE_NOTIFY_PROCPlus (Pági‐ Servicio de envío y recepción (Callback)

na 1057)
MSRTActivateMProtPlus (Página 1061) Detener o continuar el servicio de informes
MSRTCheckWinFilterPlus (Página 1097) Comprobar condiciones de filtro de avisos
MSRTCreateMsgInstancePlus (Página 1068) Crear aviso
MSRTCreateMsgInstanceWithCommentPlus (Pá‐ Crear aviso
gina 1066)
AUTOHOTSPOT Parametrizar texto de comentario
AUTOHOTSPOT Parametrizar filtro de avisos
MSRTDialogMsgLockPlus (Página 1070) Parametrizar bloqueos de avisos
MSRTEnumArchivDataPlus (Página 1049) Listar avisos de un fichero
MSRTEnumBackupListPlus (Página 1110) Listar entradas de una lista de trasvase
MSRTEnumGroupMsgPlus (Página 1091) Listar avisos individuales de grupo de avisos
MSRTEnumProtDataPlus (Página 1062) Listar datos de informe
MSRTExportPlus (Página 1111) Exportar avisos de ficheros de continuación
MSRTGetClassInfoPlus (Página 1075) Consultar información de categorías
MSRTGetCommentInstancePlus (Página 1104) Consultar texto de comentario
MSRTGetFilterDataPlus (Página 1096) Consultar condiciones de filtro de avisos
MSRTGetInfotextPlus (Página 1107) Consultar texto informativo
MSRTGetLastMsgWithCommentPlus (Pági‐ Consultar último aviso de fichero
na 1077)
MSRTGetMsgActualPlus (Página 1079) Determinar número de avisos
MSRTGetMsgCSDataPlus (Página 1080) Consultar datos de configuración de aviso
MSRTGetMsgPriorityPlus (Página 1082) Consultar la prioridad del aviso
MSRTGetMsgQuitPlus (Página 1083) Consultar el número de avisos de acuse obligado
MSRTGetMsgTextPlus (Página 1085) Consultar bloque de texto de aviso

MSRTGetSelectedMsgPlus (Página 1086) Determinar número de aviso

MSRTLoopInAlarmPlus (Página 1090) Loop in Alarm
MSRTMsgWinCommandPlus (Página 1102) Ejecutar función de operación en ventana de avi‐
sos
MSRTPrintMProtPlus (Página 1064) Imprime el informe de avisos pendientes de conti‐
nuación
MSRTQuitGroupPlus (Página 1094) Acusar un grupo de avisos
MSRTQuitHornPlus (Página 1056) Acusar avisador
MSRTResetMsgPlus (Página 1088) Acusar un aviso
MSRTSetCommentInstancePlus (Página 1105) Definir texto de comentario
MSRTSetInfotextPlus (Página 1108) Definir texto informativo
MSRTSetMsgFilterPlus (Página 1099) Aplicar filtro de avisos
MSRTSetMsgWinFilterPlus (Página 1100) Aplicar filtro de avisos para una ventana de avisos
MSRTStartMsgServicePlus (Página 1051) Iniciar servicio de envío y recepción
MSRTStopMsgServicePlus (Página 1055) Detener servicio de envío y recepción
Consulte también
MSRTEnumMsgRTDataPlus (Página 1074)
MSRTLockGroupPlus (Página 1093)
Sinopsis
MSG_BACKUP_STRUCT_PLUS (Página 1046) Lista de trasvase

MSG_CLASS_STRUCT_PLUS (Página 1036) Categoría de aviso
MSG_COMMENT_INSTANCE_STRUCT_PLUS Comentario
(Página 1043)
MSG_CSDATA_STRUCT_PLUS (Página 1039) Aviso individual
MSG_FILTER_STRUCT_PLUS (Página 1029) Filtro de avisos
MSG_INFOTEXT_STRUCT_PLUS (Pági‐ Texto informativo
na 1045)
MSG_RTCREATE_STRUCT_PLUS (Pági‐ Generar un aviso en el sistema runtime
na 1024)
MSG_RTDATA_INSTANCECOM‐ Aviso individual
MENT_STRUCT_PLUS (Página 1026)
MSG_RTDATA_INSTANCE_STRUCT_PLUS Aviso individual
(Página 1033)
MSG_RTGROUPENUM_STRUCT_PLUS (Pági‐ Avisos individuales de un grupo de avisos
na 1041)
MSG_RTGROUPSET_STRUCT_PLUS (Pági‐ Datos de grupos de avisos
na 1042)

MSG_RTLOCK_STRUCT_PLUS (Página 1047) Bloqueo de avisos

MSG_TEXTVAL256_STRUCT_PLUS (Pági‐ Valores asociados de textos
na 1048)
Sinopsis
CMN_ERROR:
Alarm Logging CS
MSG_ERR_CS_CONNECT 0x00001001 No hay conexión con Alarm Logging CS o con

el proyecto.
MSG_ERR_CS_PROJECT 0x00001002 Proyecto incorrecto o no válido
MSG_ERR_CS_PROJECTNAME 0x00001003 Nombre de proyecto incorrecto o no válido
MSG_ERR_CS_PARAM 0x00001004 Parámetro incorrecto; dwError2 contiene el
número del parámetro incorrecto.
MSG_ERR_CS_NODATA 0x00001005 No se han encontrado datos
MSG_ERR_CS_STRUCTFIELD 0x00001006 Error en un campo de estructura; dwError2
contiene el número del campo de estructura
en el que se encuentra el valor incorrecto.
MSG_ERR_CS_DBCONNECT 0x00001011 DBConnect no es posible
MSG_ERR_CS_DBCDELETE 0x00001012 Error al borrar (¿no hay datos?)
MSG_ERR_CS_DBOPEN 0x00001013 No se ha podido abrir la tabla con avisos indi‐
viduales
MSG_ERR_CS_SOURCES 0x00001014 ¿No hay más memoria?
MSG_ERR_CS_CREATOR_ID 0x00001015 CreatorID es WinCC-CreatorID
MSG_ERR_CS_NOTSUPPORTED 0x00001016 Función no soportada
MSG_ERR_UNKNOWN_ERROR 0x00001020 Ha ocurrido un error no especificado con
exactitud (a partir de WinCC V6.0).
MSG_ERR_API_TERMINATED 0x00001021 La ejecución se ha interrumpido antes de
tiempo (a partir de WinCC V6.0).
MSG_ERR_NO_MEMORY 0x00001022 Memoria principal insuficiente (a partir de
WinCC V6.0)
MSG_ERR_DB_FAIL 0x00001023 Base de datos incoherente (a partir de WinCC
V6.0)
MSG_ERR_I_WRITE 0x00001024 Los datos no se han podido registrar en la
base de datos. dwError2 y dwError3 contienen
más información. (a partir de WinCC V6.0)
MSG_ERR_CS_EXIST 0x00001025 El elemento ya existe (a partir de WinCC V6.0)
MSG_ERR_CS_NO_EXIST 0x00001026 El elemento no existe (a partir de WinCC V6.0)
MSG_ERR_HANDLE 0x00000090 Handle no válido

Alarm Logging RT
MSG_ERR_RT_NOTCONNECTED 0x00000001 No se ha establecido la conexión con

Alarm Logging RT
MSG_ERR_RT_NOINIT 0x00000002 Alarm Logging RT no inicializado
MSG_ERR_RT_SERVICEMAX 0x00000003 Cantidad máxima de servicios alcanzada
MSG_ERR_MSG_NOEXIST 0x00000010 El aviso no existe
MSG_ERR_MSG_NOTFOUND 0x00000011 Aviso no encontrado
MSG_ERR_MSG_NOQUIT 0x00000012 Aviso no sujeto a obligación de acuse
MSG_ERR_MSG_ALREADYQUIT 0x00000013 Aviso ya acusado
MSG_ERR_MSG_NOCLASS 0x00000014 Información de categoría no disponible
MSG_ERR_MSG_STATE 0x00000015 Estado de aviso desconocido
MSG_ERR_MSG_LOCKED 0x00000016 Aviso bloqueado
MSG_ERR_MSG_DATETIME 0x00000017 El aviso tiene una fecha u hora no válida
MSG_ERR_WIN_NAMENOTFOUND 0x00000020 Nombre de plantilla no encontrado
MSG_ERR_WIN_CREATE 0x00000021 Error al crear la ventana de avisos
MSG_ERR_WIN_DATA 0x00000022 Datos de ventana de avisos no válidos
MSG_ERR_VAR_BITEXCEEDS_ 0x00000030 Bit para variable no válida
MSG_ERR_VAR_NOCHANGE_ 0x00000031 Ninguna modificación de variables
MSG_ERR_VAR_PROCESS_USED_ 0x00000032 La variable de evento ya está asignada
MSG_ERR_VAR_QUIT_USED_ 0x00000033 La variable de acuse ya está asignada
MSG_ERR_VAR_STATE_USED_ 0x00000034 La variable de estado ya está asignada
MSG_ERR_VAR_VARIANTCONV_ 0x00000035 Error al convertir Variant
MSG_ERR_VAR_USED_TYPDIFF_ 0x00000036 Variable de evento asignada, tipos dife‐
rentes (Quit, Create, ...)
MSG_ERR_HANDLE 0x00000090 Handle no válido
MSG_ERR_FILTER 0x00000091 Condición de filtro no válida
MSG_ERR_API_PARAM 0x00000095 Parámetro no válido
MSG_ERR_API_SERVICE 0x00000099 dwServiceID no válido
MSG_ERR_API_EXCEPTION 0x0000009a Se ha producido una situación excepcio‐
nal en el código
MSG_ERR_API_DATETIME 0x0000009b Sello de fecha y hora no válido
MSG_ERR_API_SERVICEMAX 0x0000009c Cantidad máxima de servicios alcanzada
MSG_ERR_API_NODATA 0x0000009d Ningún dato
MSG_ERR_PROT_ID 0x00000111 Identificación de informe no válida
MSG_ERR_PROT_BLOCKS 0x00000110 No hay bloques en el informe
MSG_ERR_PROT_ACTIVE 0x00000112 Servicio de informes ya activo
MSG_ERR_NODEFAULTSERVER 0x00000401 Ningún servidor estándar configurado
MSG_ERR_NOLOCALSERVER 0x00000402 No hay ningún servidor local disponible
MSG_ERR_NOSERVER 0x00000403 Ningún servidor estándar configurado y
ningún servidor local disponible
MSG_ERR_NOMC 0x00000404 No hay ningún proyecto multicliente
(aquí no se utiliza)
MSG_ERR_NOMCDEFAULTSERVER 0x00000405 No hay ningún proyecto multicliente y se
ha indicado "@default" (aquí no se utiliza)

Especificaciones generales
MSG_MAX_CLASS (Valor: 18) Número de categorías de avisos

MSG_MAX_CLASSTYPE (Valor: 16) Número de tipos de avisos en
categoría
MSG_MAX_PVALUE (Valor: 10) Número de valores de proceso
MSG_MAX_TB (Valor: 10) Número de textos de usuario
MSG_MAX_HITLIST (Valor: 7) Número de elementos de listas
de resultados
MSG_MAX_TB_CONTENT (Valor: 255) Número de caracteres por texto
de usuario
MSG_MAX_TEXTLEN (Valor: 64) Número de caracteres para to‐
dos los textos
MSG_MAX_TEXTVALUE (Valor: 32) Número de caracteres de valo‐
res asociados de textos
MSG_MAX_TEXTVALUE256 (Valor: 256) Número de caracteres de valo‐
res asociados de textos
MSG_MAX_STATE (Valor: 4) Número de textos de estado
MSG_MAX_LOCKITEMS (Valor: 16) Número de avisos para un blo‐
queo
MSG_MAX_LEVEL (Valor: 6) Número de nodos para avisos
de grupo
MSG_MAX_MSG_COUNT (Valor: 150000) Número máximo de avisos indi‐
Antes de V6.2: (Valor: 50000) viduales en el proyecto
MSG_MAX_GROUPITEMS (Valor: 1000) Número de avisos para un gru‐
po en Enum
MSG_MAX_USERNAME (Valor: 16) Longitud máxima de un nombre
de usuario
MSG_MAX_APPLNAME (Valor: 32) Longitud máxima de un nombre
de aplicación
MSG_MAX_INSTANCE (Valor: 512) Nombre de instancia
MSG_MAX_ARCHIV_QUEUE (Valor: 1500) Número máx. de entradas de fi‐
chero almacenables en búfer
Estados de aviso
MSG_STATE_COME (Valor: 0x00000001) Aviso aparecido

MSG_STATE_GO (Valor: 0x00000002) Aviso desaparecido
MSG_STATE_QUIT (Valor: 0x00000003) Aviso acusado
MSG_STATE_LOCK (Valor: 0x00000004) Aviso bloqueado
MSG_STATE_UNLOCK (Valor: 0x00000005) Habilitación de aviso
MSG_STATE_HIDE (Valor: 0x0000000A) Aviso oculto
MSG_STATE_UNHIDE (Valor: 0x0000000B) Aviso visualizado
MSG_STATE_HIDE_MANUAL (Valor: 0x0000000C) Aviso ocultado manualmente

MSG_STATE_UNHIDE_MA‐ (Valor: 0x0000000D) Aviso visualizado manualmente

NUAL
MSG_STATE_QUIT_SYSTEM (Valor: 0x00000010) Aviso acusado por el sistema
MSG_STATE_QUIT_EMER‐ (Valor: 0x00000011) Acuse de emergencia
GENCY
MSG_STATE_QUIT_HORN (Valor: 0x00000012) Acuse de bocina
MSG_STATE_COMEGO (Valor: 0x00000013) Aviso aparecido y desapareci‐
do, sólo se visualiza en lista de
avisos
MSG_STATE_RESET (Valor: 0x00020000) Bit de inicialización de aviso
MSG_STATE_SUMTIME (Valor: 0x00040000) Bit para horario de verano acti‐
vado
MSG_STATE_INSTANCE (Valor: 0x00080000) Bit para aviso de instancia (n
avisos de un n.º)
MSG_STATE_TIMEINVALID (Valor: 0x00100000) Bit para sello no válido de fecha/
hora
Combinación lógica O con
(MSG_STATE_COME,
MSG_STATE_GO, ....)
MSG_STATE_HIDDEN (Valor: 0x02000000) Bit para aviso actualmente ocul‐
to, disponible a partir de V6.2
Flags de un aviso en la tabla de base de datos
MSG_FLAG_SUMTIME (Valor: 0x00000001) Horario de verano activado

MSG_FLAG_COMMENT (Valor: 0x00000002) El aviso tiene comentario
MSG_FLAG_ARCHIV (Valor: 0x00000004) Archivar
MSG_FLAG_PROTOCOL (Valor: 0x00000008) Registrar en informe
MSG_FLAG_TEXTVALUES (Valor: 0x00000010) El aviso tiene valores asociados
de texto
MSG_FLAG_TIMEINVALID (Valor: 0x00000020) Bit para sello no válido de fecha/
hora
MSG_FLAG_INSTANCE (Valor: 0x00000040) Identificación de avisos de ins‐
tancia
MSG_FLAG_HIDDEN (Valor: 0x00000080) Aviso oculto, disponible a partir
de V6.2
MSG_FLAG_TEXT10_EXT (Valor: 0x00000100) Diagnóstico de canal avanzado,
disponible a partir de V7.0
MSG_FLAG_INSTANCE10 (Valor: 0x08000000) Aviso de instancia con valor de
proceso 10, disponible a partir
de V5.0 SP2
MSG_FLAG_TEXTREF1 (Valor: 0x10000000) Referencia de texto1, disponible
a partir de V5.0 SP2
MSG_FLAG_TEXTREF2 (Valor: 0x20000000) Referencia de texto2, disponible
a partir de V5.0 SP2

Flags de un aviso en la lista online

Solo definido a partir de WinCC V6.0 SP4 en m_global.h.
MSG_RT_FLAG_COME (Valor: 0x00000001) Aviso aparecido

MSG_RT_FLAG_GO (Valor: 0x00000002) Aviso desaparecido
MSG_RT_FLAG_QUIT_COME (Valor: 0x00000004) Acuse aparecido
MSG_RT_FLAG_QUIT_GO (Valor: 0x00000008) Acuse desaparecido
MSG_RT_FLAG_NOQUIT (Valor: 0x00000010) Sin obligación de acuse
MSG_RT_FLAG_QUIT_NOGO (Valor: 0x00000020) Acuse TM II
MSG_RT_FLAG_FLASH (Valor: 0x00000040) Intermitente
MSG_RT_FLAG_FIRSTFLASH (Valor: 0x00000080) Solo puede parpadear el primer
aviso
MSG_RT_FLAG_NOLIST (Valor: 0x00000100) Los avisos no se registran en la
lista de avisos
MSG_RT_FLAG_UNI‐ (Valor: 0x00000200) Avisos con nombre de usuario
QUE_USER unívoco
MSG_RT_FLAG_ONL_COM_C (Valor: 0x00000400) En la lista de avisos mostrar solo
OM comentario del aviso aparecido
MSG_RT_FLAG_HIDDEN (Valor: 0x00000800) Aviso oculto
MSG_RT_FLAG_TEXT10_EXT (Valor: 0x00001000) Diagnóstico de canal avanzado,
MSG_RT_FLAG_DELETE (Valor: 0x00010000) El aviso se puede borrar
MSG_RT_FLAG_SUMTIME (Valor: 0x00020000) Flag para horario de verano
MSG_RT_FLAG_SQUIT (Valor: 0x00040000) Aviso tiene acuse de grupo
MSG_RT_FLAG_QUITNR (Valor: 0x00080000) Número de aviso - acuse
MSG_RT_FLAG_MSGLIST (Valor: 0x00100000) Aviso de lista de avisos
MSG_RT_FLAG_COMMENT (Valor: 0x00200000) El aviso tiene comentario
MSG_RT_FLAG_ARCHIV (Valor: 0x00400000) El aviso es archivado
MSG_RT_FLAG_PROTOCOL (Valor: 0x00800000) El aviso es registrado
MSG_RT_FLAG_INSTANCE (Valor: 0x01000000) Flag para aviso de instancia
MSG_RT_FLAG_TIMEINVALID (Valor: 0x02000000) Flag para sello no válido de fe‐
cha/hora
MSG_RT_FLAG_LOCKGROUP (Valor: 0x04000000) Flag para bloqueo de grupo
MSG_RT_FLAG_INSTANCE10 (Valor: 0x08000000) Bit para aviso de instancia nue‐
vo con valor de proceso 10
MSG_RT_FLAG_TEXTREF1 (Valor: 0x10000000) Bit para referencia de texto 1
MSG_RT_FLAG_TEXTREF2 (Valor: 0x20000000) Bit para referencia de texto 2
MSG_RT_FLAG_QUITCOUN‐ (Valor: 0x40000000) Bit para acuse vía counter
TER
MSG_RT_FLAG_QUITGROUP (Valor: 0x80000000) Bit para acuse vía counter
Flags de avisos individuales
MSG_PARAMS_SQUIT (Valor: 0x00000001) El aviso está sujeto a acuse in‐

dividual.
MSG_PARAMS_HORN (Valor: 0x00000002) El aviso controla la bocina.

MSG_PARAMS_ARCHIV (Valor: 0x00000004) El aviso debe archivarse.

MSG_PARAMS_PROTOCOL (Valor: 0x00000008) El aviso debe registrarse en in‐
forme.
MSG_PARAMS_VARFLANK (Valor: 0x00000010) El aviso se genera con flanco
descendente de la variable.
MSG_PARAMS_LOCKED (Valor: 0x00000020) El aviso está bloqueado en el
arranque.
MSG_PARAMS_INFOTEXT (Valor: 0x00000040) El aviso tiene un texto informati‐
vo.
MSG_PARAMS_LOOPINA‐ (Valor: 0x00000080) El aviso tiene Loop In Alarm.
LARM
MSG_PARAMS_APFUNC (Valor: 0x00000100) El aviso controla una función AP
global.
MSG_PARAMS_NORMDLL (Valor: 0x00000200) El aviso tiene una DLL de nor‐
malización.
MSG_PARAMS_TEXT10_EXT (Valor: 0x00000400) Diagnóstico de canal avanzado,
Autómatas finitos
MSG_QUIT_QUIT_COME (Valor: 0x00000004) Acuse aparecido

MSG_QUIT_QUIT_GO (Valor: 0x00000008) Acuse desaparecido
MSG_QUIT_NOQUIT (Valor: 0x00000010) Sin obligación de acuse
MSG_QUIT_QUIT_NOGO (Valor: 0x00000020) Acuse TM II (sin aviso desapa‐
recido)
MSG_QUIT_FLASH (Valor: 0x00000040) Intermitente
MSG_QUIT_FIRSTFLASH (Valor: 0x00000080) Solo puede parpadear el primer
aviso
MSG_QUIT_NOLIST (Valor: 0x00000100) Los avisos no se registran en la
lista de avisos
MSG_QUIT_UNIQUE_USER (Valor: 0x00000200) Avisos con nombre de usuario
unívoco
MSG_QUIT_ONL_COM_COME (Valor: 0x00000400) En la lista de avisos mostrar solo
comentario del aviso aparecido
Avisos de grupo
MSG_COLLECT_ALL (Valor: 0x00000001) Todos los avisos

MSG_COLLECT_QUIT (Valor: 0x00000002) Todos los avisos no acusados
MSG_COLLECT_CLASS (Valor: 0x00000003) Todos los avisos de una catego‐
ría
MSG_COLLECT_TYPE (Valor: 0x00000004) Todos los avisos de un tipo
MSG_COLLECT_USER (Valor: 0x00000005) Avisos de grupo definidos por el
usuario

Avisos individuales
MSG_SINGLE_OPERATION (Valor: 0x00BEDBED) Aviso de operador
Categorías de avisos
MSG_CLASS_SYSTEM_QUIT (Valor: 0x00000011) Categoría de avisos de sistema

con acuse
MSG_CLASS_SYSTEM (Valor: 0x00000012) Categoría de avisos de sistema
sin acuse
Bloques de aviso
En HIWORD está el tipo principal de los bloques de aviso. LOWORD contiene los subtipos
de los bloques de avisos.
MSG_BLOCK_SYSTEM (Valor: 0x00010000) Bloques de sistema

MSG_BLOCK_DATE (Valor: 0x00010001) Fecha
MSG_BLOCK_TIME (Valor: 0x00010002) Hora
MSG_BLOCK_TIMEDIFF (Valor: 0x00010003) Duración del aviso
MSG_BLOCK_SUMWIN (Valor: 0x00010004) Horario verano/invierno
MSG_BLOCK_STATE (Valor: 0x00010005) Estado del aviso
MSG_BLOCK_QUIT (Valor: 0x00010006) Estado de acuse
MSG_BLOCK_NUMBER (Valor: 0x00010007) Número del aviso
MSG_BLOCK_CLASS (Valor: 0x00010008) Categoría de aviso
MSG_BLOCK_TYP (Valor: 0x00010009) Tipo de aviso
MSG_BLOCK_AGCPU (Valor: 0x0001000A) Número AG/CPU
MSG_BLOCK_DMVAR (Valor: 0x0001000B) Variable de aviso
MSG_BLOCK_LIMIT (Valor: 0x0001000C) Rebase de valor límite
MSG_BLOCK_ARCHIV (Valor: 0x0001000D) Identificador de fichero
MSG_BLOCK_PROTOCOL (Valor: 0x0001000E) Identificador de informe
MSG_BLOCK_COMMENT (Valor: 0x0001000F) Comentario
MSG_BLOCK_INFO (Valor: 0x00010010) Texto informativo
MSG_BLOCK_LOOPINALARM (Valor: 0x00010011) Función Loop In Alarm / AP
MSG_BLOCK_COMPUTERNA‐ (Valor: 0x00010012) Nombre del equipo
ME
MSG_BLOCK_USERNAME (Valor: 0x00010013) Nombre de usuario
MSG_BLOCK_PRIORITY (Valor: 0x00010014) Prioridad
MSG_BLOCK_TEXT (Valor: 0x00020000) Los (máximo) 16 bloques de tex‐
to de usuario pueden llamarse
con las constantes
MSG_BLOCK_TEXT1 ...
MSG_BLOCK_TEXT16 con los
valores 0x00020001 ...
0x00020010.

MSG_BLOCK_VALUE (Valor: 0x00030000) Los (máximo) 16 bloques de va‐

lores de proceso pueden llamar‐
se con las constantes
MSG_BLOCK_VALUE1 ...
MSG_BLOCK_VALUE16 con
los valores 0x00030001 ...
0x00030010.
MSG_MAX_SYSBL Número de bloques de avisos
de sistema =
MSG_BLOCK_LOOPINALARM -
MSG_BLOCK_SYSTEM
MSG_MAX_SYSBL_V6 Número de bloques de sistema
a partir de V6.0 =
MSG_BLOCK_PRIORITY -
MSG_BLOCK_SYSTEM
MSG_MAX_BLOCKS Número total de bloques de avi‐
so = (MSG_MAX_TB +
MSG_MAX_PVALUE +
MSG_MAX_SYSBL)
MSG_MAX_BLOCKS_V6 Número total de bloques de avi‐
so a partir de V6.0 =
(MSG_MAX_TB +
MSG_MAX_PVALUE +
MSG_MAX_SYSBL_V6)
Formato de fecha
DATE_FORMAT_YEAR_2 (Valor: 0x00000001) Indicación del año, dos cifras

DATE_FORMAT_YEAR_4 (Valor: 0x00000002) Indicación del año, cuatro cifras
DATE_FORMAT_DMY (Valor: 0x00000004) Orden: Día, mes, año
DATE_FORMAT_MDY (Valor: 0x00000008) Orden: Mes, día, año
DATE_FORMAT_YMD (Valor: 0x00000010) Orden: Año, mes, día
Formato de hora
TIME_FORMAT_HOUR (Valor: 0x00000001) Hora

TIME_FORMAT_MIN (Valor: 0x00000002) Minuto
TIME_FORMAT_SEC (Valor: 0x00000004) Segundo
TIME_FORMAT_MSEC (Valor: 0x00000008) Milisegundo
TIME_FORMAT_24HOUR (Valor: 0x00000010) Formato 24 horas
TIME_FORMAT_DAY (Valor: 0x00000020) Indicación de la hora

Número de aviso - Formato

En HiWord está la especificación del formato (con ceros antepuestos), LoWord contiene el
número de posiciones.
MSGNR_FORMAT_NOLEA‐ (Valor: 0x00000000)

DING
MSGNR_FORMAT_LEADING‐ (Valor: 0x00010000)
ZERO
MSG_BLOCK_FOR‐ (Valor: 0x00020000) Impresión con sangría a derecha
MAT_RIGHT
MSG_BLOCK_FORMAT_CEN‐ (Valor: 0x00040000) Impresión centrada
TER
MSG_BLOCK_FOR‐ (Valor: 0x80000000) Intermitencia del bloque de aviso
MAT_FLASH
Elementos de la barra de estado
MSG_SB_HELP (Valor: 0x00000001) Barra de ayuda

MSG_SB_DATE (Valor: 0x00000002) Fecha
MSG_SB_TIME (Valor: 0x00000004) Hora
MSG_SB_COUNTALL (Valor: 0x00000008) Avisos total
MSG_SB_COUNTSEL (Valor: 0x00000010) Avisos actual
MSG_SB_COUNTQUIT (Valor: 0x00000020) Avisos acuse
MSG_SB_SELECT (Valor: 0x00000040) Selección activa
MSG_SB_LOCK (Valor: 0x00000080) Bloqueo activo
MSG_SB_HIDE (Valor: 0x00000100) Ocultación de avisos activa
MSG_SB_WARNING (Valor: 0x00000200) Información de ocultación
MSG_MAX_SBITEMS (Valor: 10) Número máximo de elementos
de la barra de estado.
Elementos de la barra de herramientas
MSG_TB_MSGWIN (Valor: 0x00000001) Mostrar botón "Ventana de avi‐

sos".
MSG_TB_ARC_S (Valor: 0x00000002) Mostrar botón "Archivo circular".
MSG_TB_ARC_L (Valor: 0x00000004) Mostrar botón "Fichero de conti‐
nuación".
MSG_TB_QH (Valor: 0x00000008) Mostrar botón "Acuse de boci‐
na".
MSG_TB_QM (Valor: 0x00000010) Mostrar botón "Acuse indivi‐
dual".
MSG_TB_QS (Valor: 0x00000020) Mostrar botón "Acuse de grupo".
MSG_TB_SCROLL (Valor: 0x00000040) Mostrar botón "Función de des‐
plazamiento ON/OFF".
MSG_TB_SELECT (Valor: 0x00000080) Mostrar botón "Diálogo de se‐
lección".

MSG_TB_LOCK (Valor: 0x00000100) Mostrar botón "Diálogo de blo‐

queo".
MSG_TB_PROTOCOL (Valor: 0x00000200) Mostrar botón "Diálogo de infor‐
me".
MSG_TB_CITYRUF (Valor: 0x00000400) Mostrar botón "Beeper".
MSG_TB_RESET (Valor: 0x00000800) Mostrar botón "Botón de reini‐
cio".
MSG_TB_MSGFIRST (Valor: 0x00001000) Mostrar botón "Principio de la
lista".
MSG_TB_MSGLAST (Valor: 0x00002000) Mostrar botón "Final de la lista".
MSG_TB_MSGNEXT (Valor: 0x00004000) Mostrar botón "Siguiente aviso".
MSG_TB_MSGPREV (Valor: 0x00008000) Mostrar botón "Aviso anterior".
MSG_TB_INFO (Valor: 0x00010000) Mostrar botón "Textos informati‐
vos".
MSG_TB_COMMENT (Valor: 0x00020000) Mostrar botón "Introducir co‐
mentario".
MSG_TB_LOOPINALARM (Valor: 0x00040000) Mostrar botón "Loop In Alarm".
MSG_TB_LANGUAGESET (Valor: 0x00080000) Mostrar botón "Cambio de idio‐
ma"
MSG_TB_PRINT (Valor: 0x00100000) Mostrar botón "Imprimir".
MSG_TB_LOCKWIN (Valor: 0x00200000) Mostrar botón "Ventana de blo‐
queo"
MSG_TB_UNLOCKMSG (Valor: 0x00400000) Mostrar botón "Habilitar aviso".
MSG_TB_LOCK_UN‐ (Valor: 0x00400000) Mostrar botón "Bloquear o habi‐
LOCK_MSG litar aviso".
MSG_TB_SORTDLG (Valor: 0x00800000) Mostrar botón "Diálogo de clasi‐
ficación"
MSG_TB_TIMEBASE (Valor: 0x01000000) Mostrar botón "Diálogo para ba‐
se de tiempo"
MSG_TB_HITLIST (Valor: 0x02000000) Mostrar botón "Lista de resulta‐
dos"
MSG_TB_HIDELIST (Valor: 0x04000000) Mostrar botón "Lista de avisos
ocultos".
MSG_TB_UNHIDEMSG (Valor: 0x08000000) Mostrar botón "Mostrar aviso".
MSG_TB_HIDE_UNHIDE_MSG (Valor: 0x080000000) Mostrar botón "Ocultar y mos‐
trar aviso".
MSG_TB_HIDEDLG (Valor: 0x10000000) Mostrar botón "Diálogo de ocul‐
tar y mostrar aviso"
MSG_MAX_TBITEMS (Valor: 24) Número máximo de elementos
de manejo de la barra de herra‐
mientas.
MSG_MAX_TBITEMS_V6 (Valor: 25) Número máximo, disponible a
partir de V6
MSG_MAX_TBITEMS_V6_1 (Valor: 26) Número máximo, disponible a
partir de V6.1
MSG_MAX_TBITEMS_V6_2 (Valor: 30) Número máximo, disponible a
partir de V6.2
MSG_ALIGN_TOP (Valor: 1) Alineación arriba

MSG_ALIGN_BOTTOM (Valor: 2) Alineación abajo

MSG_ALIGN_LEFT (Valor: 3) Alineación izquierda
MSG_ALIGN_RIGHT (Valor: 4) Alineación derecha
Opciones de ventana
MSG_MWWIN_SWITCHENA‐ (Valor: 0x00000001) Cambio fichero de proceso

BLE
MSG_MWWIN_PROCESS (Valor: 0x00000002) Ventana de avisos de proceso
MSG_MWWIN_ARCHIV_CIR‐ (Valor: 0x00000004) Fichero circular
CLE
MSG_MWWIN_ARCHIV_LONG (Valor: 0x00000008) Fichero de continuación
MSG_MWWIN_GRIDLI‐ (Valor: 0x00000010) Línea de cuadrícula horizontal
NEHORZ
MSG_MWWIN_GRIDLINEVERT (Valor: 0x00000020) Línea de cuadrícula vertical
MSG_MWWIN_LINETITLE (Valor: 0x00000040) Título de fila
MSG_MWWIN_LINEHEIGHT (Valor: 0x00000080) Altura de fila modificable
MSG_MWWIN_LINEHEIGHT‐ (Valor: 0x00000100) Adaptar fuente a altura de fila
FONT
MSG_MWWIN_COLUMNTITLE (Valor: 0x00000200) Rotulación de columna
MSG_MWWIN_COLUMNTI‐ (Valor: 0x00000400) 2 filas de título
TLE2
MSG_MWWIN_COLUMNTI‐ (Valor: 0x00000800) 3 filas de título
TLE3
MSG_MWWIN_COLUMN‐ (Valor: 0x00001000) Ancho de columna modificable
WIDTH
MSG_MWWIN_COLUMNMOVE (Valor: 0x00002000) Las columnas pueden moverse
MSG_MWWIN_CELLSELECT (Valor: 0x00004000) Selección solo celda (ajuste pre‐
determinado: fila)
MSG_MWWIN_LINESELECT (Valor: 0x00008000) Selección de fila
MSG_MWWIN_AUTOSCRO‐ (Valor: 0x00010000) Desplazamiento automático de‐
LLOFF sactivado (ajuste predetermina‐
do: activado)
MSG_MWWIN_TITLECUT (Valor: 0x00020000) En caso necesario, el título se
abrevia con puntos
MSG_MWWIN_CELLCUT (Valor: 0x00040000) En caso necesario, el contenido
de la celda se abrevia con puntos
MSG_MWWIN_TITLEBAR (Valor: 0x00080000) Mostrar barra de título de la ven‐
tana (+ borde)
MSG_MWWIN_SIZEABLE (Valor: 0x00100000) Tamaño de la ventana modifica‐
ble
MSG_MWWIN_TOOLTIP (Valor: 0x00200000) Visualización de tooltip en espe‐
cial para textos de avisos
MSG_MWWIN_LOOP_IN_ALAR (Valor: 0x00400000) Un clic para "Loop in Alarm"
M_DC
MSG_MWWIN_SELECTFO‐ (Valor: 0x00800000) Selección marcada con borde
CUSRECT en lugar de inversión

MSG_MWWIN_OPMSG_HIDE (Valor: 0x01000000) Aviso de operador al ocultar

MSG_MWWIN_OPMSGUNHI‐ (Valor: 0x02000000) Aviso de operador al mostrar
DE
MSG_MWWIN_INSTAN‐ (Valor: 0x08000000) Ancho de columna específico de
CE_COLWIDTH instancia
MSG_MWWIN_INSTANCEBLO‐ (Valor: 0x10000000) Ajustes de bloque de avisos es‐
CKINFO pecíficos de instancia
MSG_MWWIN_OPMSG_LOCK (Valor: 0x20000000) Aviso de operador al bloquear
MSG_MWWIN_OPMSG_UN‐ (Valor: 0x40000000) Aviso de operador al habilitar
LOCK
MSG_MWWIN_OPMSG_ACK (Valor: 0x80000000) Aviso de operador al acusar
Criterios de filtro
MSG_FILTER_DATE_FROM (Valor: 0x00000001) Fecha desde

MSG_FILTER_DATE_TO (Valor: 0x00000002) Fecha hasta
MSG_FILTER_TIME_FROM (Valor: 0x00000004) Hora desde
MSG_FILTER_TIME_TO (Valor: 0x00000008) Hora hasta
MSG_FILTER_NR_FROM (Valor: 0x00000010) Número de aviso desde
MSG_FILTER_NR_TO (Valor: 0x00000020) Número de aviso hasta
MSG_FILTER_CLASS (Valor: 0x00000040) Categorías de avisos
MSG_FILTER_STATE (Valor: 0x00000080) Estado del aviso
MSG_FILTER_AG_FROM (Valor: 0x00000100) Número AG desde
MSG_FILTER_AG_TO (Valor: 0x00000200) Número AG hasta
MSG_FILTER_AGSUB_FROM (Valor: 0x00000400) Subnúmero AG desde
MSG_FILTER_AGSUB_TO (Valor: 0x00000800) Subnúmero AG hasta
MSG_FILTER_ARC (Valor: 0x00001000) Identificador de fichero/prot.
MSG_FILTER_TEXT (Valor: 0x00002000) Textos de aviso
MSG_FILTER_PVALUE (Valor: 0x00004000) Valores de proceso
MSG_FILTER_COUN‐ (Valor: 0x00008000) Contador de avisos interno des‐
TER_FROM de
MSG_FILTER_COUNTER_TO (Valor: 0x00010000) Contador de avisos interno has‐
ta
MSG_FILTER_PROCESSMSG (Valor: 0x00020000) Avisos de proceso
MSG_FILTER_SYSMSG (Valor: 0x00040000) Avisos de sistema
MSG_FILTER_BEDMSG (Valor: 0x00080000) Avisos de operador
MSG_FILTER_QUICKSELECT (Valor: 0x00100000) Selección rápida (día actual, ...)
MSG_FILTER_TEXT_EQUAL (Valor: 0x00200000) Textos de aviso exactamente
MSG_FILTER_PRIO‐ (Valor: 0x00400000) Prioridad desde
RITY_FROM
MSG_FILTER_PRIORITY_TO (Valor: 0x00800000) Prioridad hasta
MSG_FILTER_VISIBLEONLY (Valor: 0x01000000) Mostrar avisos visualizados
MSG_FILTER_HIDDENONLY (Valor: 0x02000000) Mostrar avisos ocultos
MSG_FILTER_NODYNAMIC (Valor: 0x04000000) Ninguna selección de textos di‐
námicos

MSG_FILTER_DATE Valor: (MSG_FILTER_DA‐

TE_FROM | MSG_FILTER_DA‐
TE_TO)
MSG_FILTER_TIME Valor: (MSG_FILTER_TI‐
ME_FROM | MSG_FILTER_TI‐
ME_TO)
MSG_FILTER_NR Valor: (MSG_FIL‐
TER_NR_FROM | MSG_FIL‐
TER_NR_TO)
Selección rápida
El momento final de la selección rápida se refiere a la hora actual del sistema del equipo local.
El momento de inicio es n * (meses, días, horas de retroceso).
MSG_FILTER_QUICK_MONTH (Valor: 0x00000001) Últimos n meses

MSG_FILTER_QUICK_DAYS (Valor: 0x00000002) Últimos n días
MSG_FILTER_QUICK_HOUR (Valor: 0x00000003) Últimas n horas
Tipos de fichero
MSG_ARPRO_LONGARCH (Valor: 0x00000001) Fichero de continuación

MSG_ARPRO_SHORTARCH (Valor: 0x00000002) Fichero circular
MSG_ARPRO_ARCHPROT (Valor: 0x00000003) Informe de fichero
MSG_ARPRO_MFPROT (Valor: 0x00000004) Informe de continuación de avi‐
sos
Flags de ficheros
MSG_ARPRO_PA‐ (Valor: 0x00000001) Fichero de corto plazo en la me‐

RAM_HSPONLY moria principal
MSG_ARPRO_PARAM_CIR‐ (Valor: 0x00000002) Fichero circular
CLE
MSG_ARPRO_PARAM_EN‐ (Valor: 0x00000004) Fichero sinfín
DLES
MSG_ARPRO_PARAM_RE‐ (Valor: 0x00000008) Retransferir tras un corte de la
LOAD alimentación
MSG_ARPRO_PARAM_LINE‐ (Valor: 0x00000010) Imprimir por líneas (sólo en in‐
PRINT forme de avisos de continuación)
ID de bloqueo de avisos
MSG_LOCK_UNKNOWN (Valor: 0) El bloqueo es desconocido

MSG_LOCK_CLASS (Valor: 1) Bloqueo de categoría

MSG_LOCK_GROUP1 (Valor: 2) Bloqueo de grupos de avisos ni‐

vel 1
MSG_LOCK_GROUP2 (Valor: 3) Bloqueo de grupos de avisos ni‐
vel 2
ID de informes
MSG_PROT_MSG (Valor: 1) Informe de avisos de continua‐

ción
MSG_PROT_ARCHIV_CIRCLE (Valor: 2) Informe de fichero circular
MSG_PROT_ARCHIV_LONG (Valor: 3) Informe de fichero de continua‐
ción
ID de trasvase de ficheros de avisos
MSG_DB_FMT_CSV (Valor: 1) CSV/formato de archivo

MSG_DB_FMT_DBASE3 (Valor: 2) Formato de archivo DBASE3
MSG_DB_FMT_WATCOM (Valor: 3) Formato Watcom
MSG_DB_FLAGS_OVERWRI‐ (Valor: 1) Sobrescribir registros existentes
TE
MSG_DB_FLAGS_ADD (Valor: 2) Solo agregar
MSG_DB_FLAGS_DELETE (Valor: 4) Borrar registros fuente
MSG_DB_FLAGS_NOEXPORT (Valor: 8) No exportar registros --> solo
borrar (ya no está disponible)
Flags de configuración genérica

Los flags pueden estar combinados lógicamente.
MSG_GENERIC_APPEND (Valor: 0x00000001) Crear

MSG_GENERIC_OVERWRITE (Valor: 0x00000002) Sobrescribir
MSG_GENERIC_DELETE (Valor: 0x00000004) Borrar
Modo para variables
MSG_CS_VAR_NOTSET (Valor: 0x0000) Ninguna variable activada

MSG_CS_VARNAME_SET (Valor: 0x0001) El nombre de variable está asig‐
nado
MSG_CS_VARID_SET (Valor: 0x0002) La ID de variable está activada
MSG_CS_VARALL_SET (Valor: 0x0003) ID de variable y nombre activa‐
dos

Enumeración de los ficheros
MSG_ARCHIV_ENUM_DESC (Valor: 0x00000001) Clasificación ascendente (ajus‐

te predeterminado: ascendente)
2.10.2.1 MSG_RTCREATE_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwFlags;
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValueW[MSG_MAX_PVALUE]
}
MSG_RTCREATE_STRUCT_PLUS;
Members
dwMsgState
Estado del aviso en función de las constantes en el archivo "m_global.h":
MSG_STATE_COME Aviso aparecido

MSG_STATE_GO Aviso desaparecido
MSG_STATE_QUIT Aviso acusado
MSG_STATE_LOCK Aviso bloqueado
MSG_STATE_UNLOCK Habilitación de aviso
MSG_STATE_HIDE Aviso oculto
MSG_STATE_UNHIDE Aviso visualizado
MSG_STATE_HIDE_MANUAL Aviso ocultado manualmente
MSG_STATE_UNHIDE_MANUAL Aviso visualizado manualmente
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.

dwFlags
stMsgTime
Fecha y hora para visualización y ocultación de aviso. En el acuso se utiliza el tiempo de
sistema del PLC o del OS.
dPValue
Valores numéricos de proceso.
wPValueUsed
Valores utilizados de proceso en representación bitcodificada.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto. En caso de un suministro doble erróneo se trata dPValue prioritariamente.
mtTextValue
Estructura del tipo MSG_TEXTVAL256_STRUCT_PLUS (Página 1048) con los valores
asociados al texto.
wTextValueUsed
Valores de texto utilizados de proceso en representación bitcodificada.
Observación
Antes de llenar la estructura, ésta debe inicializarse con "0" .
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
AUTOHOTSPOT Crear aviso
Consulte también
MSG_TEXTVAL256_STRUCT_PLUS (Página 1048)
Sinopsis de las estructuras (Página 1009)

2.10.2.2 MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
WCHAR szComment[MSG_MAX_TB_CONTENT+1];
WCHAR szUser[MSG_MAX_USERNAME+1];
WCHAR szComputerName[MAX_COMPUTERNAME_LENGTH+1];
WCHAR szApplicationName[MSG_MAX_APPLNAME+1];
WCHAR szServerPrefix[_MAX_PATH+1];
}
MSG_RTDATA_INSTANCECOMMENT_STRUCTPlus;
Members
dwMsgState
Los estados listados se utilizan sólo internamente por el sistema y pueden activarse
exclusivamente por API con MSRTCreateMsgInstanceWithCommentPlus.

MSG_STATE_UNHIDE_MANUAL Aviso visualizado manualmente
dwMsgNrLow
dwMsgNrHigh

stMsgTime
Fecha y hora para visualización y ocultación de aviso.
dwTimeDiff
Duración de tiempo de visualización o ocultación, tiempo de telegrama en segundos.
dwCounter
Contador de avisos interno.
dwFlags
Flags en función de las constantes en el archivo "m_global.h":
Flags para avisos en el visor de avisos

MSG_RT_FLAG_COME 0x00000001 Aviso aparecido
MSG_RT_FLAG_GO 0x00000002 Aviso desaparecido
MSG_RT_FLAG_QUIT_COME 0x00000004 Acuse aparecido
MSG_RT_FLAG_QUIT_GO 0x00000008 Acuse desaparecido
MSG_RT_FLAG_NOQUIT 0x00000010 Sin obligación de acuse
MSG_RT_FLAG_QUIT_NOGO 0x00000020 Acuse TM II
MSG_RT_FLAG_FLASH 0x00000040 Intermitente
MSG_RT_FLAG_FIRSTFLASH 0x00000080 Solo puede parpadear el primer aviso
MSG_RT_FLAG_DELETE 0x00010000 El aviso se puede borrar
MSG_RT_FLAG_SUMTIME 0x00020000 Flag para horario de verano
MSG_RT_FLAG_SQUIT 0x00040000 Aviso tiene acuse de grupo
MSG_RT_FLAG_QUITNR 0x00080000 Número de aviso - acuse
MSG_RT_FLAG_MSGLIST 0x00100000 Aviso de lista de avisos
MSG_RT_FLAG_COMMENT 0x00200000 El aviso tiene comentario
MSG_RT_FLAG_ARCHIV 0x00400000 El aviso es archivado
MSG_RT_FLAG_PROTOCOL 0x00800000 El aviso es registrado
MSG_RT_FLAG_INSTANCE 0x01000000 Flag para aviso de instancia
MSG_RT_FLAG_TIMEINVALID 0x02000000 Flag para sello no válido de fecha/hora
MSG_RT_FLAG_LOCKGROUP 0x04000000 Flag para bloqueo de grupo
MSG_RT_FLAG_INSTANCE10 0x08000000 Bit para nuevo aviso de instancia con valor
de proceso 10
MSG_RT_FLAG_TEXTREF1 0x10000000 Bit para referencia de texto 1
MSG_RT_FLAG_QUITCOUNTER 0x40000000 Bit para acuse vía counter
MSG_RT_FLAG_QUITGROUP 0x80000000 Bit para acuse vía counter
En la función MSRTCreateMsgInstanceWithCommentPlus no se pueden transferir flags al

servidor de alarmas. Los flags son ignorados.
wPValueUsed

wTextValueUsed
Valores de texto utilizados, bitcodificados.
número o texto.
En caso de un suministro doble erróneo se trata dPValue prioritariamente.
dPValue
Valores de proceso.
mtTextValue
asociados al texto.
szInstance
Nombre de instancia. Cuando no se suministra szInstance (string vacío), se crea un aviso
normal
szComment
Nombre de comentario
szUser
Nombre de usuario.
szComputerName
Nombre de ordenador.
szApplicationName
Nombre de aplicación.
szServerPrefix
Prefijo de servidor.
Observación
Antes de llenar la estructura, ésta debe inicializarse con "0" .
Archivos necesarios
CCMSRTCLIPlus.h

Funciones API

gina 1066)
MSRTGetLastMsgWithCommentPlus (Pági‐ Consultar último aviso archivado
na 1077)
MSG_SERVICE_NOTIFY_PROCPlus (Pági‐ Función callback
na 1057)
Consulte también
MSRTCreateMsgInstanceWithCommentPlus (Página 1066)
MSRTGetLastMsgWithCommentPlus (Página 1077)
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSRTGetSelectedMsgPlus (Página 1086)
MSRTCheckWinFilterPlus (Página 1097)
2.10.2.3 MSG_FILTER_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
WCHAR szFilterName[MSG_MAX_TEXTLEN+1];
DWORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNrLow[2];
DWORD dwMsgNrHigh[2];
VARIANT vMsgClasses;
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
WCHAR szTB[MSG_MAX_TB][MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
ULONGLONG uMsgCounter[2];
DWORD dwQuickSelect;
DWORD dwPriority[2];
}
MSG_FILTER_STRUCT_PLUS;

Members
szFilterName
Nombre del filtro
dwFilter
Las condiciones de filtración se determinan con las siguientes constantes del archivo
"m_global.h":
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 AG - Número de
MSG_FILTER_AG_TO AG - Número hasta
MSG_FILTER_AGSUB_FROM AG - Subnúmero de
MSG_FILTER_AGSUB_TO AG - Subnúmero 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 (reservados)
MSG_FILTER_SYSMSG Avisos de sistema (reservados)
MSG_FILTER_BEDMSG Avisos de operador (reservados)
MSG_FILTER_VISIBLEONLY Visualizar los avisos visibles (no se incluye en
condición de filtración)
MSG_FILTER_HIDDENONLY Visualizar los avisos ocultos (no se incluye en con‐
dición de filtración)
MSG_FILTER_NODYNAMIC Sin selección de textos dinámicos (no se incluye
en condición de filtración)
MSG_FILTER_DATE Fecha desde hasta
MSG_FILTER_TIME Hora desde hasta
MSG_FILTER_NR Número de aviso desde hasta
Las diferentes condiciones de filtración pueden ser modificados.
st
st[0] Fecha y hora del momento de inicio, st[1] fecha y hora del momento final
Usted debe asignar st cuando utiliza los criterios de filtro MSG_FILTER_DATE,
MSG_FILTER_DATE_FROM, MSG_FILTER_DATE_TO, MSG_FILTER_TIME,
MSG_FILTER_TIME_FROM, o MSG_FILTER_TIME_To.

dwMsgNrLow
dwMsgNrHigh
Hay que asignar dwMsgNrLow y dwMsgNrHigh cuando se utilicen los criterios de filtro
MSG_FILTER_NR, MSG_FILTER_NR_FROM o MSG_FILTER_NR_TO.
vMsgClasses
Clases de aviso bitcodificadas
0x0001 = Clase 1, 0x0002 = Clase 2, 0x0004 = Clase 3, ... 0x0040= Clase 7
0x0204 = Clases 3 y 10
Usted debe asignar dwMsgClass y dwMsgType cuando utiliza el criterio de
filtroMSG_FILTER_CLASS.
dwMsgState
Estado del aviso codificado en binario
Asigne este campo cuando utiliza el criterio de filtro MSG_FILTER_STATE.
Los siguientes valores de estado son comprobados por MSRTCheckWinFilter:

MSG_STATE_QUIT_SYSTEM Aviso acusado por el sistema
MSG_STATE_QUIT_EMERGENCY Acuse de emergencia
Otros valores de estado, p. ej. MSG_STATE_HIDE, MSG_STATE_UNHIDE, deben ser

filtrados manualmente, ya que no se consideran en esta condición de filtro. Para filtrar estos
valores de estado debe utilizarse p. ej. MSG_FILTER_HIDDENONLY.
wAGNr
wAGNr [0] Número del primer PLC, wAGNr [1] número del último PLC.
Usted debe asignarwAGNr b, cuando utiliza los criterios de filtro MSG_FILTER_AG_FROM o
MSG_FILTER_AG_TO.
wAGSubNr
wAGSubNr [0] Número del primer PLC, wAGSubNr [1] número del último PLC.
Usted debe asignarwAGSubNr b, cuando utiliza los criterios de filtro
MSG_FILTER_AGSUB_FROM o MSG_FILTER_AGSUB_TO.
dwArchivMode
Identificación para fichero o informe. El parámetro debe asignarse con 0.

szTB
Textos de bloques de texto
Usted debe asignar szTB cuando utiliza el criterio de filtro MSG_FILTER_TEXT.
dwTB
Bloques de texto activos, codificados en binario
Usted debe asignar dwTB cuando utiliza el criterio de filtro MSG_FILTER_TEXT
dPValue
Valores de proceso de - hasta
Usted debe asignar dPValue cuando utiliza el criterio de filtro MSG_FILTER_PVALUE.
dwPValue
Valores de proceso activos, codificados en binario
Usted debe asignar dwPValue cuando utiliza el criterio de filtro MSG_FILTER_PVALUE.
uMgCounter
Contador de avisos interno
Usted debe asignar dwMsgCounter cuando utiliza un criterio de filtro
MSG_FILTER_COUNTER_....
dwQuickSelect
dwPriority
Prioridad del aviso
szInstance
Nombre de instancia. Si szInstance no recibe valores (string vacío), se crea un aviso normal.
Observación
MSG_FILTER_STRUCT_PLUS también es utilizado por la estructura AUTOHOTSPOT.
Archivos necesarios
CCMsRTCliPlus.h
Funciones API
MSRTCheckWinFilterPlus (Página 1097) Comprobar condiciones de filtro de avisos

AUTOHOTSPOT Parametrizar filtro de avisos
MSRTEnumProtDataPlus (Página 1062) Listar datos de informe
MSRTGetFilterDataPlus (Página 1096) Consultar condiciones de filtro de avisos


MSRTSetMsgWinFilterPlus (Página 1100) Aplicar filtro de avisos para una ventana de avisos
MSRTGetLastMsgWithCommentPlus (Pági‐ Consultar último aviso archivado
na 1077)
MSRTStartMsgServicePlus (Página 1051) Iniciar servicio
Consulte también
MSRTGetLastMsgWithCommentPlus (Página 1077)
MSRTSetMsgWinFilterPlus (Página 1100)
MSRTStartMsgServicePlus (Página 1051)
MSRTSetMsgFilterPlus (Página 1099)
MSRTGetFilterDataPlus (Página 1096)
MSRTEnumProtDataPlus (Página 1062)
2.10.2.4 MSG_RTDATA_INSTANCE_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwTimeDiff;
ULONGLONG ullCounter;
DWORD dwFlags;
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE]
TCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_RTDATA_INSTANCE_STRUCT_PLUS;
Members
dwMsgState

Los estados listados se utilizan sólo internamente por el sistema y pueden activarse
exclusivamente por API con MSRTCreateMsgInstanceWithCommentPlus.

dwMsgNrLow
dwMsgNrHigh
stMsgTime
Fecha y hora para visualización y ocultación de aviso.
dwTimeDiff
Duración de tiempo de visualización o ocultación, tiempo de telegrama en segundos.
ullCounter
Contador de avisos interno.
dwFlags
Flags en función de las constantes en el archivo "m_global.h":

MSG_RT_FLAG_COME 0x00000001 Aviso aparecido
MSG_RT_FLAG_GO 0x00000002 Aviso desaparecido
MSG_RT_FLAG_QUIT_COME 0x00000004 Acuse aparecido
MSG_RT_FLAG_QUIT_GO 0x00000008 Acuse desaparecido
MSG_RT_FLAG_NOQUIT 0x00000010 Sin obligación de acuse
MSG_RT_FLAG_QUIT_NOGO 0x00000020 Acuse TM II
MSG_RT_FLAG_FLASH 0x00000040 Intermitente
MSG_RT_FLAG_FIRSTFLASH 0x00000080 Solo puede parpadear el primer aviso
MSG_RT_FLAG_DELETE 0x00010000 El aviso se puede borrar
MSG_RT_FLAG_SUMTIME 0x00020000 Flag para horario de verano
MSG_RT_FLAG_SQUIT 0x00040000 Aviso tiene acuse de grupo
MSG_RT_FLAG_QUITNR 0x00080000 Número de aviso - acuse
MSG_RT_FLAG_MSGLIST 0x00100000 Aviso de lista de avisos
MSG_RT_FLAG_COMMENT 0x00200000 El aviso tiene comentario
MSG_RT_FLAG_ARCHIV 0x00400000 El aviso es archivado


MSG_RT_FLAG_PROTOCOL 0x00800000 El aviso es registrado
MSG_RT_FLAG_INSTANCE 0x01000000 Flag para aviso de instancia
MSG_RT_FLAG_TIMEINVALID 0x02000000 Flag para sello no válido de fecha/hora
MSG_RT_FLAG_LOCKGROUP 0x04000000 Flag para bloqueo de grupo
MSG_RT_FLAG_INSTANCE10 0x08000000 Bit para nuevo aviso de instancia con valor
de proceso 10
MSG_RT_FLAG_QUITCOUNTER 0x40000000 Bit para acuse vía counter
MSG_RT_FLAG_QUITGROUP 0x80000000 Bit para acuse vía counter
Flags para avisos en el fichero

MSG_FLAG_SUMTIME 0x00000001 Horario de verano activado
MSG_FLAG_COMMENT 0x00000002 El aviso tiene comentario
MSG_FLAG_ARCHIV 0x00000004 Archivar
MSG_FLAG_PROTOCOL 0x00000008 Registrar en informe
MSG_FLAG_TEXTVALUES 0x00000010 El aviso tiene valores asociados de texto
MSG_FLAG_TIMEINVALID 0x00000020 Bit para sello no válido de fecha/hora
MSG_FLAG_INSTANCE 0x00000040 Identificación de avisos de instancia
MSG_FLAG_INSTANCE10 0x08000000 Aviso de instancia con valor de proceso 10,
disponible a partir de V5.0 SP2
MSG_FLAG_TEXTREF1 0x10000000 Referencia de texto 1
MSG_FLAG_TEXTREF2 0x20000000 Referencia de texto 2
En la función MSRTCreateMsgInstanceWithCommentPlus no se pueden transferir flags al

servidor de alarmas. Los flags son ignorados.
wPValueUsed
wTextValueUsed
Valores de texto utilizados, bitcodificados.
número o texto.
En caso de un suministro doble erróneo se trata dPValue prioritariamente.
dPValue
Valores de proceso.

mtTextValue
asociados al texto.
szInstance
Nombre de instancia. Cuando no se suministra szInstance (string vacío), se crea un aviso
normal
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API

MSG_SERVICE_NOTIFY_PROC Servicio de envío y recepción (callback)
Consulte también
MSRTCreateMsgInstancePlus (Página 1068)
2.10.2.5 MSG_CLASS_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
WCHAR szName[MSG_MAX_TEXTLEN+1];
DWORD dwName;
DWORD dwClassID;
COLORREF crStateCome[2];
COLORREF crStateGo[2];
COLORREF crStateQuit[2];
WORD wQuitType;
WORD wHornQuit;
DWORD dwHornVar;
WCHAR szState[MSG_MAX_STATE][MSG_MAX_TEXTLEN+1];
DWORD dwState[MSG_MAX_STATE];
WCHAR szStateQuit[MSG_MAX_TEXTLEN+1];
DWORD dwStateQuit;
DWORD dwClassTyp;
DWORD dwCreatorID;
}
MSG_CLASS_STRUCT_PLUS;

Members
szName
El nombre de la categoría que debe indicarse depende del lenguaje de datos ajustado.
dwName
Si el nombre de la categoría está contenido en los textos del proyecto, aquí puede indicarse
la ID.
dwClassID
ID de la categoría ( 1..18(MSG_MAX_CLASS) )
crStateCome
Color para el estado "Aparecido".
crStateGo
Color para el estado "Desaparecido".
crStateQuit
Color para el estado "Acusado".
wQuitType
El autómata de estado se define con las siguientes constantes del archivo "m_global.h":
MSG_QUIT_QUIT_COME Acuse aparecido

MSG_QUIT_QUIT_GO Acuse desaparecido
MSG_QUIT_NOQUIT Sin obligación de acuse
MSG_QUIT_QUIT_NOGO Acuse (sin aviso de desaparición)
MSG_QUIT_FLASH Intermitente
MSG_QUIT_FIRSTFLASH Solo puede parpadear el primer aviso
MSG_QUIT_NOLIST No registrar avisos en lista de avisos
Las constantes del autómata finito pueden combinarse lógicamente bit a bit con "O" siempre
que no se contradigan.
wHornQuit
Acuse de avisador central
dwHornVar
Variable de avisador central
szState
Texto para los estados "Aparecido", "Desaparecido", "Aparecido y desaparecido".
dwState
TextID

szStateQuit
Texto para el estado "Acusado".
dwStateQuit
TextID
dwClassTyp
dwCreatorID
CreatorID
Observación
A diferencia de la estructura MSG_CLASS_STRUCT_EX, MSG_CLASS_STRUCTPlus no
dispone de identificador de autor.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTGetClassInfoPlus (Página 1075) Consultar información de categorías
Consulte también
MSRTGetClassInfoPlus (Página 1075)

2.10.2.6 MSG_CSDATA_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwStatus;
WORD wClass;
WORD wTyp;
DWORD dwTextID[MSG_MAX_TB];
DWORD dwQuitVar;
WORD wQuitBit;
DWORD dwStateVar;
WORD wStateBit;
DWORD dwMsgVar;
WORD wMsgBit;
WORD wAGNr;
WORD wAGSubNr;
DWORD dwGroupID;
DWORD dwPriority;
DWORD dwHidingMask;
}
MSG_CSDATA_STRUCT_PLUS;
Members
dwMsgNrLow
dwMsgNrHigh
dwStatus
Los parámetros del aviso individual se determinan con las siguientes constantes del archivo
"m_global.h":
MSG_PARAMS_SQUIT Sujeto a acuse individual

MSG_PARAMS_HORN Controla la bocina
MSG_PARAMS_ARCHIV Se archiva
MSG_PARAMS_PROTOCOL Se protocoliza
MSG_PARAMS_VARFLANK Se crea con flanco negativo
MSG_PARAMS_INFOTEXT Tiene texto informativo
MSG_PARAMS_LOOPINALARM Tiene Loop-In-Alarm
MSG_PARAMS_NORMDLL Tiene DLL de normalización
Usted puede enlazar estas constantes con OR cuando no se contradicen entre sí.

wClass
Categoría de aviso
wTyp
Tipo de aviso
dwTextID
Referencia a bloques de texto
dwQuitVar
Variable de acuse. Utilice la dwID de DM_VARKEY (Página 242).
wQuitBit
Bit de la variable de acuse
dwStateVar
Estado del aviso como variable. Utilice la dwID de DM_VARKEY (Página 242)
wStateBit
Con wStateBit se determinan cuales son los bits de dwStateVar que caracterizan el estado
del aviso.
Cuando wStateBit = 1 y dwStateVar corresponden al tipo de datos "8 Bit unsigned", el bit 1
de dwStateVar define el estado Aparecido / Desaparecido y el bit 5 caractiza la obligación de
acuse.
Cuando wStateBit = 2 y dwStateVar son una variable de palabra, el bit 2 de dwStateVar
determina el estado Aparecido / Desaparecido y el bit 10 caracteriza la obligación de acuse.
dwMsgVar
Variable de aviso. Utilice la dwID de DM_VARKEY (Página 242).
wMsgBit
Bit de la variable de aviso
wAGNr
Número PLC
wAGSubNr
Subnúmero PLC
dwGroupID
ID del grupo de avisos (interno)
dwPriority
Prioridad del aviso
dwHidingMask
Máscara de inhibición de visualización

Observación
Mediante esta estructura, su aplicación puede determinar los datos de configuración de un
aviso individual bajo utilización de las funciones API.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTGetMsgCSDataPlus (Página 1080) Consultar datos de configuración de aviso
Consulte también
MSRTGetMsgCSDataPlus (Página 1080)
2.10.2.7 MSG_RTGROUPENUM_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
BOOL fIDUsed;
DWORD dwID;
TCHAR szName[MSG_MAX_TEXTLEN+1];
DWORD dwMsgCount;
DWORD dwMsg[MSG_MAX_GROUPITEMS];
}
MSG_RTGROUPENUM_STRUCT_PLUS;
Members
fIDUsed
Determina si para la especificación del grupo de avisos se utiliza el ID del grupo
(fIDUsed = TRUE) o el nombre (fIDUsed = FALSE).
dwID
ID del grupo
szName
Nombre del grupo

dwMsgCount
Cantidad de avisos individuales en dwMsg
dwMsg
Avisos individuales bloqueados
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTEnumGroupMsgPlus (Página 1091) Listar avisos individuales de grupo de avisos

na 1057)
Consulte también
MSRTEnumGroupMsgPlus (Página 1091)
2.10.2.8 MSG_RTGROUPSET_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
BOOL fIDUsed;
DWORD dwID;
SYSTEMTIME stTime;
DWORD dwData;
}
MSG_RTGROUPSET_STRUCT_PLUS;
Members
fIDUsed
Determina si para la especificación del grupo de avisos se utiliza la ID del grupo
(fIDUsed = TRUE) o el nombre (fIDUsed = FALSE).
dwID
ID del grupo (en categorías, tipos de aviso)

szName
Nombre del grupo
stTime
Momento en que apareció
dwData
Si la estructura se utiliza en el contexto de MSRTLockGroupPlus, dwData = 1 significa
bloquear y dwData = 0 habilitar
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTLockGroupPlus (Página 1093) Bloquear grupo de avisos

MSRTEnumGroupMsgPlus (Página 1091) Listar avisos individuales de un grupo de avisos
MSRTQuitGroupPlus (Página 1094) Acusar grupo de avisos
Consulte también
MSRTQuitGroupPlus (Página 1094)
2.10.2.9 MSG_COMMENT_INSTANCE_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
SYSTEMTIME stTime;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
WCHAR szUser[MSG_MAX_USERNAME+1];
WCHAR szComputerName[MAX_COMPUTERNAME_LENGTH+1];
WCHAR szApplicationName[MSG_MAX_APPLNAME+1];
}
MSG_COMMENT_INSTANCE_STRUCT_PLUS;

Members
stTime
Fecha/hora
dwMsgNrLow
dwMsgNrHigh
szText
Comentario
szUser
Nombre de usuario
szComputerName
Nombre del equipo
szApplicationName
Nombre de aplicación
szInstance
Nombre de instancia
Observación
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTGetCommentInstancePlus (Página 1104) Consultar texto de comentario

MSRTSetCommentInstancePlus (Página 1105) Definir texto de comentario
Consulte también
MSRTSetCommentInstancePlus (Página 1105)
MSRTGetCommentInstancePlus (Página 1104)

2.10.2.10 MSG_INFOTEXT_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
}
MSG_INFOTEXT_STRUCT_PLUS;
Members
dwMsgNrLow
dwMsgNrHigh
szText
Texto informativo
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTGetInfotextPlus (Página 1107) Consultar texto informativo

MSRTSetInfotextPlus (Página 1108) Definir texto informativo
Consulte también
MSRTGetInfotextPlus (Página 1107)
MSRTSetInfotextPlus (Página 1108)

2.10.2.11 MSG_BACKUP_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
WCHAR szArchivFile[MAX_PATH+1];
WCHAR szArchivTextFile[MAX_PATH+1];
WCHAR szCommentFile[MAX_PATH+1];
WCHAR szInstanceFile[MAX_PATH+1];
WCHAR szComment[MAX_PATH+1];
DWORD dwFlags;
DWORD dwFormat;
}
MSG_BACKUP_STRUCTPlus;
Members
stFrom
Fecha desde
stTo
Fecha hasta
szArchivFile
Nombre de archivo y ruta del archivo de trasvase del fichero
szArchivTextFile
Nombre de archivo y ruta del archivo de trasvase para textos de fichero
szCommentFile
Nombre de archivo y ruta del archivo de trasvase de comentarios
szInstanceFile
Nombre de archivo y ruta del archivo de trasvase de instancias
szComment
Comentario de libre definición
dwFlags
MSG_DB_FLAGS_OVERWRITE 0x0001 Sobrescribir registros existentes

MSG_DB_FLAGS_ADD 0x0002 Solo agregar
MSG_DB_FLAGS_DELETE 0x0004 Borrar registros fuente

dwFormat
Para el formato del archivo de exportación se pueden utilizar las siguientes constantes del
archivo "m_global.h":
MSG_DB_FMT_CSV Formato de archivo CSV

MSG_DB_FMT_DBASE3 Formato de archivo DBASE3
MSG_DB_FMT_WATCOM Formato Sybase
Observación
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
MSRTEnumBackupListPlus (Página 1110) Listar entradas de un fichero de trasvase

MSRTGetBackupSize Determinar el tamaño del fichero de trasvase
MSRTRestore Importar avisos
Consulte también
MSRTEnumBackupListPlus (Página 1110)
MSRTExportPlus (Página 1111)
2.10.2.12 MSG_RTLOCK_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
WCHAR szParent[MSG_MAX_TEXTLEN+1];
DWORD dwLockID;
BOOL fLock;
DWORD dwMsgNum;
DWORD dwMsgLock[MSG_MAX_LOCKITEMS];
}
MSG_RTLOCK_STRUCT_PLUS;

Members
szName
Nombre del bloqueo
szParent
Grupo paternal
dwLockID
ID del bloqueo
fLock
Bloquar o bien habilitar
dwMsgNum
Cantidad de avisos bloqueados
dwMsgLock
Avisos individuales bloqueados
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API

na 1057)
Consulte también
2.10.2.13 MSG_TEXTVAL256_STRUCT_PLUS (RT Professional)
Declaración
typedef struct {
WCHAR szText[MSG_MAX_TEXTVAL256+1];
}
MSG_TEXTVAL256_STRUCT_PLUS;

Observación
La estructura se utiliza dentro de las siguientes estructuras:
Members
szText
Texto
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API

gina 1066)
MSRTGetLastMsgWithCommentPlus (Pági‐ Consultar último aviso pendiente
na 1077)
MSG_SERVICE_NOTIFY_PROCPlus (Pági‐ Servicio de envío y recepción (Callback)
na 1057)
Consulte también
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Página 1033)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
MSG_RTCREATE_STRUCT_PLUS (Página 1024)
2.10.3.1 MSRTEnumArchivDataPlus (RT Professional)
Descripción
Enuma todos los avisos del fichero indicado. Su función callback
MSG_SERVICE_NOTIFY_PROCPlus se llama con el tipo de notificación
MSG_NOTIFY_ARCHIVENUM. lpbyData refiere a datos de la estructura
MSG_RTARCHIV_STRUCTPlus.
Las funciones de enumeración funcionan asíncronamente. A causa de ello deben
sincronizarse los accesos son semáforos.

Declaración
BOOL MSRTEnumArchivDataPlus(
DWORD dwServiceID,
BOOL fArchiv,
DWORD dwMaxRecords
DWORD dwParams
LPDWORD lpdwTAID
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
fArchiv
Identifica el tipo de fichero.
TRUE Fichero de continuación
FALSE Fichero circular
dwMaxRecords
Cantidad de registros de datos que deben listarse como máximo. En caso de un exceso de
dwMaxRecords se interrumpe la enumeración. Cuando dwMaxRecords = 0xFFFFFFFF, se
listan todos los avisos.
dwParams
Parámetros para el orden de clasificación:
MSG_ARCHIV_ENUM_DESC Clasificación descendente
lpdwTAID
Puntero a la TransactionID con procesamiento asíncrono.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
Valor de retorno
TRUE
Avisos listados.

FALSE
Error
Mensajes de error
MSG_ERR_API_PARAM Parámetro no válido
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

na 1057)
Consulte también
2.10.3.2 MSRTStartMsgServicePlus (RT Professional)
Descripción
Inicia un servicio para el envío y la recepción de mensajes al sistema de avisos.

Declaración
BOOL MSRTStartMsgService (
LPDWORD lpdwServiceID,
LPWSTR lpszServer,
DWORD dwFlags,
DWORD dwFilterCount
LPMSG_FILTER_STRUCT_PLUS* lpMsgFilter,
DWORD dwNotifyMask,
MSG_SERVICE_NOTIFY_PROC_PLUS lpfnNotifyProcPlus
LPVOID lpvUserNotify,
MSG_TAID_COMPLETION_PROC_PLUS lpfnTAIDProcPlus
LPVOID lpvUserTAID
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Contiene después de la llamada exitosa de la función, el número de identificación del servicio
de envío y recepción que se requiere de muchas funciones.
lpszServer
Prefijo de servidor
dwFlags
dwFilterCount
Puntero a las condiciones de filtrado (NULL = todos los avisos)
lpMsgFilter
Puntero a los datos del filtro de avisos en la estructura MSG_FILTER_STRUCT_PLUS
(Página 1029).
dwNotifyMask
Identifica el tipo de mensaje, según la definición de constante en el archivo "msrtapi.h":
MSG_NOTIFY_MASK_MSGLIST Mensajes sobre aviso

MSG_NOTIFY_MASK_LOCK Mensajes sobre bloqueo
MSG_NOTIFY_MASK_ARCHIV Mensajes sobre avisos archivados
MSG_NOTIFY_MASK_ALL Todo tipo de mensajes
lpfnNotifyProcPlus
Puntero a su función Callback del tipo MSG_SERVICE_NOTIFY_PROCPlus. Para la
transferencia de mensajes a través del servicio.

Con lpfnNotifyProcPlus = NULL no se retornan mensajes por el servicio,
Nota
WinCC.
lpvUserNotify
lpfnTAIDProcPlus
Función de rellamada para procesamiento asíncrono respuesta.
lpvUserTAID
lpError
Valor de retorno
TRUE
Servicio iniciado.
FALSE
Error
Observación
Su aplicación puede instalar un máximo de 16 servicios. En total pueden instalarse hasta 128
servicios.
Mensajes de error
MSG_ERR_RT_NOTCONNECTED Conexión no establecida con el sistema de avisos

MSG_ERR_RT_NOINIT Sistema de avisos no inicializado
MSG_ERR_RT_SERVICEMAX Cantidad máxima de servicios alcanzada
MSG_ERR_NOSERVER Ningún servidor estándar configurado y ningún
servidor local disponible

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
MSRTStopMsgServicePlus (Página 1055) Detener servicio

na 1057)
Consulte también
MSRTExportPlus (Página 1111)
MSRTGetInfotextPlus (Página 1107)
MSRTSetInfotextPlus (Página 1108)
MSRTGetClassInfoPlus (Página 1075)
MSG_FILTER_STRUCT_PLUS (Página 1029)
MSRTGetMsgCSDataPlus (Página 1080)
MSRTGetMsgPriorityPlus (Página 1082)
MSRTGetMsgQuitPlus (Página 1083)
MSRTGetMsgTextPlus (Página 1085)
MSRTGetSelectedMsgPlus (Página 1086)
MSRTResetMsgPlus (Página 1088)
MSRTLoopInAlarmPlus (Página 1090)
MSRTEnumArchivDataPlus (Página 1049)
MSRTStopMsgServicePlus (Página 1055)
MSRTQuitHornPlus (Página 1056)
MSRTGetCommentInstancePlus (Página 1104)


MSRTGetMsgActualPlus (Página 1079)
2.10.3.3 MSRTStopMsgServicePlus (RT Professional)
Descripción
Detiene el servicio de envío y recepción de notificaciones.
Declaración
BOOL MSRTStopMsgServicePlus (
DWORD dwServiceID,
Parámetros
dwServiceID
LPCMN_ERRORW
Valor de retorno
TRUE
Servicio terminado.
FALSE
Error
Observación
Nota
La llamada no debe usarse en el destructor de una aplicación (EXE, DLL, OCX, ...) porque
eventualmente se colgaría la llamada y por lo tanto del programa debido a los mecanismos
específicos de Microsoft.

Mensajes de error
MSG_ERR_RT_NOTCONNECTED Conexión no establecida con el sistema de avisos

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.3.4 MSRTQuitHornPlus (RT Professional)
Descripción
Acusa el aviso central según la especificación de clase.
Declaración
BOOL MSRTQuitHornPlus(
DWORD dwServiceID,
LPDWORD lpdwTAID,
Parámetros
dwServiceID

lpdwTAID
Puntero a la TransactionID para el procesamiento asíncrono.
LPCMN_ERRORW
Valor de retorno
TRUE
Aviso acusado.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.3.5 MSG_SERVICE_NOTIFY_PROCPlus (RT Professional)
Descripción
Su función callback para funciones de enumeración. Las funciones de enumeración funcionan
asíncronamente. A causa de ello deben sincronizarse los accesos son semáforos.

Declaración
BOOL ( * MSG_SERVICE_NOTIFY_PROC) (
DWORD dwNotify,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUserNotify);
Parámetros
dwNotify
El tipo de notificación se determina con las constantes en el archivo "MSRTAPI.h":
Notificaciones generales lpbyData muestra la estructura

MSG_NOTIFY_CONNECT Conexión establecida -
MSG_NOTIFY_DISCONNECT Conexión interrumpida -
MSG_NOTIFY_RESTART Sistema de aviso Runtime nuevos -
datos
MSG_NOTIFY_SHUTDOWN Sistema de aviso se finalizará -
MSG_NOTIFY_MSGENUM Enumeración de la lista de avisos MSG_RTDATA_INSTANCE_STRUCTPlus
MSG_NOTIFY_ARCHIVENUM Enumeración fichero aviso(s) MSG_RTDATA_STRUCTPlus (en bloques)
MSG_NOTIFY_ARCHIVENUMINST Fichero aviso(s) enumeración con MSG_RTDATA_INSTANCE_STRUCTPlus
instancias (en bloques)
MSG_NOTIFY_LOCKENUM Enumeración de bloqueos MSG_LOCK_STRUCTPlus (en bloques)
MSG_NOTIFY_WINENUM Ventana de aviso - Enumeración MSG_WIN_STRUCTPlus (en bloques)
MSG_NOTIFY_BACKUPENUM Enumeración de la lista de inter‐ MSG_BACKUP_STRUCTPlus (en bloques)
cambio
MSG_NOTIFY_ARCDAYENUM Enumeración de la lista diaria MSG_ARCHIVDAY_STRUCTPlus
MSG_NOTIFY_ENUMMAX Se interrumpió la enumeración con -
la cantidad máxima
MSG_NOTIFY_LANGUAGESET Conmutación de idioma realizada -
Avisos individuales lpbyData muestra la estructura

MSG_NOTIFY_MSGADD Nuevo aviso añadido MSG_RTDATA_INSTANCE_STRUCTPlus
(individual)
MSG_NOTIFY_MSGDELETE Aviso borrado MSG_RTDATA_INSTANCE_STRUCTPlus
(individual)
MSG_NOTIFY_MSGMODIFY Aviso modificado MSG_RTDATA_INSTANCE_STRUCTPlus
(individual)
MSG_NOTIFY_MSGCOUNT Cantidad actual de avisos -
Grupos de aviso lpbyData muestra la estructura

MSG_NOTIFY_GROUPENUM Enumeración de avisos individua‐ MSG_RTGROUPENUM_STRUCTPlus (en
les en un grupo de avisos bloques)

Bloqueo de avisos lpbyData muestra la estructura

MSG_NOTIFY_LOCKMODIFY Bloqueo aplicado, modificado, bo‐ MSG_RTGROUPENUM_STRUCTPlus
rrado
Avisos de fichero lpbyData muestra la estructura

MSG_NOTIFY_ARCHIVADD Aviso(s) de fichero anadido(s) MSG_RTDATA_INSTANCE_STRUCTPlus
(individual)
MSG_NOTIFY_ARCHIVDELETE Aviso(s) de fichero borrado(s) MSG_RTDATA_INSTANCE_STRUCTPlus
(individual)
lpbyData
Según el tipo de notificación, lpbyData contiene un puntero a los datos.
Notificaciones generales Ningún dato

Avisos individuales Datos Runtime, guardados en estructuras del tipo
● MSG_RTDATA_INSTANCE_STRUCT_PLUS (Página 1033)
Grupos de aviso Datos de avisos individuales en estructuras del tipo
● MSG_RTGROUPENUM_STRUCT_PLUS (Página 1041)
Bloquear Datos de bloqueo en estructuras del tipo
● MSG_RTLOCK_STRUCT_PLUS (Página 1047)
Avisos de fichero Datos de fichero en estructuras del tipo
● MSG_RTDATA_INSTANCE_STRUCT_PLUS (Página 1033)
dwItems
Contiene la cantidad de los objetos retornados en lpbyData. Cuando dwItems = 0, luego es
también lpbyData = NULL. El notify se termina y se habilita el semáforo.
lpvUserNotify
función callback.
Valor de retorno
TRUE
Se ha detectado y procesado la notificación.
FALSE
Error

Observación
Nota
WinCC.
Cuando la función Callback se programa como función de proyecto en el script, la llamada

asíncrona hace que la función no disponga de todo el contexto del script, particularmente no
funcionan las llamadas GetTag... y SetTag. Las ediciones deben realizarse eventualmente en
otras acciones que pueden dispararse solamente por el callback.
Archivos necesarios
CCMSRTCLIPlus.h
Consulte también
MSG_RTGROUPENUM_STRUCT_PLUS (Página 1041)
MSG_RTLOCK_STRUCT_PLUS (Página 1047)

2.10.3.6 MSRTWebClientPlus (RT Professional)
Descripción
Inicializa la DLL para un WebClient
Declaración
VOID WINAPI MSRTWebClientPlus(

LPCWSTR pszProjectPath,
DWORD dwDataLocale);
Parámetros
pszProjectPath
Ruta al WebProjekt
dwDataLocale
Valor de retorno
2.10.4 Funciones para la edición de protocolos (RT Professional)
2.10.4.1 MSRTActivateMProtPlus (RT Professional)
Descripción
Detener o continuar el servicio de informes para la emisión de un informe de avisos de
continuación.
Declaración
BOOL MSRTActivateMProtPlus(
BOOL fActive,

Parámetros
fActive
Determina cómo debe tratarse el servicio de informes:
TRUE Continuar el servicio de informes

FALSE Detener el servicio de informes
lpError
Valor de retorno
TRUE
FALSE
Error
Mensajes de error
MSG_ERR_PROT_ACTIVE Servicio de informes ya activo
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
2.10.4.2 MSRTEnumProtDataPlus (RT Professional)
Descripción
Enumeración de los datos de informe. Los diferentes datos de informe se separan mediante
una coma. Ya no se da soporte a la función.

Declaración
BOOL MSRTEnumProtDataPlus (
DWORD dwProtID,
MSG_PROT_NOTIFY_PROC lpfnEnum,
LPMSG_FILTER_STRUCT lpMsgFilter,
LPVOID lpvUser,
Parámetros
dwProtService
ID de servicio para el intercambio de datos de informe.
lpfnEnum
Su función callback que recibe los datos de informe.
lpMsgFilter
Puntero a los datos del filtro de avisos en la estructura MSG_FILTER_STRUCT_PLUS
(Página 1029).
lpvUser
lpError
Valor de retorno
TRUE
Datos de informe listados.
FALSE
Error
Observación
ADVERTENCIA
Con esta función, su aplicación puede acusar avisos sin asegurar que el operador de planta
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integradidad
o bien un peligro para valores materiales!

Mensajes de error
MSG_ERR_PROT_ID Identificación de informe no válida
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
MSG_PROT_NOTIFY_PROC Función callback
Consulte también
2.10.4.3 MSRTPrintMProtPlus (RT Professional)
Descripción
Imprime los avisos actualmente pendientes del informe de avisos de continuación, incluso con
la página todavía no está llena.
Declaración
BOOL MSRTPrintMProtPlus(
DWORD* pdwLines,
Parámetros
pdwLines
Puntero al número de líneas. Aquí se retorna la cantidad de líneas impresas. Es por ello que
el parámetro debe asignarse con NULL previamente a la llamada.
lpError

Valor de retorno
TRUE
Avisos actualmente pendientes impresos.
FALSE
Error
Mensajes de error
MSG_ERR_NOPROT Informe de avisos de continuación no activo
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
2.10.5 Funciones para la edición de avisos (RT Professional)
2.10.5.1 MSRTEnumArchivInstancePlus (RT Professional)
Descripción
Enumera con nombres de instancia todos los avisos del fichero especificado. Se devuelve la
estructura MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS.
Declaración
BOOL WINAPI MSRTEnumArchivInstancePlus(

DWORD dwServiceID,
BOOL fArchiv,
DWORD dwMaxRecords,
DWORD dwParams,
LPDWORD lpdwTAID,
Parámetros
dwServiceID
ID del servicio instalado

fArchiv
Fichero circular o secuencial
dwMaxRecords
Máximo número de registros para enumeración\n. En caso de sobrepasarse el número
máximo, se interrumpe la enumeración.
dwParams
Parámetro adicional, MSG_ENUM_ARCHIV_DESC = clasificación descendente
lpdwTAID
Puntero a la TransactionID para respuesta a procesamiento asíncrono
lpError
Puntero a la estructura ampliada de errores
Valor de retorno
TRUE
FALSE
Error
2.10.5.2 MSRTCreateMsgInstanceWithCommentPlus (RT Professional)
Descripción
Crea un aviso con el número de aviso indicado, con nombre de instancia y comentario. A
diferencia de la mayoría de las llamadas de Create, los valores asociados de texto pueden
contener hasta 256 caracteres (255 + EndOfString). El aviso se ingresa en la lista actual de
avisos con los datos indicados.
Declaración
BOOL WINAPI MSRTCreateMsgInstanceWithCommentPlus(

DWORD dwServiceID,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgCreatePlus,
LPDWORD lpdwTAID,

Parámetros
dwServiceID
ID del servicio
lpMsgCreatePlus
Puntero a Createstruct para generar el aviso
Utilice siempre etiquetas de fecha/hora distintas para los diferentes avisos.
lpdwTAID
Puntero a la TransactionID de respuesta a procesamiento asíncrono
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
FALSE
Error
Observación
Las funciones Create trabajan asincrónicamente. A causa de ello deben sincronizarse los
accesos eventualmente son semáforos.
Al utilizar la llamada para el acuse de un aviso, debe indicarse el tiempo Aparecido con
precisión en milisegundos.
ADVERTENCIA
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integridad
o bien un peligro para bienes materiales!
Mensajes de error

MSG_ERR_API_SERVICE dwServiceID no válido
Archivos requeridos
CCMSRTCLIPlus.h

CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
MSRTCreateMsgInstancePlus (Página 1068) Crear aviso de instancia

Consulte también
2.10.5.3 MSRTCreateMsgInstancePlus (RT Professional)
Descripción
Crea un aviso con el número de aviso indicado. El aviso se ingresa en la lista actual de avisos
con los datos indicados.
Declaración
BOOL WINAPI MSRTCreateMsgInstancePlus (

DWORD dwServiceID,
LPMSG_RTDATA_INSTANCE_STRUCT_PLUS lpMsgCreatePlus,
LPDWORD lpdwTAID,
Parámetros
dwServiceID
lpMsgCreatePlus
lpdwTAID

lpError
Valor de retorno
TRUE
FALSE
Error
Observación
Al utilizar la llamada para el acuse de un aviso, debe indicarse el tiempo Aparecido con
precisión en milisegundos.
ADVERTENCIA
Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
MSRTCreateMsgInstanceWithCommentPlus (Pá‐ Crear aviso de instancia con comentario

gina 1066)

Consulte también
2.10.5.4 MSRTDialogMsgLockPlus (RT Professional)
Descripción
Diálogo para bloqueo o habilitación de avisos.
Existen las siguientes posibilidades:

● Bloqueo de avisos individuales
● Bloqueo de categorías o grupos de avisos
● Bloqueo de avisos mediante el número de aviso
Nota
Aviso bloqueado:
Los avisos bloqueados no se registran en la lista de avisos, no se archivan ni se registran.
¡Los avisos bloqueados retornan su señal de acuse!
Los avisos bloqueados ya no lo están tras reiniciar WinCC Runtime. Se mantienen
bloqueados sólo los avisos que se bloquean directamente en el AS mediante bloques de
datos (bloqueo por fuente).
Categorías / grupos de avisos bloqueados:
El bloqueo de categorías y grupos de avisos se mantiene incluso después de reiniciar
WinCC Runtime.

Declaración
BOOL MSRTDialogMsgLockPlus(
HWND hwndParent,
Parámetros
hwndParent
Ventana padre que contiene el diálogo.
lpError
Valor de retorno
TRUE
Diálogo exitosamente terminado.
FALSE
Error o se ha cancelado el diálogo.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
2.10.5.5 MSRTCreateMsgPlus (RT Professional)
Descripción
Crea un aviso con el número de aviso indicado. El aviso se ingresa en la lista actual de avisos
con los datos indicados.

Declaración
BOOL WINAPI MSRTCreateMsgPlus(

DWORD dwServiceID,
LPMSG_RTCREATE_STRUCT_PLUS lpMsgCreatePlus,
LPDWORD lpdwTAID,
Parámetros
dwServiceID
lpMsgCreatePlus
IpdwTAID
Puntero a la TransactionID para procesamiento asíncrono
lpError
Valor de retorno
TRUE
FALSE
Error
Observación
ADVERTENCIA

Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
MSRTCreateMsgInstanceWithCommentPlus (Pá‐ Crear aviso de instancia

gina 1066)
MSRTCreateMsgInstancePlus (Página 1068) Crear aviso de instancia con comentario
Consulte también
2.10.5.6 MSRTEnumLockedMsgPlus (RT Professional)
Descripción
Enumera todos los avisos bloqueados.
Declaración
BOOL WINAPI MSRTEnumLockedMsgPlus(

DWORD dwServiceID,
LPDWORD lpdwTAID,
LPCMN_ERRORW lpError);

Parámetros
dwServiceID
lpdwTAID
Puntero a la TransactionID para el procesamiento asíncrono
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR.
Valor de retorno
TRUE
Avisos enumerados.
FALSE
Error.
2.10.5.7 MSRTEnumMsgRTDataPlus (RT Professional)
Descripción
Enumera todos los avisos disponibles en la lista actual de avisos. Su función de callback
MSG_SERVICE_NOTIFY_PROCPlus se accede con el tipo de notificación
MSG_NOTIFY_MSGENUM, enumeración de avisos. lpbyData refiere a los datos de la
estructura MSG_RTDATA_STRUCTPlus.
Declaración
BOOL MSRTEnumMsgRTData(
DWORD dwServiceID,
LPDWORD pdwTAID
Parámetros
dwServiceID

lpdwTAID
LPCMN_ERRORW
Valor de retorno
TRUE
Avisos enumerados.
FALSE
Error.
Mensajes de error

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.5.8 MSRTGetClassInfoPlus (RT Professional)
Descripción
Obtener información acerca de una categoría.

Declaración
BOOL WINAPI MSRTGetClassInfoPlus(

DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CLASS_STRUCT_PLUS lpClassPlus,
Parámetros
dwServiceID
ID del servicio con cuyo servidor se desea conectar
lpszServer
Servidor al que se desea conectar
dwMsgNrLow
Número de aviso DWORD inferior
dwMsgNrHigh
Número de aviso DWORD WinCC superior
lpClassPlus
Puntero que recoge la información
lpError
Valor de retorno
TRUE
FALSE
Error
Observación
La función MSRTGetClassInfoPlus puede accederse también sin MSRTStartMsgServicePlus.
No obstante, estos accesos son mucho más lentos. El rendimiento mejora si primero se
ejecuta un MSRTStartMsgServicePlus y se conserva en todas las llamadas. En este caso,
solamente el primero acceso de MSRTGetClassInfoPlus resulta más lento.

Mensajes de error
MSG_ERR_RT_NOINIT Alarm Logging RT no inicializado

MSG_ERR_MSG_NOEXIST El aviso no existe
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_CLASS_STRUCT_PLUS (Página 1036)
2.10.5.9 MSRTGetLastMsgWithCommentPlus (RT Professional)
Descripción
Busca el último aviso del fichero sobre la base de la condición de filtro y el nombre de instancia.
Declaración
BOOL WINAPI MSRTGetLastMsgWithCommentPlus(

LPCWSTR lpszServer,
LPCWSTR lpszInstance,
LPMSG_FILTER_STRUCT_PLUS* lppFilter,
DWORD dwFilterCount,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsg,
Parámetros
lpszServer
Prefijo de servidor sin '::'. En caso de indicar un string vacío o CERO, se utiliza el servidor
predeterminado ajustado.

lpszInstance
Nombre de instancia. Se añade un string vacío o también NULL a la condición de filtro.
lppFilter
Puntero al puntero de filtro ARRAY para seleccionar el tipo de aviso.
dwFilterCount
Número de avisos filtrados.
lpMsg
Devuelve los datos del aviso.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR.
Valor de retorno
TRUE
Aviso consultado.
FALSE
Error.
Mensajes de error

MSG_ERR_RT_NOTCONNECTED Conexión no establecida
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también

2.10.5.10 MSRTGetMsgActualPlus (RT Professional)
Descripción
La función determina la cantidad de avisos actualmente pendientes en la lista de avisos.
Declaración
BOOL MSRTGetMsgActualPlus (
LPDWORD lpdwCount,
Parámetros
lpdwCount
Puntero a un búfer en el cual se guarda la cantidad de los avisos actualmente pendientes.
lpError
Valor de retorno
TRUE
Cantidad determinada.
FALSE
Error
Observación
La función MSRTGetMsgActualPlus puede accederse también sin
MSRTStartMsgServicePlus. No obstante, estos accesos son mucho más lentos. El
rendimiento mejora si primero se ejecuta un MSRTStartMsgServicePlus y se conserva en
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgActualPlus
resulta más lento.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h

CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.5.11 MSRTGetMsgCSDataPlus (RT Professional)
Descripción
Consultar datos de configuración de un aviso.
Declaración
BOOL MSRTGetMsgCSDataPlus (
DWORD dwServiceNr,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CSDATA_STRUCT_PLUS lpmCSDataPlus,
Parámetros
dwServiceID
de MSRTStartMsgService.
lpszServer
Nombre del servidor.
dwMsgNrLow
dwMsgNrHigh

lpmCSDataPlus
Puntero a los datos de configuración (categoría, tipo de aviso, índices de bloque de texto, etc.)
de este aviso en la estructura MSG_CSDATA_STRUCT_PLUS (Página 1039).
lpError
Valor de retorno
TRUE
Datos de configuración consultados.
FALSE
Error
Observación
La función MSRTGetMsgCSDataPlus puede accederse también sin
MSRTStartMsgServicePLus. No obstante, estos accesos son mucho más lentos. El
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgCSDataPlus
resulta más lento.
Mensajes de error

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_CSDATA_STRUCT_PLUS (Página 1039)

2.10.5.12 MSRTGetMsgPriorityPlus (RT Professional)
Descripción
Consultar prioridad del aviso indicado.
Declaración
BOOL MSRTGetMsgPriorityPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
long* plPriority,
Parámetros
dwServiceID
lpszServer
Nombre del servidor.
dwMsgNrLow
dwMsgNrHigh
plPriority
Puntero a una variable del tipo de datoslong, en la cual se guarda la prioridad.
¡Este parámetro no debe ser NULL!
lpError
Valor de retorno
TRUE
Prioridad consultada.

FALSE
Error
Observación
La función MSRTGetMsgPriorityPlus puede accederse también sin
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgPriorityPlus
resulta más lento.
Mensajes de error

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.5.13 MSRTGetMsgQuitPlus (RT Professional)
Descripción
Consultar cantidad de avisos sujetos a acuse.
Declaración
BOOL MSRTGetMsgQuitPlus(
LPDWORD lpdwCount,

Parámetros
lpdwCount
Puntero para la cantidad de avisos sujetos a acuse
lpError
Valor de retorno
TRUE
Cantidad determinada.
FALSE
Error
Observación
resulta más lento.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también

2.10.5.14 MSRTGetMsgTextPlus (RT Professional)
Descripción
Obtener texto para un bloque de texto
Declaración
BOOL WINAPI MSRTGetMsgTextPlus(

WORD wTextBlock,
DWORD dwTextNr,
LPWSTR lpszMsgText,
DWORD* lpdwCount,
Parámetros
wTextBlock
Número de bloque de texto
dwTextNr
ID del bloque de texto
lpszMsgText
Puntero al string del bloque de texto
IpdwCount
Puntero a la longitud del string del bloque de texto. La longitud se indica en forma de número
de caracteres.
lpdwCount=0 Se consulta el tamaño del texto.

lpdwCount>0 El texto se limita y se devuelve el número ac‐
Y tamaño de búfer de lpszMsgText > lpdwCount tual de caracteres.
lpdwCount>0 El texto se limita y es devuelto.
Y tamaño de búfer de lpszMsgText > lpdwCount
Y búfer inicializado
lpError
Valor de retorno
TRUE

FALSE
Error
Observación
La función MSRTGetMsgPriorityPlus puede llamarse también sin MSRTStartMsgServicePlus.
No obstante, estos accesos son mucho más lentos. El rendimiento mejora si primero se
ejecuta un MSRTStartMsgServicePlus y se conserva en todas las llamadas. En este caso,
solamente el primero acceso de MSRTGetMsgPriorityPlus resulta más lento.
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.5.15 MSRTGetSelectedMsgPlus (RT Professional)
Descripción
La función determina el número de aviso para un mensaje para un mensaje seleccionado en
una ventana de aviso o un visor de avisos. La especificación del visor se realiza con
lpszTemplate.
En los proyectos de puesto(s) único o múltiples, las consultas en las plantillas funcionan sin
restricciones. Las consultas en el visor no funcionan para datos de ingeniería y sólo para
valores de proceso disponibles en el visor.

Declaración
BOOL MSRTGetSelectedMsgPlus(
LPCWSTR lpszTemplate,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
Parámetros
lpszTemplate
Puntero al nombre del visor en el que se ha seleccionado un aviso.
lpMsgRTPlus
Puntero a una estructura del tipo MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS
(Página 1026), en la que se retorna el número de aviso.
lpError
Valor de retorno
TRUE
Datos consultados.
FALSE
Error
Observación
resulta más lento.
Nota
En función de la vista ajustada en el visor, se asignan los indicadores en dwFlags de la
estructuraMSG_RTDATA_INSTANCECOMMENT_STRUCTPlus de manera diferente:
● para la vista online: Indicadores MSG_RT_FLAG_xxx,
● para la vista de fichero: Indicadores MSG_FLAG_, así como
● para la lista de hits: Sin asignación posible, indicadores son ignorados

Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Ejemplos
Get selected Msg"MS02.cpp"
Consulte también
2.10.5.16 MSRTResetMsgPlus (RT Professional)
Descripción
El aviso indicado se acusará.
Declaración
BOOL MSRTResetMsgPlus(
DWORD dwServiceID,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPDWORD lpdwTAID
Parámetros
dwServiceID

dwMsgNrLow
dwMsgNrHigh
Hay que asignar dwMsgNrLow y dwMsgNrHigh cuando se utilicen los criterios de filtro
MSG_FILTER_NR, MSG_FILTER_NR_FROM o MSG_FILTER_NR_TO.
lpdwTAID
lpError
Valor de retorno
TRUE
Aviso acusado.
FALSE
Error
Observación
ADVERTENCIA
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integradidad
o bien un peligro para valores materiales!
Mensajes de error

MSG_ERR_MSG_NOTFOUND Aviso no encontrado
MSG_ERR_MSG_NOQUIT Aviso no sujeto a obligación de acuse
MSG_ERR_MSG_ALREADYQUIT Aviso ya acusado
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib

CCMSRTCLIPlus.dll
Consulte también
2.10.5.17 MSRTLoopInAlarmPlus (RT Professional)
Descripción
API: Función para Loop-In-Alarm. El criterio decisivo es el número de aviso.
Declaración
BOOL MSRTLoopInAlarmPlus(
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
Parámetros
dwServiceID
ID del servicio con cuyo servidor se desea conectar
lpszServer
Servidor al que se desea conectar
dwMsgNrLow
Número de aviso DWORD inferior
dwMsgNrHigh
Número de aviso DWORD WinCC superior
lpError

Valor de retorno
TRUE
FALSE
Error
Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.6 Funciones para la edición de grupos de aviso (RT Professional)
2.10.6.1 MSRTEnumGroupMsgPlus (RT Professional)
Descripción
Enumerar todos los avisos individuales del grupo de avisos. Como máximo se enumeran
MSG_MAX_GROUPITEMS avisos individuales. La función Callback
MSG_SERVICE_NOTIFY_PROCPlus se llama con el tipo de notificación
MSG_NOTIFY_GROUPENUM. lpbyData hace referencia a datos de la estructura
MSG_RTGROUPENUM_STRUCTPlus.
Las funciones de enumeración del sistema de avisos trabajan de forma asíncrona. A causa
de ello deben sincronizarse los accesos son semáforos.

Declaración
BOOL WINAPI MSRTEnumGroupMsgPlus(

DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCT_PLUS lpmGroupPlus,
LPDWORD lpdwTAID,
Parámetros
dwServiceID
ID del servicio
lpmGroupPlus
Puntero a información de grupos de avisos
IpdwTAID
lpError
Valor de retorno
TRUE
FALSE
Error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

na 1057)
MSG_RTGROUPENUM_STRUCT_PLUS (Pági‐ Avisos individuales de un grupo de avisos
na 1041)

Consulte también
MSG_RTGROUPSET_STRUCT_PLUS (Página 1042)
MSG_RTGROUPENUM_STRUCT_PLUS (Página 1041)
2.10.6.2 MSRTLockGroupPlus (RT Professional)
Descripción
Bloqueo de un grupo configurado de aviso. Se bloquean también todos los avisos individuales
del grupo de aviso, así como los avisos individuales de los grupos subordenados.
Declaración
BOOL MSRTLockGroupPlus (
DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCTPlus lpmGroup,
LPDWORD pdwTAID
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se retorna en el acceso de
MSRTStartMsgServicePlus.
lpmGroup
Puntero sobre la estructura MSG_RTGROUPSET_STRUCT_PLUS (Página 1042) con la
información de los grupos de aviso.
Bloquear: dwData != 0; habilitar: dwData = 0
pdwTAID
lpError
Puntero sobre los datos del aviso extendido de error en la estructura CMN_ERRORW. En
caso de un error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Avisos del grupo de avisos bloqueados.

FALSE
Error
Observación
Se bloquean o habilitan solamente los grupos configurados de aviso. Los grupos definidos en
Runtime no se registran y la función no tiene ningún efecto.
Mensajes de error

MSG_ERR_API_PARAM Parámetro inválido
MSG_ERR_API_SERVICE dwServiceID inválido
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
2.10.6.3 MSRTQuitGroupPlus (RT Professional)
Descripción
Acusar un grupo de avisos. Se acusan todos los avisos individuales del grupo de avisos, así
como los avisos de los grupos subordinados.

Declaración
BOOL MSRTQuitGroupPlus (
DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCTPlus lpmGroupPlus,
LPDWORD pdwTAID
Parámetros
dwServiceID
lpmGroup
Puntero a una estructura del tipo MSG_RTGROUPSET_STRUCT_PLUS (Página 1042) con
la información de los grupos de avisos.
pdwTAID
lpError
Valor de retorno
TRUE
Avisos del grupo acusados
FALSE
Error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también

2.10.7 Funciones para la edición de filtros de aviso (RT Professional)
2.10.7.1 MSRTGetFilterDataPlus (RT Professional)
Descripción
Lee los criterios de selección del visor de avisos y deposita el resultado en la estructura
MSG_FILTER_STRUCT_PLUS.
Declaración
BOOL WINAPI MSRTGetFilterDataPlus(

DWORD dwServiceID,
LPCWSTR lpszName,
LPMSG_FILTER_STRUCT_PLUS** lpppMsgFilter,
LPDWORD lpdwFilterCount,
Parámetros
dwServiceID
ID del servicio
lpszName
Nombre del visor de avisos. El nombre se define en las propiedades del visor de avisos.
lpMsgFilterPlus
Puntero al puntero de filtro array a estructuras de filtro
lpdwFilterCount
lpError
Valor de retorno
TRUE
FALSE
Error

Observación
Se determinan solamente los filtros de aviso configurados. No se registran los filtros de aviso
que han sido aplicados con MSRTStartMsgServicePlus o con MSRTSetMsgFilterPlus.
Mensajes de error

MSG_ERR_API_NODATA Ningún dato
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Consulte también
2.10.7.2 MSRTCheckWinFilterPlus (RT Professional)
Descripción
Comprueba si el aviso indicado cumple con la condición de filtro.
Declaración
BOOL MSRTCheckWinFilterPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilter,
LPWORD lpwReturn,

Parámetros
dwServiceID
lpszServer
Puntero al nombre de servidor. El nombre se indica sin caracteres separadores de servidor ::.
En caso de indicar un string vacío o CERO, se utiliza el servidor predeterminado ajustado
lpMsgRTPlus
Puntero a una estructura del tipo MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS
(Página 1026) con los datos Runtime de un aviso.
lpMsgFilter
Puntero a una estructura del tipo MSG_FILTER_STRUCT_PLUS (Página 1029) con los datos
del filtro de avisos.
lpwReturn
Puntero al resultado de öa función.
TRUE Aviso cumple con las condiciones de filtro.

FALSE Aviso no cumple con las condiciones de filtro.
lpError
Valor de retorno
TRUE
Se ha realizado la comprobación.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

Consulte también
2.10.7.3 MSRTSetMsgFilterPlus (RT Professional)
Descripción
Restablece el filtro para el servicio especificado.
Declaración
BOOL WINAPI MSRTSetMsgFilterPlus(

DWORD dwServiceID,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilterPlus,
Parámetros
dwServiceID
lppMsgFilterPlus
Puntero al puntero ARRAY para condiciones de filtro
dwFilterCount
Número de filtros en el ARRAY
lpError

Valor de retorno
TRUE
FALSE
Error
Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
MSRTStartMsgServicePlus (Pági‐ Iniciar servicio

na 1051)
MSRTGetFilterDataPlus (Pági‐ Leer criterios de selección del visor de avisos
na 1096)
Consulte también
2.10.7.4 MSRTSetMsgWinFilterPlus (RT Professional)
Descripción
Define nuevas condiciones de filtro para el visor de avisos. Se actualizan todos los visores de
avisos actuales con este nombre.

Declaración
BOOL MSRTSetMsgWinFilterPlus (
LPMSG_FILTER_STRUCT_PLUS lppMsgFilterPlus,
Parámetros
lppMsgFilterPlus
Puntero a una estructura del tipo MSG_FILTER_STRUCT_PLUS (Página 1029) con los datos
del filtro de avisos. El nombre de la estructura de filtro es igual al nombre de filtro.
dwFilterCount
Número de filtros
lpError
Valor de retorno
TRUE
Se ha aplicado el filtro
FALSE
Error
Mensajes de error

Consulte también

2.10.8 Funciones para editar el visor de avisos (RT Professional)
2.10.8.1 MSRTMsgWinCommandPlus (RT Professional)
Descripción
Ejecuta una función de operador en un visor de avisos. Si utiliza esta función, utilice una
plantilla de ventana de avisos solo una vez dentro de una imagen. Los comandos se transfieren
a controles con el nombre del título (Caption) igual que el nombre de la plantilla (Template).
(Debido a la conversión de imágenes con plantillas de avisos en imágenes con controles se
crean controles con el nombre del título (Caption) iigual al nombre de la plantilla (Template).
Declaración
BOOL MSRTMsgWinCommand(
LPTSTR lpszTemplate,
DWORD dwCommandID,
Parámetros
lpszTemplate
Puntero al nombre de ventana
dwCommandID
La ID de la función de operador se determina con las constantes en el archivo "m_global.h":
MSG_TB_MSGWIN Llamar ventana de avisos de proceso

MSG_TB_ARC_S Llamar fichero circular
MSG_TB_ARC_L Llamar fichero de continuación
MSG_TB_QH Activar acuse de bocina
MSG_TB_QM Activar acuse individual
MSG_TB_QS Activar acuse de grupo
MSG_TB_SCROLL Activar y desactivar la función de desplazamiento
MSG_TB_SELECT Mostrar diálogo de selección
MSG_TB_LOCK Mostrar diálogo de bloqueo
MSG_TB_PROTOCOL Mostrar diálogo de informe
MSG_TB_RESET Activar acuse de emergencia
MSG_TB_MSGFIRST Posicionar al comienzo de la lista
(El desplazamiento automático no puede estar ac‐
tivado)
MSG_TB_MSGLAST Posicionar al final de la lista
tivado)

MSG_TB_MSGNEXT Posicionar en el siguiente aviso

tivado)
MSG_TB_MSGPREV Posicionar en el aviso anterior
tivado)
MSG_TB_INFO Mostrar el diálogo de texto informativo relativo al
aviso seleccionado
MSG_TB_COMMENT Introducir comentario sobre el aviso actualmente
seleccionado
MSG_TB_LOOPINALARM Activar Loop-In-Alarm del aviso seleccionado
MSG_TB_PRINT Iniciar impresión
lpError
Valor de retorno
TRUE
Función de operador ejecutada
FALSE
Error
Observación
Todos los visores de avisos abiertos con el nombre indicado ejecutan la función de operador.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

2.10.9 Funciones para editar comentarios (RT Professional)
2.10.9.1 MSRTGetCommentInstancePlus (RT Professional)
Descripción
Determina el texto de comentario de un aviso archivado.
Declaración
BOOL MSRTGetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
Parámetros
dwServiceID
lpmCommentPlus
Puntero a una estructura del tipo MSG_COMMENT_INSTANCE_STRUCT_PLUS
(Página 1043) con los datos de un comentario. Son necesarios los siguientes valores de la
estructura: Número de aviso, fecha y hora y nombre de instancia.
Nota
La fecha y la hora deben coincidir exactamente al milisegundo en la etiqueta de fecha y hora
del aviso para el cual se debe determinar el texto de comentario.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR W. En caso
Valor de retorno
TRUE
Texto de comentario encontrado.
Si no hay ningún comentario, la llamada se devuelve con TRUE, pero el elemento szText está
vacío.

FALSE
Error
Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Página 1043)
2.10.9.2 MSRTSetCommentInstancePlus (RT Professional)
Descripción
Determina el texto de comentario de un aviso archivado.
Declaración
Bool MSRTSetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
LPDWORD pdwTAID,

Parámetros
dwServiceID
lpmCommentPlus
Puntero a una estructura del tipo MSG_COMMENT_INSTANCE_STRUCT_PLUS
(Página 1043) con los datos de un comentario. Son necesarios los siguientes valores de la
estructura: Número de aviso, nombre de instancia, fecha, hora, texto y nombre de usuario.
pdwTAID
lpError
Valor de retorno
TRUE
Enviado con éxito al servidor.
FALSE
Error
Observación
Los datos de la función MSRTSetCommentPlus se escriben de forma asíncrona. Esto hace
que no se devuelvan todos los errores al usuario. Compruebe la notación con
MSRTGetCommentInstancePlus.
Si MSRTSetCommentInstancePlus se ejecuta después de MSRTCreateMsgPlus o
MSRTCreateMsgInstancePlus, debido al asincronismo y dependiendo del grado de carga de
la instalación pueden darse procesos de adelantamiento. Eso significa que el comentario se
define antes de que se genere el aviso.
Utilice la función MSRTCreateMsgInstanceWithCommentPlus en lugar de esta combinación
de llamada.
Mensajes de error


Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

gina 1066)
Consulte también
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Página 1043)
2.10.10 Funciones para la edición de textos de información (RT Professional)
2.10.10.1 MSRTGetInfotextPlus (RT Professional)
Descripción
Obtiene el texto de información para un aviso. Para ello deben transferirse los siguientes
valores: Número del aviso
Declaración
BOOL WINAPI MSRTGetInfotextPlus (

DWORD dwServiceID,
LPMSG_INFOTEXT_STRUCT_PLUS lpmInfotext,
Parámetros
dwServiceID
ID del servicio

lpmInfotext
Puntero de la estructura del texto de información
lpError
Valor de retorno
TRUE
FALSE
Error
Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_INFOTEXT_STRUCT_PLUS (Página 1045)
2.10.10.2 MSRTSetInfotextPlus (RT Professional)
Descripción
Establece el texto de información para un aviso.

Declaración
BOOL WINAPI MSRTSetInfotextPlus(

DWORD dwServiceID,
LPMSG_INFOTEXT_STRUCT_PLUS lpmInfotextPlus,
DWORD* lpdwTAID,
Parámetros
dwServiceID
ID del servicio
lpmInfotextPlus
Puntero de la estructura del texto de información
lpdwTAID
Puntero a la TransactionID con la respuesta para el procesamiento asíncrono.
lpError
Puntero que recoge el mensaje de error ampliado.
Valor de retorno
TRUE
FALSE
Error
Observación
El nuevo texto de información se vuelve efectivo a partir del subsiguiente cambio de minuto.
Hasta este momento se utiliza el texto de información anterior.
Mensajes de error

Archivos requeridos
CCMSRTCLIPlus.h

CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_INFOTEXT_STRUCT_PLUS (Página 1045)
2.10.11 Funciones de archivo (RT Professional)
2.10.11.1 MSRTEnumBackupListPlus (RT Professional)
Descripción
Lista las entradas del archivo de intercambio para el fichero de secuencia.
Declaración
BOOL MSRTEnumBackupListPlus (
DWORD dwServiceID,
Parámetros
dwServiceID
lpError
Valor de retorno
TRUE
Lista de intercambio creada.

FALSE
Error
Observación
Las funciones Enum trabajan asincrónicamente. A causa de ello deben sincronizarse los
accesos eventualmente son semáforos
La función callback MSG_SERVICE_NOTIFY_PROCPlus se accede con el parámetro
MSG_NOTIFY_BACKUPENUM. El parámetro lpbyData indica sobre los datos de la estructura
MSG_BACKUP_STRUCT_PLUS (Página 1046).
Mensajes de error

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

MSG_SERVICE_NOTIFY_PROCPlus (Página 1057) Función callback
Consulte también
MSG_BACKUP_STRUCT_PLUS (Página 1046)
2.10.11.2 MSRTExportPlus (RT Professional)
Descripción
Exporta avisos desde el fichero circular y los archivos de backup de archivo enlazados.

Declaración
BOOL MSRTExportPlus (
DWORD dwServiceID,
LPMSG_BACKUP_STRUCT_PLUS lpMsgBackup,
Parámetros
dwServiceID
lpMsgBackup
Puntero a una estructura del tipo MSG_BACKUP_STRUCT_PLUS (Página 1046).
lpError
Valor de retorno
TRUE
Avisos exportados.
FALSE
Error
Mensajes de error

Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll

2.11 Funciones para visualizar códigos PLC (RT Professional)
Consulte también
MSG_BACKUP_STRUCT_PLUS (Página 1046)
2.11.1 Visualización en STEP 7 (RT Professional)
2.11.1.1 Principios básicos (RT Professional)
Generalidades
Estas funciones permiten pasar directamente de una imagen en WinCC Runtime a la ubicación
de una variable de proceso en el código de programa de STEP 7. De este modo es posible
diagnosticar fallos de manera rápida y sencilla. Para acelerar las funciones de salto, existe la
posibilidad de iniciar el TIA Portal y abrir un proyecto. Esto se realiza típicamente durante el
arranque de WinCC Runtime.
En el momento del salto se comprueba en primer lugar si el TIA Portal ya está abierto. De no
ser así, se inicia automáticamente el TIA Portal. En el TIA Portal se abre el correspondiente
editor y se busca el punto de aplicación, la asignación, la llamada o el paso.
Archivos header
La declaración de las funciones y estructuras que se explican aquí se realiza en los archivos
header:
kopapi.h Definición de interfaz API: archivo header
Librerías
El vínculo a DLL de las funciones que se explican aquí se realiza en los archivos de librería
kopapi.dll.
kopapi.lib Library
kopapi.dll
Consulte también
OpenTIAPortalProject (Página 1114)
OpenTIAPortalIECPLByCall (Página 1116)
OpenTIAPortalIECPLByAssignment (Página 1118)

OpenTIAPortalS7GraphByBlock (Página 1120)

Ejemplo: Integración en una función WinCC (Página 1123)
2.11.1.2 OpenTIAPortalProject (RT Professional)
Descripción
Con esta función se puede iniciar el TIA Portal y abrir un proyecto. De este modo se aceleran
las distintas funciones de destino. Sin embargo, tenga en cuenta que los programas abiertos
en segundo plano consumen memoria y tiempo de cálculo.
Declaración
BOOL OpenTIAPortalProject (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszErrorTag,
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: En la búsqueda del nombre de pin
se busca una cadena parcial, es decir, el nombre de pin empieza con la cadena de
caracteres enviada en lpszPin. Si este bit no está activado, se compara el nombre de pin
completo con lpszPin.
● KOPAPI_FLAG_TIAPORTAL_SUPPRESS_PROGRAM_STATUS=0x0004: después de
abrirse el bloque, el TIA Portal no pasa al modo online. Si este bit no está activado, después
de abrirse el bloque se inicia el modo online.

● KOPAPI_FLAG_TIAPORTAL_CHECK_PROJECT_STATE 0x0010L: si este bit está

activado, se comprueba el estado del proyecto. El proyecto no se abre.
– El proyecto está abierto.
Valor de retorno FALSE
error.dwError1 = KOPAPI_E_TIAPORTAL_PROJECT_NOT_OPEN
– El proyecto está abierto y no contiene cambios.
Valor de retorno TRUE
error.dwError1 = 0
– El proyecto está abierto y contiene cambios.
error.dwError1 = KOPAPI_E_TIAPORTAL_PROJECT_MODIFIED
– El proyecto se ha abierto en modo de solo lectura.
error.dwError1 = KOPAPI_E_TIAPORTAL_PROJECT_READ_ONLY
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x0008L: si este bit
está activado, se cancela la llamada si el proyecto ya está abierto y contiene cambios.
lpszTiaPortalProjectPath
Nombre del archivo de proyecto, incluida la ruta absoluta, p. ej., "D:\TIAProjects
\Project1\Project1.ap12"
Tenga en cuenta que dentro de un C script es obligatorio escribir la barra invertida con una
secuencia de escape:
FunctionX(…, "D:\\TIAProjects\\Project1\\Project1.ap12", …);
lpszErrorTag
Nombre de una variable WinCC interna del tipo de datos String. Al llamar funciones asíncronas
que no devuelven un resultado inmediatamente, se devuelve la información de error en
lpszErrorTag (Página 1136).
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Archivos requeridos
kopapi.h
kopapi.lib

kopapi.dll
Consulte también
Principios básicos (Página 1113)
2.11.1.3 OpenTIAPortalIECPLByCall (RT Professional)
Descripción
Esta función se utiliza para los lenguajes KOP y FUP y muestra la preconexión de una entrada
de red de un bloque estándar.
Declaración
BOOL OpenTIAPortalIECPLByCall (
DWORD dwFlags,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
Parámetros
dwFlags
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: En la búsqueda del nombre de pin
de abrirse el bloque se inicia el modo online

lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszContainingBlock
Nombre del bloque que se abrirá y visualizará o nombre de la instancia de un FB.
Pueden usarse como nombre:
● El nombre de un DB de instancia individual. En ese caso se mostrará su FB. Ejemplo
"Station1"
● El nombre de una multiinstancia en un DB de instancia. En ese caso se mostrará su FB.
Al indicar la ruta del nombre de la multiinstancia, se trata de la jerarquía de datos que se
muestra, p. ej., en el editor DB, y no de la Call Structure. La primera parte del nombre
("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de un
símbolo global. Las comillas son necesarias para los distintos componentes del nombre
en los que aparezcan caracteres especiales como espacios en blanco, puntos u otros.
Ejemplo: "Line1.Cell1.Station1"
● El nombre de un FC u OB
No se permite usar el nombre de un FB.
lpszCalledBlock
Nombre de la instancia local o global que se llama en el bloque de código correspondiente a
lpszContainingBlock.
● En las instancias locales debe agregarse aquí el carácter almohadilla (#), p. ej., "#feeder1".
● En los DB de instancia global debe especificarse el nombre global sin #, p. ej., "feeder3".
Se permite usar el nombre de un FC.
Si se llama varias veces lpszCalledBlock dentro de lpszContainingBlock o de su FB, se salta
siempre a la primera llamada de lpszCalledBlock.
Con lpszCalledBlock=NULL, lpszContainingBlock solo se abre y se muestra en el estado, pero
no se busca una determinada llamada de bloque ni un determinado segmento. En este caso
se omite lpszPin.
lpszPin
El nombre de un pin de entrada de lpszCalledBlock. Este parámetro sirve para que en el editor
se muestre de manera visible el pin especificado dentro de un segmento.
Con lpszPin=NULL solo se muestra de manera visible lpszCalledBlock.
lpszErrorTag

lpdmError
Valor de retorno
TRUE
FALSE
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también
2.11.1.4 OpenTIAPortalIECPLByAssignment (RT Professional)
Descripción
Esta función se utiliza para los lenguajes KOP y FUP y muestra la asignación a un operando
y su preconexión.
Declaración
BOOL OpenTIAPortalIECPLByAssignment (
DWORD dwFlags,
LPCTSTR lpszOperand,

Parámetros
dwFlags
lpszCpuName
lpszContainingBlock
"Station1"
lpszOperand
Nombre de un operando local o global al que se hace referencia.
● En los operandos locales debe agregarse aquí el carácter almohadilla (#).
● En los operandos globales debe especificarse el nombre global sin #.
Si se escribe varias veces lpszOperand dentro de lpszContainingBlock o de su FB, se salta
siempre al primer acceso de escritura de lpszOperand.

lpszErrorTag
lpdmError
Valor de retorno
TRUE
FALSE
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también
2.11.1.5 OpenTIAPortalS7GraphByBlock (RT Professional)
Descripción
La función se utiliza para los lenguajes S7 Graph y muestra un paso en una cadena secuencial.
Declaración
BOOL OpenTIAPortalS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszBlock,
DWORD dwStepNumber,

Parámetros
dwFlags
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x00000008L: Si este
bit está activado, se cancela la llamada si el proyecto ya está abierto y contiene cambios.
lpszCpuName
lpszBlock
Nombre de instancia del bloque S7-Graph que se desea mostrar.
dwStepNumber
Número del paso que se desea mostrar
Con dwStepNumber=0 se busca automáticamente el paso activo y se activa el modo "Track
active step".
lpszErrorTag
lpdmError
Valor de retorno
TRUE
FALSE

Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también

2.11.1.6 Ejemplo: Integración en una función WinCC (RT Professional)
Descripción
El ejemplo muestra la integración de las llamadas a función en una función definida por el
usuario. Para un mantenimiento más fácil, es recomendable transferir la llamada a una función
Global Script en la que también se definirán la ruta al TIA Portal y el nombre de la estación
PLC.
void OnClick(char* screenName, char* objectName, char* propertyName)

{
// Funktionen bekannt machen'
#pragma code("KOPAPI.dll")
#include "KOPAPI.h"
#pragma code()
BOOL useTiaPortal = TRUE; // use the TIA Portal or the viewer control?
char* pTiaPortalProject = "c:\\Projects\\myproject\\myproject.ap12";
char* pStationName = "OW063IZ1M01_PLC2_STD"; // TODO: read from internal
tag
char* pContainingBlock = "SG01_FG02_ST001+FX001_IDB"; // TODO: get from
current selection
char* pOperand = "#HOME_SEQ1.HOME_MISC[8]"; // TODO: get from current
selection
char* pErrorTag = "IECPLViewerErrorTag"; // TODO: define an own tag
CMN_ERROR error;
BOOL result;
if(useTiaPortal)
{
result = OpenTIAPortalIECPLByAssignment(0, pTiaPortalProject,
pStationName, pContainingBlock, pOperand, pErrorTag, &error);
}
else
{
char *pServerPrefix = NULL, *pTagPrefix = NULL, *pWindowPrefix =
NULL;
// determine ServerPrefix of the current environment
GetServerTagPrefix(&pServerPrefix, &pTagPrefix, &pWindowPrefix);
// make the screen which contains the viewer control visible
SetVisible("SYSTEM#Basic_Screen", "Screen_window_IECPLViewer",
TRUE);
result = OpenViewerIECPLByAssignment(0, pServerPrefix,
"SYSTEM#IECPLViewer", "IECPLViewerObject", pStationName, pContainingBlock,
pOperand, pErrorTag, &error);
}
}
Consulte también

2.11.2 Visualización en el visor de código PLC (RT Professional)
2.11.2.1 Principios básicos (RT Professional)
Generalidades
Estas funciones permiten representar el estado actual de los programas de PLC en un visor
de código PLC.
La imagen que contiene el visor de código PLC debe abrirse, p. ej., con OpenPicture() o
SetPictureName().
Archivos header
La declaración de las funciones y estructuras que se explican aquí se realiza en los archivos
header:
kopapi.h Definición de interfaz API: archivo header
Librerías
El vínculo a DLL de las funciones que se explican aquí se realiza en los archivos de librería:
pdecscli.dll
kopapi.lib Library
kopapi.dll
Notas sobre la indicación de nombres de multiinstancia

muestra, p. ej., en el editor DB, y no de la Call Structure. La primera parte del nombre ("Line1")
no debe ir entre comillas, ya que del contexto se deduce que se trata de un símbolo global.
Las comillas son necesarias para los distintos componentes del nombre en los que aparezcan
caracteres especiales como espacios en blanco, puntos u otros. Ejemplo:
"Line1.Cell1.Station1". Los nombres que no tienen caracteres especiales no deben ir entre
comillas.
Consulte también
OpenViewerIECPLByCall (Página 1127)
OpenViewerIECPLByAssignment (Página 1134)
OpenViewerS7GraphByBlock (Página 1125)

2.11.2.2 OpenViewerS7GraphByBlock (RT Professional)
Descripción
La función muestra una etapa de una cadena secuencial en el lenguaje de PLC S7 Graph en
el visor de código PLC.
Declaración
BOOL OpenViewerS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
Parámetros
dwFlags
lpszServerPrefix
lpszPictureName
Nombre de la imagen con el visor de código PLC.
lpszObjectName
Nombre del visor de código PLC.
lpszCpuName
lpszBlock
Nombre de instancia del bloque S7-Graph que se desea mostrar. Si el nombre contiene
caracteres especiales tales como espacios, puntos etc., deben utilizarse comillas.
dwStepNumber
Número del paso que se desea mostrar.
Con dwStepNumber=0 se busca automáticamente el paso activo y se activa el modo "Track
active step".

lpdmError
Valor de retorno
TRUE
FALSE
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll

Ejemplo
El ejemplo muestra la integración de la llamada a función en una función C definida por el
Global Script en la que también se definirá el nombre de la estación PLC.
BOOL OpenCodeViewerByS7Graph(char* screenName, char* objectName, char*

cpuName, char* instanceDBName)
{
#pragma code("kopapi.dll")
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
char* serverPrefix = "";
DWORD dwFlags = 0;
DWORD stepNumber = 0;
result = OpenViewerS7GraphByBlock(dwFlags, serverPrefix, screenName,
objectName,
cpuName, instanceDBName, stepNumber, &error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByAssignment
will // fail, in most cases the viewer control could not be found
// most of the errors have to be handled in the OnError event of the viewer
printf("OpenViewerS7GraphByBlock failed: err1=%ld, err2=%ld, err3=%ld,
err4=%ld, err5=%ld, text=\"%s\"\r\n", result, error.dwError1,
error.dwError2, error.dwError3, error.dwError4, error.dwError5,
error.szErrorText);
}
return result;
}
Consulte también
Tratamiento de errores (Página 1136)
2.11.2.3 OpenViewerIECPLByCall (RT Professional)
Descripción
La función muestra la preconexión de una entrada de un segmento de un bloque estándar en
los lenguajes de PLC KOP y FUP en el visor de código PLC.

Nota
Si la entrada está ocupada con una constante (TRUE, FALSE), este valor no se muestra en
el visor de código PLC. Para mostrar el valor correctamente en el visor de código PLC, debe
ocupar la entrada con una variable que tenga el valor correspondiente.
Declaración
BOOL OpenViewerIECPLByCall (
DWORD dwFlags,
LPCTSTR lpszPin,
Parámetros
dwFlags
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: en la búsqueda del nombre de pin
lpszServerPrefix
lpszPictureName
lpszObjectName
lpszCpuName

lpszContainingBlock
"Station1"
La especificación de la ruta del nombre de la multiinstancia está sujeta a una jerarquía de
datos que se muestra, p. ej., en el editor DB, y no a la Call Structure. La primera parte del
nombre ("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de
un símbolo global. Las comillas son necesarias para los distintos componentes del nombre
lpszCalledBlock
lpszPin
El nombre de un pin de entrada de lpszCalledBlock. Este parámetro sirve para que en el visor
de código PLC se muestre el segmento que está conectado con el pin de entrada.
lpdmError
Valor de retorno
TRUE
FALSE
Archivos requeridos
kopapi.h
kopapi.lib

kopapi.dll
Ejemplo
BOOL OpenCodeViewerByCall(BOOL matchSubstringPin, char* screenName, char*

objectName, char* cpuName, char* containingBlock, char* calledBlock, char*
pinName)
{
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
DWORD dwFlags = 0;
if(matchSubstringPin)
dwFlags |= KOPAPI_FLAG_TIAPORTAL_PIN_SUBSTRING_SEARCH;
result = OpenViewerIECPLByCall(dwFlags, serverPrefix, screenName,
objectName,
cpuName, containingBlock, calledBlock, pinName, &error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByCall will
fail, in // most cases the viewer control could not be found
printf("OpenViewerIECPLByCall failed: err1=%ld, err2=%ld, err3=%ld, err4=
%ld, err5=%ld, text=\"%s\"\r\n", result, error.dwError1,
error.szErrorText);
}
return result;
}
Consulte también

2.11.2.4 OpenViewerIECPLByFCCall (RT Professional)
Descripción
La función muestra en los lenguajes de PLC KOP y FUP, la preconexión de una entrada de
segmento de un bloque estándar en el visor de código PLC considerando la instancia UDT.
Nota
Si la entrada está ocupada con una constante (TRUE, FALSE), este valor no se muestra en
el visor de código PLC. Para mostrar el valor correctamente en el visor de código PLC, debe
ocupar la entrada con una variable que tenga el valor correspondiente.
Declaración
BOOL OpenViewerIECPLByFCCall (
DWORD dwFlags,
LPCTSTR lpszPin,
LPCTSTR lpszUdtInstance
Parámetros
dwFlags
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: en la búsqueda del nombre de pin
lpszServerPrefix
El parámetro se reserva para futuras ampliaciones y debe consistir en una cadena vacía ("").
lpszPictureName
lpszObjectName

lpszCpuName
lpszContainingBlock
"Station1"
La especificación de la ruta del nombre de la multiinstancia está sujeta a una jerarquía de
datos que se muestra, p. ej., en el editor DB, y no a la Call Structure. La primera parte del
nombre ("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de
un símbolo global. Las comillas son necesarias para los distintos componentes del nombre
lpszCalledBlock
lpszPin
El nombre de un pin de entrada de lpszCalledBlock. Este parámetro sirve para que en el visor
de código PLC se muestre el segmento que está conectado con el pin de entrada.
lpszUdtInstance
El parámetro permite limitar la visualización de FB o FC llamados varias veces. La limitación
se efectúa por medio de la instancia UDT interconectada con un pin de entrada o pin de
entrada y salida cualquiera.
lpdmError

Valor de retorno
TRUE
FALSE
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Ejemplo
BOOL OpenCodeViewerByFCCall(BOOL matchSubstringPin, char* screenName,

char* objectName, char* cpuName, char* containingBlock, char* calledBlock,
char* pinName, char* udtInstance)
{
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
DWORD dwFlags = 0;
if(matchSubstringPin)
dwFlags |= KOPAPI_FLAG_TIAPORTAL_PIN_SUBSTRING_SEARCH;
result = OpenViewerIECPLByFCCall(dwFlags, serverPrefix, screenName,
objectName, cpuName, containingBlock, calledBlock, pinName, udtInstance,
&error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByFCCall will
fail,
// in most cases the viewer control could not be found
control
printf("OpenViewerIECPLByFCCall failed: err1=%ld, err2=%ld, "" err3=%ld,
error.szErrorText);
}
return result;
}

2.11.2.5 OpenViewerIECPLByAssignment (RT Professional)
Descripción
La función muestra, en los lenguajes de PLC KOP y FUP, la asignación a un operando y su
preconexión en el visor de código PLC.
Declaración
BOOL OpenViewerIECPLByAssignment (
DWORD dwFlags,
LPCTSTR lpszOperand,
Parámetros
dwFlags
lpszServerPrefix
lpszPictureName
lpszObjectName
lpszCpuName
lpszContainingBlock

Como nombre puede usarse:

"Station1"
lpszOperand
Nombre de un operando local o global al que se hace referencia.
● En los operandos locales debe agregarse aquí el carácter almohadilla (#).
● En los operandos globales debe especificarse el nombre global sin #.
Si se escribe varias veces lpszOperand dentro de lpszContainingBlock o de su FB, se salta
siempre al primer acceso de escritura de lpszOperand.
lpdmError
Valor de retorno
TRUE
FALSE
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll

Ejemplo
BOOL OpenCodeViewerByAssignment(char* screenName, char* objectName, char*

cpuName, char* containingBlock, char* operand)
{
#include "kopapi.h"
#pragma code()
BOOL result;
CMN_ERROR error;
DWORD dwFlags = 0;
result = OpenViewerIECPLByAssignment(dwFlags, serverPrefix, screenName,
objectName, cpuName, containingBlock, operand, &error);
if(!result)
{
// there are only few reasons why the call to OpenViewerIECPLByAssignment
will
// fail, in most cases the viewer control could not be found
printf("OpenViewerIECPLByAssignment failed: err1=%ld, err2=%ld, err3=%ld,
error.szErrorText);
}
return result;
}
Consulte también
2.11.3 Tratamiento de errores (RT Professional)
Generalidades
El procesamiento de las funciones para el salto de red se divide entre una parte síncrona y
una parte asíncrona. La parte síncrona comprueba los parámetros y los transfiere a la parte
asíncrona.
El valor de retorno de las funciones indica si en la parte síncrona de la función se ha producido
un error. En caso de error, el valor de retorno es FALSE. Este tipo de errores se producen
cuando no se envían datos (o se envían datos erróneos) a los parámetros, p. ej., el parámetro
lpszErrorTag.

Los errores que se producen en la parte asíncrona de las funciones se devuelven con el
parámetro lpszErrorTag. Este tipo de errores pueden ser, p. ej.: proyecto no encontrado,
bloque no disponible... lpszErrorTag contiene el nombre de una variable del tipo de datos
String. Para poder responder al valor de retorno, debe configurarse una función que se dispare
con el ciclo "Por cambio" al cambiar el valor de la variable de error. La variable de error también
debe utilizarse para impedir otras llamadas a funciones o la activación de un botón, p. ej.,
mientras la variable de error tenga el valor "RUNNING".
lpszErrorTag
Nombre de una variable del tipo de datos String. Si la variable no es necesaria, puede
transferirse NULL como parámetro. En caso necesario, el nombre de la variable puede incluir
un prefijo de servidor.
El valor de las variables de error se modifica del siguiente modo:
● Cuando se inicia la parte asíncrona, se ajusta el valor de la variable de error a "RUNNING".
● Si la parte asíncrona finaliza sin errores, se ajusta el valor de la variable de error a "OK".
● Si la parte asíncrona finaliza con error, la variable de error contiene una cadena de varias
líneas separadas por caracteres de salto de línea ('\n').
En caso de error, la variable de error presenta la siguiente estructura:
● Línea 1: "ERROR"
● Línea 2 - línea 6: números decimales, tipo de datos: 32 bits sin signo; DWORD
● Línea 7: texto de error
Texto de error
Si la parte asíncrona finaliza con error, la variable de error contiene una cadena de varias
líneas separadas por caracteres de salto de línea ('\n'). La séptima línea contiene uno de los
siguientes textos de error:
IDS_E_IS_TIA_PROJECT KOPAPI: esta función no puede utilizarse

en un proyecto del TIA Portal.
IDS_E_NO_TIA_PROJECT KOPAPI: la llamada de función está blo‐
queada, ya que no hay abierto ningún pro‐
yecto del TIA Portal.
IDS_E_TIAPORTAL_UNKNOWN_FLAGS dwFlags contiene un valor indefinido.
IDS_E_TIAPORTAL_ERRORTAG_NOT_EXIST La variable de error [%s] no existe.
IDS_E_TIAPORTAL_PREVIOUS_CALL_IS_RUNNING La anterior llamada aún se está ejecutando
(RUNNING). Finalícela primero.
IDS_E_TIAPORTAL_CANNOT_WRITE_ERRORTAG La variable de error [%s] no puede escribir‐
se.
IDS_E_TIAPORTAL_COMACCESS_REGIS‐ La conexión con el TIA Portal no es posible.
TERPS_FAILED
IDS_E_TIAPORTAL_CANNOT_START_PORTAL El TIA Portal no puede iniciarse.

2.12 Tratamiento de errores (RT Professional)
IDS_E_TIAPORTAL_CANNOT_SEARCH_STAR‐ No puede buscarse ningún portal iniciado.

TED_PORTAL
IDS_E_TIAPORTAL_NO_PORTAL_STARTED No se ha podido iniciar ningún portal.
IDS_E_TIAPORTAL_EXCEPTION_SYNC_PART Excepción en elemento de procesamiento
síncrono.
IDS_E_TIAPORTAL_EXCEPTION_ASYNC_PART Excepción en elemento de procesamiento
asíncrono.
IDS_E_TIAPORTAL_NOT_INSTALLED No se ha instalado ningún TIA Portal.
IDS_E_TIAPORTAL_PROJECT_CANNOT_OPEN No puede abrirse el proyecto [%s].
IDS_E_TIAPORTAL_ALREADY_OPENED_WITH_OT‐ El TIA Portal está abierto con otro proyecto.
HER_PROJECT
IDS_E_TIAPORTAL_CREATECOMMAND Error CreateCommand.
IDS_E_TIAPORTAL_COMMAND_ADDARGUMENT Error Command AddArgument.
IDS_E_TIAPORTAL_EXECUTECOMMAND Error grave en ExecuteCommand.
IDS_E_TIAPORTAL_COMMAND_ERROR Error en comando de proyecto TIA: [%s,
%ld].
IDS_E_TIAPORTAL_COMMAND_UNKNOWN Comando desconocido de proyecto TIA:
[%s,%ld].
2.12.1 CMN_ERROR (RT Professional)
Descripción
La estructura de error avanzada CMN_Error contiene el código de error y un texto sobre el
error ocurrido. Cada aplicación puede utilizar la estructura de error para la evaluación o para
la emisión de mensajes de error.
Declaración
Typedef struct {
DWORD dwError1;
DWORD dwError2;
DWORD dwError3;
DWORD dwError4;
DWORD dwError5;
Char szErrorText[512];
}
CMN_ERROR;

Members
dwError1 .. dwError5
Las descripciones API contienen en cada caso la información acerca de qué valores contienen
las entradas en caso de error. Si no se indica lo contrario, los códigos de error se encuentran
en dwError1.
szErrorText
Búfer para la descripción textual de la causa del error. El contenido se determina a partir de
los recursos y suele depender del idioma.
Observación
Dependiendo de la necesidad, algunos módulos utilizan las siguientes asignaciones de los
códigos de error
dwError1 Código de error API

dwError2 Código de error subordinado (p. ej. CCStorageError.h)
dwError3 Número de líneas del código fuente
dwError4 Índice de matriz 1; fila; registro / estado / ....
dwError5 Índice de matriz 2; fila; registro elemento / contador / ....
Consulte también
Mensajes de error (Página 206)
2.12.2 CCStorageError.h (RT Professional)
Mensajes de error subordinados CCStorageError.h

Además de los mensajes de error en sí en dwError1 y dwError2, las funciones API pueden
devolver los siguientes mensajes de error en la estructura de error CMN_ERROR, siempre
que exista en el módulo correspondiente.
Mensaje de error Valor

CCF_STORAGE_PM_E_NO_PRO‐ 0x80046101L Cannot open WinCC project
JECT_OPEN
CCF_STORAGE_PM_E_NO_PRO‐ 0x80046102L Cannot open/create WinCC pro‐
JECT_OPEN_1 ject - Project Manager can't start
basis application SDIAGRT
basis application PASSDBRT
basis application SCRIPT


basis application XREF
JECT_OPEN_4 ject - Project Manager can't ini‐
tialize ASO
JECT_OPEN_5 ject - Project Manager can open
only one WinCC Project at the
same time
JECT_OPEN_6 ject - Project Manager can't con‐
figure startline for the data source
JECT_OPEN_7 ject - Project Manager can't con‐
figure data source
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004610AL Cannot open WinCC project -

JECT_OPEN_8 Project Manager for configured
WinCC Server is not already run‐
ning - Start Project Manager for
configured server
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004610BL Cannot open/create WinCC pro‐
JECT_OPEN_9 ject - Project Manager can't crea‐
te Distributed Configuration File
- Project.dcf
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004610CL Cannot open WinCC project -
JECT_OPEN_10 Project path not valid
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004610DL Cannot close WinCC project -
JECT_CLOSE_1 Some users in the network are
already connected to this WinCC
Project
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004610EL Cannot close WinCC project -
JECT_CLOSE_2 Project Manager don't known
somthing about this WinCC Pro‐
ject - please check your Project
ID
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004610FL Cannot close WinCC project - An
JECT_CLOSE_3 active WinCC project is already
running on this computer
CCF_STORAGE_PM_E_NO_PRO‐ 0x80046110L Cannot close WinCC project -
JECT_CLOSE_4 Project Manager don't support
actuall close project mode
CCF_STORAGE_PM_E_NO_PRO‐ 0x80046111L Cannot close WinCC project -
JECT_CLOSE_5 Some users already connected
to this WinCC Project - TimeOut!
CCF_STORAGE_PM_E_NO_PRO‐ 0x80046112L Project don't support desired lan‐
JECT_LANGUAGE_1 guage!
CCF_STORAGE_PM_E_NO_ACTIVATE 0x80046113L No active WinCC project is run‐
ning on this computer


CCF_STORAGE_PM_E_NO_ACTIVATE_1 0x80046114L Cannot actived WinCC project -
WinCC Server properties are
changed - close and reopen the
WinCC Project please!
CCF_STORAGE_PM_E_NO_PRO‐ 0x80046115L Cannot create WinCC project
JECT_CREATE
CCF_STORAGE_PM_E_NO_PRO‐ 0x80046116L Cannot open WinCC project -
JECT_OPEN_11 Close WinCC project is already
in process.
JECT_OPEN_12 WinCC project path exceed the
maximum value of 255 charac‐
ters.
JECT_OPEN_13 WinCC project name exceed the
maximum value of 64 characters.
CCF_STORAGE_PM_E_NO_ACTIVATE_2 0x80046119L Cannot deactivate WinCC pro‐
ject - Time-out interval elapsed -
> SCRIPT.EXE
CCF_STORAGE_PM_E_NO_ACTIVATE_3 0x8004611AL Cannot deactivate WinCC pro‐
> PASSDBRT.EXE
CCF_STORAGE_PM_E_NO_ACTIVATE_4 0x8004611BL Cannot deactivate WinCC pro‐
> SDIAGRT.EXE
CCF_STORAGE_PM_E_NO_PRO‐ 0x8004611CL Cannot open WinCC project - No
JECT_OPEN_14 project path can be insert into si‐
matic.cfg file
CCF_STORAGE_PM_E_NO_ACTIVATE_5 0x8004611DL Cannot activate WinCC project -
No WinCC project !!
CCF_STORAGE_PM_E_NO_ACTIVATE_6 0x8004611EL Cannot activate WinCC project -
WinCC client can't get the ser‐
ver's activation state over an
broadcast
CCF_STORAGE_PM_E_NO_ACTIVATE_7 0x8004611FL Activate for WinCC project in pro‐
cess - WinCC client's activation
process not already finished
CCF_STORAGE_PM_E_CREATE_SHA‐ 0x80046120L Cannot create the WinCC-Pro‐
RE_FAILED ject-Share - WinCC-Project can‐
not be opened.
CCF_STORAGE_PM_E_OPEN_FILE_FAI‐ 0x80046121L Cannot open the WinCC-Project-
LED file - WinCC-Project cannot be
opened.
CCF_STORAGE_PM_E_CLIENT_CAN‐ 0x80046122L This client cannot activate this
NOT_ACTIVATE project,because it is not in the
client list.
CCF_STORAGE_PM_E_SYBASE_MIGRA‐ 0x80046123L This WinCC version doesn't sup‐
TION port old Sybase projects. Use mi‐
gration.


CCF_STORAGE_PM_E_NO_PRO‐ 0x80046124L There is no project opened at the
JECT_OPENED moment.
CCF_STORAGE_PM_E_COMPU‐ 0x80046125L This client is not in the machine
TER_NOT_IN_MACHINE_LIST list of the specified server.
CCF_SQL_SERVER_NOT_INSTA‐ 0x80046126L The SQL server may not be co‐
LLED_ERROR rrect installed. Please check it.
CCF_SQL_SERVER_DATABASE_AC‐ 0x80046127L The SQL server cannot access
CESS_ERROR database. Please check access
rights.
CCF_PM_E_PROJECT_IS_LOCKED 0x80046128L The Project is locked.
CCF_SQL_SERVER_DATABA‐ 0x80046129L The SQL-SERVER 2005 does
SE_NTFS_ERROR not support compressed NTFS
volumes. Please uncompress at
least the project directory and its
contents.
CCF_PM_OPEN_ERROR_RDP 0xC004612AL This project is generated by RDP
and is not allowed to be opened
by WinCC
CCF_PM_OPEN_CODEPAGE_MIS‐ 0x4004612BL The current codepage does not
MATCH match the codepage at creation
time
CCF_PM_MIGRATION_NEEDED 0x8004612CL
CCF_STORAGE_DBASO_E_NO_LICEN‐ 0x80046201L No License for the Functionality
SE
CCF_STORAGE_DBASO_E_LIMIT 0x80046202L The limit is reached
CCF_STORAGE_DBASO_E_DATA_VER‐ 0x80046203L ASO can not work with this data
SION version
CCF_STORAGE_DBASO_E_NO_CON‐ 0x80046204L no connection to database
NECTION
CCF_STORAGE_DBASO_E_NO_TABLE 0x80046205L Table doesn´t exist or could not
be opened. Please check the
user rights.
CCF_STORAGE_DBASO_E_NO_RE‐ 0x80046206L no record
CORD
CCF_STORAGE_DBASO_E_NO_RE‐ 0x80046207L no resource
SOURCE
CCF_STORAGE_DBASO_E_NOT_CREA‐ 0x80046208L record not created
TED
CCF_STORAGE_DBASO_E_NOT_DELE‐ 0x80046209L record not deleted
TED
CCF_STORAGE_DBASO_E_NOT_MODI‐ 0x8004620AL record not modified
FIED
CCF_STORAGE_DBASO_E_RE‐ 0x8004620BL record already exists.
CORD_EXIST
CCF_STORAGE_DBASO_E_RE‐ 0x8004620CL record in use
CORD_IN_USE
CCF_STORAGE_DBASO_E_RE‐ 0x8004620DL Invalid Count or Type of Fields
CORD_FIELDSINVALID


CCF_STORAGE_DBASO_E_RE‐ 0x8004620EL Record can not be modified or
CORD_PROTECTED removed.
CCF_STORAGE_DBASO_E_NO_CON‐ 0x8004620FL No or invalid Project Context
TEXT ASO cannot work correct
CCF_STORAGE_DBA‐ 0x80046210L no entries found for enumeration
SO_E_ENUM_NOENTRIES
CCF_STORAGE_DBASO_E_NOT_FOUND 0x80046211L specified object can not be found
CCF_STORAGE_DBASO_E_ID_CHAN‐ 0x80046212L It is not allowed to change IDs.
GES_NOT_POSSIBLE
CCF_STORAGE_DBASO_E_PARAME‐ 0x80046213L The parameter is too long.
TER_TOO_LONG
CCF_STORAGE_DBASO_E_DA‐ 0x80046214L Can't read data. Data from older
TA_TOO_OLD WinCC version.
CCF_STORAGE_DBASO_E_DATA_NE‐ 0x80046215L Data newer than software. Plea‐
WER_THAN_SOFTWARE se grade up.
CCF_STORAGE_DBASO_E_ENUM‐ 0x80046216L Enum sink returned with error.
SINK_RETURNED_WITH_ERROR
CCF_STORAGE_DBASO_E_DA‐ 0x80046217L Primary key is referenced in ano‐
TA_EXIST_IN_REFERENCED_TABLE ther table.
CCF_STORAGE_DBASO_E_DA‐ 0x80046218L Value out of Range.
TA_OUT_OF_RANGE
CCF_STORAGE_DM_ASO_BULK_FAILED 0x80046219L Bulk operation failed.
CCF_STORAGE_DBASO_E_RT_LI‐ 0x8004621AL The runtime limit is reached
MIT_WARNING
CCF_STORAGE_DBASO_E_BAD_LOCA‐ 0x8004621BL
LE_ID
CCF_STORAGE_FILEASO_E_NO_PICTU‐ 0x80046301L no picture available
RE
CCF_STORAGE_GDO_BADTYPE_IN_VA‐ 0x80046405L wrong type in vt
RIANT
CCF_STORAGE_GDO_DATAINCONSIS‐ 0x80046406L data inconsistent
TENT some part of the data is not valid
or out of range
CCF_STORAGE_GDO_UNITID_INVALID 0x80046407L data inconsistent
channel unit ID is invalid
CCF_STORAGE_GDO_USERTYPE_INVA‐ 0x80046408L data inconsistent
LID usertype is invalid
CCF_STORAGE_GDO_ADDRESS‐ 0x80046409L data inconsistent
BUILD_FAILURE failure in building address for va‐
riable
CCF_STORAGE_GDO_MODIFY_NO‐ 0x8004640AL data inconsistent
CHANGE no relevant modifications are ma‐
de
CCF_STORAGE_GDO_CHANNELWRAP‐ 0x8004640BL CCMfcChannelWrapper.DLL
PER_LOAD can not be found
CCF_STORAGE_GDO_CHANNEL_LOAD 0x8004640CL Channel Load failure
Channel can not be found


CCF_STORAGE_GDO_CHANNEL_FUNC 0x8004640DL Channel Entry Points not found
CCF_STORAGE_GDO_CHAN‐ 0x8004640EL Invalid Unit Number
NEL_UNITNR
CCF_STORAGE_GDO_CONNECTION 0x8004640FL Invalid Connection or Connec‐
tion not found
CCF_STORAGE_GDO_TAGGROUP 0x80046410L Invalid TagGroup or TagGroup
not found
CCF_STORAGE_GDO_NAMENOTFOUND 0x80046411L Specified name not found
CCF_STORAGE_GDO_TAGOFUSERTY‐ 0x80046412L The object UserType could not
PEEXISTS be removed
CCF_STORAGE_GDO_PROJECTISACTI‐ 0x80046413L The project is activated. No chan‐
VE ges or removes allowed.
CCF_STORAGE_GDO_UNIT 0x80046414L Invalid channel unit or channel
unit not found
CCF_STORAGE_GDO_MINMAX_LIMIT 0x80046415L Min Max Limit violation
CCF_STORAGE_GDO_PRO‐ 0x80046416L This Operation is not allowed
JECT_IN_RUNTIME while project is in runtime.
CCF_STORAGE_GDO_BAD_POINTER 0x80046600L NULL pointer for get property not
allowed.
CCF_STORAGE_GDO_UNEXPECTED 0x80046601L Unexpected error.
CCF_STORAGE_GDO_NO_RECORD 0x80046602L No record.
CCF_STORAGE_GDO_OPERA‐ 0x80046603L Current operation not commited.
TION_NOT_COMITTED
CCF_STORAGE_GDO_NO_PRO‐ 0x80046604L No project connector.
JECT_CONNECTOR
CCF_STORAGE_GDO_PRO‐ 0x80046605L Project no opened.
JECT_NOT_OPENED
CCF_STORAGE_GDO_GET_ASO_FAI‐ 0x80046606L Get Aso failed.
LED
CCF_STORAGE_GDO_BAD_TYPEID 0x80046607L Bad Type ID.
CCF_STORAGE_GDO_OT‐ 0x80046608L Other type not commited.
HER_TYPE_NOT_COMMITED
CCF_STORAGE_GDO_CACHE_READ 0x80046609L Error in cache read.
CCF_STORAGE_GDO_CACHE_WRITE 0x8004660AL Error in cache write.
CCF_STORAGE_GDO_DM_GDO_ERROR 0x8004660BL Error in DM Gdo.
CCF_STORA‐ 0x8004660CL Error in Text Gdo.
GE_GDO_TEXT_GDO_ERROR
CCF_STORAGE_GDO_ENUMERA‐ 0x8004660DL Creation of an ASO enumerator
TOR_CREATION failed.
CCF_STORAGE_GDO_ENUMDATA_FAI‐ 0x8004660EL Call to ICCTxtAsoEnum::Enum‐
LED Data() failed.
CCF_STORAGE_GDO_ENUM‐ 0x8004660FL Creation of an enumeration sink
SINK_CREATION object failed.
CCF_STORAGE_GDO_WRONG_INTER‐ 0x80046610L Pointer to wrong interface pas‐
FACE sed.
CCF_STORAGE_GDO_BAD_LOCALE_ID 0x80046611L Locale ID not found in map.
CCF_STORAGE_GDO_CREATE_OBJECT 0x80046612L CreateObject failed.


CCF_STORAGE_GDO_MODIFY_OBJECT 0x80046613L ModifyObject failed.
CCF_STORAGE_GDO_READ_OBJECT 0x80046614L ReadObject failed.
CCF_STORAGE_GDO_NOT_IMPLEMEN‐ 0x80046615L Not implemented.
TED
CCF_STORAGE_GDO_REMOVE_OB‐ 0x80046616L RemoveObject failed.
JECT
CCF_STORAGE_GDO_REMOVE_ALL 0x80046617L RemoveAll failed.
CCF_STORAGE_GDO_ENUM_OBJECTS 0x80046618L EnumObjects failed.
CCF_STORAGE_GDO_GET_OB‐ 0x80046619L GetObjectCount failed.
JECT_COUNT
CCF_STORAGE_GDO_GET_RW_INTER‐ 0x8004661AL GetRWInterface from Aso failed.
FACE_FROM_ASO
CCF_STORAGE_GDO_ON_ENUM_DATA 0x8004661BL OnEnumData of sink object fai‐
led.
CCF_STORAGE_GDO_ASO_CREATE 0x8004661CL Create call to Aso failed.
CCF_STORAGE_GDO_CREATE_CA‐ 0x8004661DL CreateCachedObject failed.
CHED_OBJECT
CCF_STORAGE_GDO_CREA‐ 0x8004661EL Create Sink Object for Aso failed.
TE_SINK_OBJECT_FOR_ASO
CCF_STORAGE_GDO_CREA‐ 0x8004661FL Error in create of DM Gdo.
TE_DM_GDO
CCF_STORAGE_GDO_CON‐ 0x80046620L Error in connect to DM Gdo.
NECT_DM_GDO
CCF_STORAGE_GDO_CREA‐ 0x80046621L Error in create Text Gdo.
TE_TEXT_GDO
CCF_STORAGE_GDO_CON‐ 0x80046622L Error in connect to Text Gdo.
NECT_TEXT_GDO
CCF_STORAGE_GDO_INVA‐ 0x80046623L Invalid enum sink pointer.
LID_ENUM_SINK_POINTER
CCF_STORAGE_GDO_VARIANT_CHAN‐ 0x80046624L Error in Variant ChangeType.
GE_TYPE
CCF_STORAGE_GDO_GET_CO‐ 0x80046625L Error in GetCollectID.
LLECT_ID
CCF_STORAGE_GDO_COM‐ 0x80046626L CommitToTypeHandler failed.
MIT_TO_TYPE_HANDLER
CCF_STORAGE_GDO_SET_TAG_ID 0x80046627L Error in SetTagId.
CCF_STORAGE_GDO_SET_TEXT_ID 0x80046628L Error in SetTextId.
CCF_STORAGE_GDO_COMMIT_CA‐ 0x80046629L Error in CommitCachedObject.
CHED_OBJECT
CCF_STORAGE_GDO_QUERY_INTER‐ 0x8004662AL QueryInterface of sink failed.
FACE_OF_SINK
CCF_STORAGE_GDO_BAD_PRO‐ 0x8004662BL Bad Parameter for Property pro‐
PERTY_PARAMETER vided.
CCF_STORAGE_GET_TAGNA‐ 0x8004662CL Cannot get tag-name from tag-id.
ME_FROM_ID
CCF_STORAGE_DELETE_RE‐ 0x8004662DL Cannot delete records for Crea‐
CORD_OF_CREATORID torID not equal 0.


CCF_STORAGE_CACHE_OVERFLOW 0x8004662EL Cache overflow.
CCF_STORAGE_SERVER_DOWN 0x8004662FL Server down.
CCF_STORAGE_ASO_PTR_NOT_INITIA‐ 0x80046630L Aso smart pointer not initialized.
LIZED
CCF_STORAGE_CREATE_CONNEC‐ 0x80046631L Cannot create connection con‐
TION_CONTROLLER troller.
CCF_STORAGE_CONNECTION_CON‐ 0x80046632L Cannot connection controller to
TROLLER_CONNECT_TO_PROJECT project.
CCF_STORAGE_ASO_WRAP‐ 0x80046633L Cannot set connection controller
PER_SET_CONNECTION_CONTROLLER for aso wrapper.
CCF_STORAGE_ASO_WRAP‐ 0x80046634L Cannot set project storage for
PER_SET_PROJECT_STORAGE aso wrapper.
CCF_STORAGE_PROGID_FROM_CLSID 0x80046635L Error in ProgIDFromCLSID.
CCF_STORAGE_ASO_WRAP‐ 0x80046636L Error in Aso wrapper, GetAso
PER_GET_ASO call.
CCF_STORAGE_ASO_WRAP‐ 0x80046637L Error in Aso wrapper, SetPro‐
PER_SET_PROJECT_STORAGE_NULL jectStorage(NULL).
CCF_STORAGE_ASO_WRAP‐ 0x80046638L Error in Aso wrapper, GetRWIn‐
PER_GET_RWINTERFACE terface call.
CCF_STORAGE_GDO_GET_PROJECT 0x80046639L Error in GdoCoreBase, GetPro‐
ject call.
CCF_STORA‐ 0x8004663AL Error in GdoCoreBase, GetPro‐
GE_TLGGDO_VAR_NO_TRIGGER ject call.
CCF_STORAGE_PACKAGES_PRO‐ 0x80046501L can't instantiate Project-ASO
JECT_ASO
CCF_STORAGE_PACKAGES_EX‐ 0x80046502L Export Data failed
PORT_DATA
CCF_STORAGE_PACKAGES_LIST 0x80046503L Enum Packages failed
CCF_STORAGE_CCPACKAGEMGR_EX‐ 0x80046504L Export Data is running
PORT_IS_RUNNING
CCF_STORAGE_CCPACKAGEMGR_UP‐ 0x80046505L Update Data is running
DATE_IS_RUNNING
CCF_STORAGE_PACKAGES_EX‐ 0x80046506L Export was canceled by user
PORT_USER_CANCELED
CCF_STORAGE_PACKAGES_IM‐ 0x80046507L Only one central archive server
PORT_ONLY_ONE_CAS_CAN_BE_IM‐ can be imported.
PORTED
CCF_STORAGE_PACKAGES_FOR‐ 0x80046508L Configuration of standard-server
BID_STANDARD_SERVER is not allowed for this server-type
CCF_STORAGE_PACKAGES_IM‐ 0x80046509L Do not import redundand server.
PORT_IMPORT_RED
CCF_STORAGE_PACKAGES_IM‐ 0x8004650AL Do not update package with re‐
PORT_CHANGE_RED dundand server.
CCF_STORAGE_PACKAGES_IM‐ 0x8004650BL Do not import package with iden‐
PORT_IMPORT_PHYS tical server.
CCF_STORAGE_PACKAGES_IM‐ 0x8004650CL Do not update package with iden‐
PORT_CHANGE_PHYS tical server.


CCF_STORAGE_PACKAGES_IM‐ 0x8004650DL Do not import or update package
PORT_CHANGE_OWN with own server.
CCF_STORAGE_PACKAGES_IM‐ 0x8004650EL Do not import or update package
PORT_INCLUDE_OWN_RED with own redundand server.
PCC_E_CANNOT_CONNECT_TO_DATA‐ 0x80047000L Cannot connect to database
BASE
PCC_E_RECONNECT_TO_DATABA‐ 0x80047001L Reconnect to database failed
SE_FAILED
PCC_E_JOB_ID_IS_INVALID 0x80047002L Job ID is invalid
PCC_E_INVALID_CONTEXT_INFO_PRO‐ 0x80047003L Invalid context info provided
VIDED
PCC_E_DATABA‐ 0x80047004L Database error - see event log
SE_ERROR_SEE_EVENT_LOG for further information
PCC_E_ERROR_SEE_EVENT_LOG 0x80047005L Unspecified error - see event log
for further information
PCC_E_INVALID_PARAMETERS 0x80047006L Incorrect parameters provided
PCC_E_ROLLBACK_TRANSACTION_FAI‐ 0x80047007L Cannot rollback transaction
LED
PCC_E_COMMIT_TRANSACTION_FAI‐ 0x80047008L Cannot commit transaction
LED
PCC_E_BEGIN_TRANSACTION_FAILED 0x80047009L Cannot start transaction
PCC_E_COPY_WORLDMAP_FAI‐ 0x8004700AL Failed to copy worldmap - world‐
LED_WORLDMAP_LOCKED map locked
PCC_E_MODIFY_WORLDMAP_FAI‐ 0x8004700BL Failed to modify worldmap -
LED_WORLDMAP_LOCKED worldmap locked
PCC_E_REMOVE_WORLDMAP_FAI‐ 0x8004700CL Failed to remove worldmap -
LED_WORLDMAP_LOCKED worldmap locked
PCC_E_MODIFY_VIEW_FAI‐ 0x8004700DL Failed to modify view - view lo‐
LED_VIEW_LOCKED cked
PCC_E_REMOVE_VIEW_FAI‐ 0x8004700EL Failed to remove view - view lo‐
LED_VIEW_LOCKED cked
PCC_E_COPY_WORLDMAP_FAI‐ 0x8004700FL Copy worldmap failed - view(s)
LED_VIEWS_LOCKED locked
PCC_E_MODIFY_WORLDMAP_FAI‐ 0x80047010L Modify worldmap failed - view(s)
LED_VIEWS_LOCKED locked
PCC_E_REMOVE_WORLDMAP_FAI‐ 0x80047011L Remove worldmap failed -
LED_VIEWS_LOCKED view(s) locked
PCC_E_COPY_WORLDMAP_FAILED_OB‐ 0x80047012L Copy worldmap failed - ob‐
JECTS_LOCKED jects(s) locked
PCC_E_MODIFY_WORLDMAP_FAI‐ 0x80047013L Modify worldmap failed - ob‐
LED_OBJECTS_LOCKED jects(s) locked
PCC_E_REMOVE_WORLDMAP_FAI‐ 0x80047014L Remove worldmap failed - ob‐
LED_OBJECTS_LOCKED jects(s) locked
PCC_E_MODIFY_OBJECTS_FAILED_OB‐ 0x80047015L Failed to modify object(s) - ob‐
JECTS_LOCKED ject(s) locked
PCC_E_REMOVE_OBJECTS_FAI‐ 0x80047016L Failed to remove object(s) - ob‐
LED_OBJECTS_LOCKED ject(s) locked


PCC_E_COPY_WORLDMAP_FAI‐ 0x80047017L Failed to copy worldmap in job -
LED_NO_ACTIVATED_WORLDMAP no activated worldmap
PCC_E_REMOVE_WORLDMAP_FAI‐ 0x80047018L Failed to remove worldmap in job
LED_NO_ACTIVATED_WORLDMAP - no activated worldmap
PCC_E_REMOVE_OBJECTS_FAI‐ 0x80047019L Failed to remove object(s) in job
LED_NO_ACTIVATED_OBJECTS - no activated object(s)
PCC_E_MODIFY_OBJECTS_FAI‐ 0x8004701AL Failed to modify object(s) in job
LED_NO_ACTIVATED_OBJECTS - no activated object(s)
PCC_E_REMOVE_VIEW_FAI‐ 0x8004701BL Failed to remove view in job - no
LED_NO_ACTIVATED_VIEW activated view
PCC_E_MODIFY_VIEW_FAILED_NO_AC‐ 0x8004701CL Failed to modify view in job - no
TIVATED_VIEW activated view
PCC_E_MODIFY_WORLDMAP_FAI‐ 0x8004701DL Failed to modify worldmap in job
LED_NO_ACTIVATED_JOB - no activated job
PCC_E_COPY_WORLDMAP_FAI‐ 0x8004701EL Copy worldmap failed - world‐
LED_NOT_FOUND map not found
PCC_E_WORLDMAP_NAME_IN_USE 0x8004701FL Worldmap name already in use
PCC_E_VERSION_NUMBER_INVALID 0x80047020L Version number invalid
PCC_E_USER_DOES_NOT_HAVE_WRI‐ 0x80047021L User does not have 'write' per‐
TE_PERMISSION mission
PCC_E_CREATE_AREALOCK_FAI‐ 0x80047022L Failed to create area lock. There
LED_OBJECTS_LOCKED are locked objects
PCC_E_MODIFY_AREALOCK_FAI‐ 0x80047023L Failed to modify area lock. There
LED_OBJECTS_LOCKED are locked objects
PCC_E_JOB_NOT_FOUND 0x80047024L The job was not found
PCC_E_JOB_MUST_EXIST_MO‐ 0x80047025L The job must exists more than
RE_THAN_ONCE one
PCC_E_CANNOT_MODIFY_ROOT_CTX 0x80047026L The root context can not be mo‐
dified
PCC_E_CANNOT_MODIFY_JOB 0x80047027L The job can not be modified
PCC_E_CANNOT_MODIFY_JOB_RESER‐ 0x80047028L The job can not be modified. It is
VED_BY_OTHER_USER reserved by another user
WINCC_DBPLUGIN_E_ROW_EXISTS 0x80047100L Row already exists
WINCC_DBPLUGIN_E_CONS‐ 0x80047101L A constraint conflict occured
TRAINT_CONFLICT
WINCC_DBPLUGIN_E_INVALID_OB‐ 0x80047102L Invalid object name
JECT_NAME
WINCC_DBPLUGIN_E_INVALID_CO‐ 0x80047103L Invalid column name
LUMN_NAME
WINCC_DBPLUGIN_E_DATA_CONVER‐ 0x80047104L Error converting data
SION
WINCC_DBPLUGIN_E_DATA_CONVER‐ 0x80047105L String conversion to Datetime-
SION_DATETIME format failed
WINCC_DBPLU‐ 0x80047106L String will be truncated
GIN_E_STRING_TOO_LONG
WINCC_DBPLUGIN_E_ARITHME‐ 0x80047107L Arithmetic overflow data type
TIC_OVERFLOW cannot store value


WINCC_DBPLUGIN_RECORD_LOCKED 0x80047108L Record locked
WINCC_DBPLUGIN_TABLE_LOCKED 0x80047109L Table locked
WINCC_DBPLUGIN_CANNOTOPENDB 0x8004710AL Can not open database
PCC_E_CANNOT_DO_MAKE_UNI‐ 0x8004710BL Object cannot get a unique name
QUE_NAME
PCC_E_NO_DB_FOUND_ON_RTS 0x8004710CL Could not access database on
RTS master or standby
PCC_E_OPERATION_NOT_ALLO‐ 0x8004710DL This operation is not allowed on
WED_ON_RTS the RTS database. It must be
performed in the engineering da‐
tabase on the PSOS
PCC_E_NO_DB_FOUND_ON_PSOS 0x8004710EL Could not access database on
PSOS


VB-Scripting (Panels, Comfort Panels, RT Advanced,
RT Professional) 3
3.1 Funciones de sistema (Panels, Comfort Panels, RT Advanced)
3.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.

AcusarAviso

AcknowledgeAlarm
Parámetros
--
3.1.2 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.

VB-Scripting (Panels, Comfort Panels, RT Advanced, RT Professional)
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.

ActivarImagenAnterior

ActivatePreviousScreen
Parámetros
--
3.1.3 ActivateScreen (Panels, Comfort Panels, RT Advanced)
Descripción



Parámetros
Nombre de imagen
Número del objeto

configuración.
Si indica "0":
Nota
cambio de imagen.
Ejemplo

...
}
3.1.4 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)
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 la ventana permanente, y viceversa, introduzca "0"
o "-1", respectivamente.
0 = Cambia de la imagen raíz a la ventana permanente.
-1 = Cambia de la ventana 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":
3.1.5 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.

ActivarVisorDeDiagnósticoDeSistema (Nombre de imagen, Nombre del objeto)

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.
3.1.6 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.
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.
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 servidor
no esté disponible. Dicha petición permanece activa hasta ser ejecutada, incluso después de
un rearranque completo del runtime.

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 (miAlarmArchive) = 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.
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.
3.1.7 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.
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
--
3.1.8 CalibrateTouchScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Llama 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.


CalibrarPantallaTáctil

CalibrateTouchScreen
Parámetros
--
Nota
La función de sistema CalibrarPantallaTáctil no puede ser simulada.
3.1.9 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 en una dirección distinta. El controlador recién conectado debe pertenecer a
la misma clase de dispositivos (S7-1200, S7-300, ...etc.). Además, en el S7-1200 la utilización
de la función sólo es admisible con direccionamiento absoluto.
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 NC
● SIMOTION


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

ChangeConnection (Connection, Address, Slot, Rack)
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. Configure para ello en el
proyecto los autómatas necesarios a los que desea cambiar pulsando un botón. 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. Para acceder a los valores del nuevo controlador, configure las
mismas variables para el controlador utilizado.
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.

3.1.10 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 "Errors"
2 (hmiEvents) = Avisos de la categoría "Warnings"
3 (hmiSystem) = Avisos de la categoría "System"
4 (hmiS7Diagnosis) = Avisos de la categoría "Diagnosis Events"
Nota
Dependencia del dispositivo
Los avisos de la categoría "Diagnosis Events" no están disponibles en Basic Panels.
3.1.11 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.

BorrarAutorizaciónBú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 dispositivo
Los avisos de la categoría "Diagnosis Events" no están disponibles en Basic Panels.
3.1.12 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)


DeleteDataRecord
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.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
3.1.13 ClearDataRecordMemory (Panels, Comfort Panels, RT Advanced)
Descripción
Borra todos los registros de receta del medio de almacenamiento indicado.

BorrarRegistroMemoria (Ubicación, Confirmación, 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
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.

Determina si se debe emitir un aviso de estado una vez concluido el borrado:
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
3.1.14 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.
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 del que se borrarán todas las entradas.
3.1.15 CloseAllLogs (Panels, Comfort Panels, RT Advanced)
Descripción
Deshace la conexión entre WinCC y todos los ficheros.
Nota
Antes de cerrar un fichero es preciso detener la archivación en dicho fichero. Utilice para ello
la función de sistema "PararArchivar".

CerrarTodosLosFicheros

CloseAllLogs

Parámetros
--
Desea cambiar en runtime el soporte de datos en el que se archivan los valores de proceso.
Configure las funciones de sistema "PararArchivación" y "CerrarTodosLosFicheros" y
asócielas 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.
Cuando pulse el botón "Close Archive" se parará el fichero indicado y se cerrarán los ficheros
abiertos. A continuación podrá cambiar el soporte de datos. Con el botón "Open Archive" se
abren todos los ficheros. La archivación continúa en el fichero indicado.
3.1.16 ControlSmartServer (Panels, Comfort Panels, RT Advanced)
Descripción
Inicia o detiene el Sm@rtServer.

ControlarSmartServer (Modo)

ControlSmartServer (Mode)
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

3.1.17 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
3.1.18 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).
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.
3.1.19 DecreaseTag (Panels, Comfort Panels, RT Advanced)
Descripción

X=X-a
Nota
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


DecrementarVariable (Variable, Valor)

Parámetros
Variable
Valor
3.1.20 EditAlarm (Panels, Comfort Panels, RT Advanced)
Descripción
Lanza el evento "Edición" para todos los avisos seleccionados.
Si no ha acusado todavía los avisos a editar, el acuse se efectuará automáticamente al
ejecutarse esta función de sistema.

EditarAviso


EditAlarm
Parámetros
--
3.1.21 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)
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).

3.1.22 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, Codificar, Salto de línea)

EncodeEx (Byte_array, String, Encoding, Line_break)
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.
3.1.23 EstablishPROFIsafe (Panels, Comfort Panels, RT Advanced)
Descripción
Establece la conexión PROFIsafe para el modo de seguridad positiva entre un KTP Mobile
Panel y el controlador si previamente se ha deshecho con PROFIsafeDesconectar.
Nota
Solo es posible establecer una conexión para la comunicación PROFIsafe si el panel de
operador funciona en modo "online". Utilice para ello la función de sistema
"EstablecerModoDeOperaciónPanel".

PROFIsafeConectar

EstablishPROFIsafe
Parámetros
--
3.1.24 ExportDataRecords (Panels, Comfort Panels, RT Advanced)
Descripción
Exporta uno o todos los registros de una receta a un archivo CSV.
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)
Parámetros
Número/nombre de receta
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.
Nombre de archivo
Nombre del archivo CSV al que se deben exportar los registros de receta. Introduzca también
la ubicación y la extensión del archivo (*.csv), p. ej. "C:\TEMP\Orange.csv", para Basic Panels
"\USB_X61.1\Orange.csv".
Nota
Almacenamiento del archivo CSV
No vale para Basic Panels:
● Si utiliza una tarjeta de memoria como ubicación, introduzca esta última del siguiente modo:
"\StorageCard\<nombre del archivo>".
● Si define sólo un nombre de archivo y no una ruta, el archivo se guardará en un directorio
del sistema, p. ej. "C:\Documents and Settings\[User]".
● Si sólo se indica una ruta para la exportación, el nombre del archivo se genera
automáticamente a partir del nombre de la receta. Para ello, es imprescindible que la
carpeta esté creada, p. ej. "D:\Temp\". Si la carpeta "D:\Temp" no está creada, se utilizará
su nombre como prefijo para el nombre de archivo, Temp_nombre de receta.csv.
Número/nombre de registro
Número/nombre del registro de receta que se exportará. Introduzca "0" si desea exportar todos
los registros de receta.
Sobrescribir
Determina si se debe sobrescribir un archivo CSV existente de igual nombre:
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 (hmiOverwriteWithPrompting) = Tras confirmar: 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.
No vale para Basic Panels:
Para la exportación también se pueden utilizar archivos de texto en formato "Unicode (".txt)".
Este formato de archivo soporta 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_X61.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.
3.1.25 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/name, Data_record number/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/nombre del registro de receta que se exportará. Introduzca "0" si desea exportar todos
los registros de receta.
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 esta última del siguiente modo:
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:
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) = Tras confirmar: 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 soporta 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
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.
3.1.26 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.

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
Si utiliza una tarjeta de memoria como ubicación, introduzca ésta última del siguiente modo:
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.
3.1.27 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.

3.1.28 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/name, Data_record_number/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

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


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

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
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.
3.1.30 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/name, Processing_status)
Parámetros
Número o nombre del registro de receta cuyos valores se escriben del controlador a la variable.

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

LeerContraseña (Variable)

GetPassword (Tag)

Parámetros
Variable
Variable en la que se escribe la contraseña.
3.1.33 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)
Parámetros
Variable
Variable en la que se escribe el nombre del usuario.
3.1.34 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
--
3.1.35 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.

IrAInicio

GoToHome
Parámetros
--
3.1.36 ImportDataRecords (Panels, Comfort Panels, RT Advanced)
Descripción
Importa uno o todos los registros de una receta de un archivo CSV.

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/name, Overwrite,
Parámetros
Nombre de archivo
Nombre del archivo CSV del que se deben importar los registros de receta. Introduzca también
la ubicación y la extensión del archivo (*.csv), p. ej. "C:\TEMP\Orange.csv", para Basic Panels
"\USB_X61.1\Orange.csv".
Nota
No vale para Basic Panels: Si utiliza una tarjeta de memoria como ubicación, introduzca ésta
última del siguiente modo: "\StorageCard\<nombre del archivo>".
Número/nombre de registro
Número o nombre del registro de receta que se importará. Introduzca "0" si desea importar
todos los registros de receta.
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
tras haberse confirmado la consulta de seguridad.

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
Nombre de imagen Creada
Borrada
Objeto de imagen Pulsar
Soltar
Hacer clic
Modificar (o conmutar con el interruptor)
Conectar
Desconectar
Activar
Desactivar
Planificador de tareas Tiempo agotado
3.1.37 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/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 del 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
todos los registros de receta.
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) = Tras confirmar: 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:
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.
3.1.38 IncreaseTag (Panels, Comfort Panels, RT Advanced)
Descripción
X=X+a
Nota
Si asocia la función de sistema a eventos de un aviso y la variable no se utiliza en la imagen



Parámetros
Variable
Valor
Valor que se suma.
3.1.39 InverseLinearScaling (Panels, Comfort Panels, RT Advanced)
Descripción

"EscalaLineal".
Nota


Parámetros
X
Y
b
a

Ejemplo
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;


...
}
3.1.40 InvertBit (Panels, Comfort Panels, RT Advanced)
Descripción


InvertBit (Tag)
Parámetros
Variable

Ejemplo
{
BOOL b_value = 0;
//Invert variable
invertBit(b_value);

...
}
3.1.41 InvertBitInTag (Panels, Comfort Panels, RT Advanced)
Descripción
Nota



Parámetros
Tag
Bit
Ejemplo
{
BYTE bvalue;

...
}
3.1.42 LinearScaling (Panels, Comfort Panels, RT Advanced)
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

...
}
3.1.43 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/name, Data_record_number/name, Confirmation,
Parámetros
Número o nombre de la receta desde la que se cargará un registro.
Número o nombre del registro de receta que se cargará.
3.1.44 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
--
3.1.45 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)

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.
3.1.46 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, Valor, Idioma, Lista de textos)

LookupText (Output_text, Index, Language, Text_list)
Parámetros
Texto de salida
Variable en la que se escribe el resultado.
Valor
Variable que determina el valor del registro de la lista.
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.
3.1.47 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 utilizar la función de sistema es imprescindible que se active la
configuración conforme a 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)
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 acusar 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.
3.1.48 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

OpenAllLogs
Parámetros
--
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.

3.1.49 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

OpenCommandPrompt
Parámetros
--
3.1.50 OpenControlPanel (Panels, Comfort Panels, RT Advanced)
Descripción
Abre un diálogo mediante el que se puede modificar la configuración seleccionada en el 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álogoPanelDeControl" se omite el SecureMode en el panel
de operador. Tome las medidas preventivas necesarias para garantizar la seguridad de su
proyecto.

AbrirDiálogoPanelDeControl (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.
3.1.51 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".
3.1.52 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)

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
3.1.53 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
--
3.1.54 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
-
3.1.55 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
-
3.1.56 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.
3.1.57 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.
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
--

3.1.58 ResetBit (Panels, Comfort Panels, RT Advanced)
Descripción


ResetBit (Tag)
Parámetros
Variable
Ejemplo
{
BOOL b_value = 1;
//Reset bit
ResetBit (b_value);

...
}
3.1.59 ResetBitInTag (Panels, Comfort Panels, RT Advanced)
Descripción

Nota


Parámetros
Variable
Bit
Ejemplo
{
BYTE bvalue;


...
}

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

RetirarHardwareConSeguridad(Ruta, Resultado)

SafelyRemoveHardware(Path, Result)
Parámetros
Ruta
Ruta del medio de almacenamiento, p. ej. \Storage Card USB\
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.
3.1.61 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/name, Data_record_number/name, Overwrite,
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) = Tras confirmar: El registro de receta se sobrescribirá tras

Determina si se debe visualizar un aviso de estado después de guardar.
3.1.62 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.

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.
3.1.63 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)
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
3.1.64 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) = impresión desactivada: Los informes no se imprimen
automáticamente.

1 (hmiEnablePrinting) = Habilitar Impresión: Los informes se imprimen automáticamente.

3.1.65 SetAndGetBrightness (Panels, Comfort Panels, RT Advanced)
Descripción
Define el brillo de la pantalla para un MP 377 Touch daylight readable. Aquí el valor del brillo
puede interpretarse de modo absoluto o relativo con respecto al valor actual.
Nota
Al reiniciar el panel de operador se restablece la configuración que estaba ajustada en el
Control Panel.

DefinirYLeerBrillo (Brillo, Modo, Valor actual)

SetAndGetBrightness (Brightness, Mode, Actual brightness)
Parámetros
Brillo
Valor nuevo del brillo.
Modo
Determina si el nuevo valor del brillo se ajusta de modo absoluto o relativo con respecto al
valor actual.
Valor actual
Variable en la que se deposita el valor actual del brillo.
3.1.66 SetBit (Panels, Comfort Panels, RT Advanced)
Descripción



SetBit (Tag)
Parámetros
Variable
Ejemplo
{
BOOL b_value = 0;
//Set bit
SetBit (b_value);

...
}
3.1.67 SetBitInTag (Panels, Comfort Panels, RT Advanced)
Descripción

Nota


Parámetros
Variable
Bit
Nota

Ejemplo
{
BYTE bvalue;


...
}
3.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 de 2.ª generación, 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)

Parámetros
Valor
Valor nuevo del brillo.
3.1.69 SetConnectionMode (Panels, Comfort Panels, RT Advanced)
Descripción
Establece o desconecta la conexión indicada.
Nota
Sólo 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".

EstablecerModoDeConexión (Modo, Conexión)

SetConnectionMode (Mode, Connection)
Parámetros
Modo
Determina si la conexión con el controlador se debe establecer o desconectar:
0 (hmiOnline) = Online: Se establece la conexión.
1 (hmiOffline) = Offline: Se deshace la conexión.
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 del tipo de datos "BOOL" 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.
3.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.

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

SetDataRecordTagsToPLC (Recipe_ number/name, Processing_status)

Parámetros
Número o nombre de la receta desde la que se debe transferir un registro al controlador.
3.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/name, Data_record_number/name,
Parámetros
Número o nombre de la receta desde la que se debe transferir un registro al controlador.
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.
0 (hmiOff) = Off: No emitir ningún aviso de estado.
1 (hmiOn) = On: Emitir un aviso de estado.
3.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)

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

3.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): Maximizada
3 (hmiScreenRestore): Restablecer: 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): Minimizada
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.
3.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.


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.
3.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, hora)

SetPLCDateTime (Connection, Time)

Parámetros
Conexión
Conexión de controlador y panel de operador.
Hora
Transfiere la fecha y la hora del panel de operador al controlador. El controlador aplica la fecha
y la hora del panel de operador.
3.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/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.


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

3.1.79 SetTag (Panels, Comfort Panels, RT Advanced)
Descripción
Nota


SetTag (Tag, Value)
Parámetros
Variable
Valor
Nota

Ejemplo
{
BOOL ok;
BOOL bvalue;

//error handling
if(ok)
{
// succeeded
}
else
{
// failed
}
...
}
3.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)


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

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

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

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

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

MostrarImagenEmergente (Objeto de imagen)

ShowPopupScreen (Name_of_the_screen, Coordinate_X, Coordinate_Y, Layout)
Parámetros
Nombre de la imagen
Define el nombre de la imagen que aparece en runtime al pulsar el botón.
Coordenada X
Posición de la imagen en el eje X de la imagen actual
Coordenada Y
Posición de la imagen en el eje Y de la imagen actual
Representación
Define el modo para la imagen deslizable:
Conmutar
Off
On

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


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
3.1.86 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/value)
Parámetros
Texto/valor
Texto o valor a emitir como aviso del sistema.

3.1.87 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ósticoDeSistema (Objeto de imagen)

ShowSystemDiagnosticsWindow (Target_Object_name)
Parámetros
Objeto de imagen
Nombre de la ventana de diagnóstico del sistema que se debe mostrar u ocultar.
3.1.88 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)

Parámetros
Tipo de fichero
2 (hmiAudittrailArchive) = Audit Trail
Fichero
Nombre del fichero a iniciar.
3.1.89 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.

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

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)
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 (ShowMinimizedAndInactive) = 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.
3.1.91 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.
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.
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
Archive" se abrirán de nuevo todos los ficheros, pudiendo continuar con la archivación en el
fichero indicado.
3.1.92 StopRuntime (Panels, Comfort Panels, RT Advanced)
Descripción
operador.

PararRuntime (Modo)


StopRuntime (Mode)
Parámetros
Modo
Ejemplo

3.1.93 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 "PROFIsafeDesconectar", el conector del KTP Mobile
Panel puede desenchufarse del controlador sin que la instalación notifique un error.

PROFIsafeDesconectar

TerminatePROFIsafe

Parámetros
--
3.1.94 WinACMPGetVersion (Panels, Comfort Panels)
Descripción
Lee el valor del número de versión de WinAC MP.

WinACMPLeerVersión(Versión, Actualizar)

WinACMPGetVersion (Version, Action)
información en AUTOHOTSPOT.
Parámetro
Versión
Variable que contiene el valor.
Actualizar
Determina si el número de versión se debe leer:
0 (SwitchOff) = OFF: El número de versión no se lee.
1 (SwitchOn) = ON: El número de versión se lee.
3.1.95 WinACMPSetStartAtBoot (Panels, Comfort Panels)
Descripción
Establece si WinAC MP se inicia automáticamente después de arrancar el panel de operador
o no.


WinACMPDefinirComportamientoDeArranque(Comportamiento en arranque)

WinACMPSetStartAtBoot (Start at boot)
Parámetros
Comportamiento en arranque
Determina si WinAC MP se inicia automáticamente.
0 (StartAtBootOff) = OFF: WinAC MP no se inicia cuando se arranca el panel de operador.
1 (StartAtBootOn) = ON: WinAC MP no se inicia automáticamente cuando se arranca el panel
de operador.
3.1.96 WinACSetStartMode (Panels, Comfort Panels)
Descripción
Establece el modo de operación después de arrancar el panel de operador de WinAC MP.

WinACMPEstablecerModoDeArranque (Autostart)

WinACSetStartMode (Autostart)
Parámetros
Comportamiento en arranque
Determina si se activa la función de inicio automático de WinAC MP.
0 (AutoStartOff) = OFF: WinAC MP permanece en estado operativo STOP después del inicio.
1 (AutoStartOn) = ON: Después del inicio, WinAC MP cambia al mismo estado operativo que
tenía antes de cerrarse.

3.2.1 ActivateScreen (RT Professional)
Descripción


Parámetros
Nombre de imagen
Número del objeto

configuración.
Si indica "0":
Nota
cambio de imagen.

Ejemplo

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

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 de programa activa la imagen "Screen_2" con la función
ActivateScreenInScreenWindow al pulsar cualquier tecla.
{
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
3.2.3 DecreaseTag (RT Professional)
Descripción
X=X-a
Nota


ReducirVariable (Variable, Valor)

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

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
Si utiliza una tarjeta de memoria como ubicación, introduzca ésta última del siguiente modo:
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.
3.2.5 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);
...
}
3.2.6 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;


...
}

3.2.7 InvertBit (RT Professional)
Descripción


InvertBit (Tag)
Parámetros
Variable
Ejemplo
{
BOOL b_value = 0;
//Invert variable
invertBit(b_value);

...
}

3.2.8 InvertBitInTag (RT Professional)
Descripción
Nota


Parámetros
Tag
Bit

Ejemplo
{
BYTE bvalue;

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

...
}
3.2.10 ResetBit (RT Professional)
Descripción


ResetBit (Tag)

Parámetros
Variable
Ejemplo
{
BOOL b_value = 1;
//Reset bit
ResetBit (b_value);

...
}
3.2.11 ResetBitInTag (RT Professional)
Descripción
Nota



Parámetros
Variable
Bit
Ejemplo
{
BYTE bvalue;


...
}
3.2.12 SetBit (RT Professional)
Descripción



SetBit (Tag)
Parámetros
Variable
Ejemplo
{
BOOL b_value = 0;
//Set bit
SetBit (b_value);

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



Parámetros
Variable
Bit
Nota
Ejemplo
{
BYTE bvalue;


...
}

3.2.14 SetPropertyByConstant (RT Professional)
Descripción
Define el valor de una propiedad de objeto como cadena de caracteres.

DefinirPropiedadVíaConstante (Nombre de imagen, Objeto, Nombre de la propiedad, Valor)

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


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

...
}
Como alternativa, puede utilizar en lugar del segundo parámetro (Objeto) la contraseña NULL
o bien un string de espacios en blanco.
3.2.15 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, Nombre
de imagen de destino, Objeto de destino, Nombre de la propiedad de destino)


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 cuya propiedad se transfiere al objeto de destino.
Nombre de la propiedad al que se transfiere el objeto de destino.
Nombre de imagen de destino

Nombre de la imagen en el que está contenido el objeto de destino.
Objeto de destino
Nombre del objeto de destino al que se transfiere la 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");

...
}
3.2.16 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, Nombre de la propiedad, Nombre
de 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
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");

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


...
}

3.2.17 SetPropertyByTagIndirect (RT Professional)
Descripción
Define el valor de una propiedad de objeto por medio de una variable. La variable contiene el
nombre de variable que determina la propiedad del objeto.

DefinirPropiedadIndirectamenteVíaVariable (Nombre de imagen, Objeto, Nombre de la
propiedad, Nombre de 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
Nombre de variable
Nombre de la variable que, a su vez, contiene el nombre de la variable que determina la
propiedad del objeto.

Ejemplo
SetPropertyByTagIndirect: .
SetPropertyByTagIndirect (GetParentScreen(screenName), GetParentScreenWindow(screenName),

"ScreenName", "HMI_value_1");

...
}
3.2.18 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
}
...
}
3.2.19 SetTagByProperty (RT Professional)
Descripción
Define un valor de variable por medio del valor de una propiedad de objeto. La modificación

DefinirVariableVíaPropiedad (Nombre de variable, Nombre de imagen, Objeto, 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
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",

...
}
3.2.20 SetTagByTagIndirect (RT Professional)
Descripción


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 variable
Nombre de la variable cuyo valor se define por medio de una variable indirecta.
Nombre de variable

Ejemplo
El siguiente código de programa devuelve el valor de la variable "@LocalMachineName" al
hacer clic en cualquier tecla.
{
char* rt_value;
SetTagByTagIndirect (rt_value, "@LocalMachineName", hmiWithoutOperatorEvent);
...
}
3.2.21 SetTagIndirect (RT Professional)
Descripción
Define el nombre indirecto para una variable.

DefinirVariableIndirectamente (Nombre de variable (salida), LpValue)


SetTagIndirect (Tag_name, Value, With_or_without_operator_event)
Parámetros

LpValue
Ejemplo
{
BYTE result;
BYTE value;
SetTagIndirect ("result", "value", hmiWithoutOperatorEvent);

...
}
3.2.22 SetTagIndirectByProperty (RT Professional)
Descripción
Define un nombre de variable por medio del valor de una propiedad de objeto. La modificación

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
Nombre de la variable cuyo nombre se define por medio de la propiedad de objeto.
Nombre de imagen
Objeto de imagen
Nombre del objeto cuya propiedad proporciona el nombre de variable.
Nombre de la propiedad que proporciona el nombre de variable.

Ejemplo
El siguiente código de programa ajusta la variable "rt_value_property" al valor de la propiedad
"FlashingEnabled" al hacer clic en la tecla objectName.
{
Int rt_value_property;
SetTagIndirectByProperty ("rt_value_property", screenName, objectName, "FlashingEnabled",
...
}
3.2.23 SetTagIndirectByTagIndirect (RT Professional)
Descripción

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


SetTagIndirectByTagIndirect (Tag_name, Source_tag_name,
Parámetros
Nombre de variable
Nombre de la variable indirecta cuyo valor se define por medio de una variable indirecta.
nombre de variable

Ejemplo
El siguiente código de programa ajusta la variable "rt_value" al valor de la variable "value" al
hacer clic en la tecla objectName.
{
Int rt_value;
Int value;
SetTagIndirectByTagIndirect ("rt_value", "value", hmiWithoutOperatorEvent);

...
}
3.2.24 SetTagIndirectWithOperatorInputAlarm (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

LpValue
3.2.25 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 variable (salida), LpValue)

SetTagWithOperatorEvent (Tag_name, Value)
Parámetros

Nombre de la variable cuyo valor se define.
LpValue
El valor que se escribe la variable.

Ejemplo
{
BYTE result;
BYTE value;
SetTagWithOperatorEvent ("result", "value");

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

ShowLogonDialog
Parámetros
--
3.2.27 StopRuntime (RT Professional)
Descripción
operador.

PararRuntime (Modo)

3.3 VBScript para Windows (Panels, Comfort Panels, RT Advanced, RT Professional)

StopRuntime (Mode)
Parámetros
Modo
Ejemplo

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

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

3.4 VBScript para Windows CE (Panels, Comfort Panels)
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
3.4.1 VBScript para Windows CE (Panels, Comfort Panels)
3.4.1.1 Attr (Panels, Comfort Panels)
Function
This property of the File control returns a number indicating the file mode that was used to
open the file.
Sintaxis
file.Attr
Parameters
File
Reference to a File control.
Return Values
The return values listed in the following table indicate the file access mode. If the return value
is 0, the file is closed.
Constant Value
None 0
fsModeInput 1
fsModeOutput 2
fsModeRandom 4
fsModeAppend 8
fsModeBinary 32
Remarks
The Attr property is read-only. Use the Open method of the File control to set the file mode.

3.4.1.2 Close (Panels, Comfort Panels)
Function
This method closes an open File control.
Syntax
file.Close
Parameters
File
Name of a File control.
Return Values
None.
Remarks
Use the Open method to open a file.
3.4.1.3 CreateObject (Panels, Comfort Panels)
Function
This function creates a reference to an Automation object.
Sintaxis
CreateObject (Object)
Parameters
Object
A string containing the ProgID of the object to create.
Return Values
Returns a reference to an Automation object.

Remarks
Use CreateObject to create non-visible ActiveX controls at runtime. You cannot use
CreateObject to create graphical objects such as a TreeView control or a ListView control.
CreateObject produces objects that cannot respond to events. To produce objects that can
respond to events, use the CreateObjectWithEvents function. The following table lists the
ProgIDs for the ActiveX controls without events.
Control ProgID
Microsoft CE File control 6.0 .file
Microsoft CE FileSystem control 6.0 .filesystem
Microsoft CE ImageList control 6.0 CEimageList.imagelistctrl
Example
Dim f, fwModeAppend
Set f = CreateObject("FileCtl.File")
fwModeAppend=8
f.Open "\Storage Card\testfile.txt", fwModeAppend
f.Close
3.4.1.4 Dir (Panels, Comfort Panels)
Function
This method returns the name of a file, directory, or folder that matches a specified pattern or
file attribute.
Sintaxis
File.Dir (Pathname,[Attributes])
Parameters
File
Reference to a FileSystem control.
Pathname
Opcional. String expression that specifies a file name or path.
Attributes
Opcional. Numeric expression whose sum specifies file attributes. If omitted, all files that match
pathname are returned.

The following table describes the parameter settings of attributes.
Constant Value Description

fsAttrNormal 0 Normal
fsAttrReadOnly 1 Read-only
fsAttrHidden 2 Hidden
fsAttrSystem 4 System file
fsAttrVolume 8 Volume label. If specified, all other attributes are ignored.
fsAttrDirectory 16 Directory or folder
fsAttrArchive 32 Archivos
Return Values
String File name that matches pathname and attributes. Dir returns a zero-length string ("") if
pathname is not found.
Remarks
Dir supports the use of multiple-character (*) and single-character (?) wildcards to specify
multiple files. You must specify pathname the first time you call the Dir method. In addition, if
you specify file attributes you must include pathname.
The Dir method returns the first file name that matches pathname. To get any additional file
names that match pathname, call Dir again with no parameters. When no more file names
match, Dir returns a zero-length string (" "). Once a zero-length string is returned, you must
specify pathname in subsequent calls.
3.4.1.5 EOF (Panels, Comfort Panels)
Function
This property returns True when the end of a file opened for random or sequential input is
reached.
Syntax
File.EOF
Parameters
File
Remarks
Use the EOF property to avoid the error generated by attempting to read past the end of a file.

The EOF property returns False until the end of the file has been reached. For files opened
with a fsModeRandom or fsModeBinary file mode, EOF returns False until the last executed
Get statement is unable to read an entire record.
For files opened with a fsModeBinary file mode, an attempt to read through the file using the
Input function until EOF returns True generates an error. Use the LOF and LOC properties
instead of EOF when reading binary files with Input, or use Get when using the EOF property.
For files opened with a fsModeOutput file mode, EOF always returns True.
3.4.1.6 FileCopy (Panels, Comfort Panels)
Function
This method copies an existing file to a new file.
Syntax
Filesystem.FileCopy PathName, NewPathName
Parameters
Filesystem
Reference to a FileSystem object.
PathName
String that contains the path and file name.
NewPathName
String that contains the file name and path of the new file.
Return Values
None.
Remarks
FileCopy returns an error if the new file does not exist.
3.4.1.7 FileLen (Panels, Comfort Panels)
Function
This method returns a value specifying the length, in bytes, of a file.

Syntax
Filesystem.FileLen(pathname)
Parameters
Filesystem
Pathname
Required. String expression that specifies a file. The pathname can include a directory or folder.
Return Values
Returns the number of bytes in a file.
Remarks
If the specified file is open when the FileLen method is called, the value returned represents
the size of the file immediately before it was opened.
3.4.1.8 FileDateTime (Panels, Comfort Panels)
Function
This method returns a variant (Date) that indicates the date and time when a file was created
or last modified.
Syntax
filesystem.FileDateTime(pathname)
Parameters
Filesystem
Pathname
Required. String expression that specifies a file name. The pathname can include a directory
or folder.
Return Values
Returns the date the file was last modified.

Remarks
FileDateTime returns an error if the new file does not exist.
3.4.1.9 Get (Panels, Comfort Panels)
Function
This method reads data from an open disk file into a variable.
Syntax
file.Get Data, [Recnumber]
Parameters
File
Data
Required. Variant variable into which data is read.
Recnumber
Optional. Variant. Record number at which reading begins. For files opened in binary mode,
Recnumber specifies the byte position.
Return Values
None
Remarks
Data read with the Get method usually is written to a file with the Put method. The first record
or byte in a file is at position 1, the second record or byte is at position 2, and so on. If you omit
Recnumber, the next record or byte following the last Get or Put method (or pointed to by the
last Seek function) is read.

For files opened in Random mode, the following rules apply:

● If the length of the data being read is less than the length specified in the Len clause of the
Open method, Get reads subsequent records on record-length boundaries. The space
between the end of one record and the beginning of the next record is padded with the
existing contents of the file buffer. Because the amount of padding data cannot be
determined with any certainty, it is generally advisable to match the record length with the
length of the data being read.
● If Data is a Variant of numeric type, Get reads 2 bytes identifying the VarType of the Variant
and then reads the data that goes into the variable. For example, when reading a Variant
of VarType 3, Get reads 6 bytes: 2 bytes identifying the Variant as VarType 3 (Long) and
4 bytes containing the Long data. The record length specified by the Len clause in the Open
method must be at least 2 bytes greater than the actual number of bytes required to store
the variable.
● You can use the Get method to read a Variant array from a disk, but you cannot use Get
to read a scalar Variant containing an array. You also cannot use Get to read objects from
a disk.
● If the variable being read into is a Variant of VarType 8 (String), Get reads 2 bytes identifying
the VarType and 2 bytes indicating the length of the string. Then it reads the string data.
The record length specified by the Len clause in the Open method must be at least 4 bytes
greater than the actual length of the string.
● If the variable being read into is a dynamic array, Get reads a descriptor whose length
equals 2 plus 8 times the number of dimensions, that is, 2 + 8 * NumberOfDimensions. The
record length specified by the Len clause in the Open method must be greater than or equal
to the sum of all the bytes required to read the array data and the array descriptor.
For files opened in Binary mode, the Len clause in the Open method has no effect. Get reads
all variables from a disk contiguously; that is, with no padding between records.
3.4.1.10 GetAttr (Panels, Comfort Panels)
Function
This method returns a number representing the attributes of a file, directory, or folder.
Sintaxis
filesystem.GetAttr(pathname)
Parameters
Filesystem

Pathname
Required. String expression that specifies a file name or directory or a folder name. The
pathname can include the directory or folder.
Return Values
Sum of attribute values. The following table shows the sums that can be returned.

vbNormal 0 Normal
VbReadOnly 1 Read-only
VbHidden 2 Hidden
VbSystem 4 Sistema
VbDirectory 16 Directory or folder
VbArchive 32 File has changed since last backup
Remarks
To determine which attributes are set, use the And operator to perform a bitwise comparison
of the value returned by the GetAttr method and the value of the individual file attribute you
want. If the result is not zero, that attribute is set for the named file.
3.4.1.11 Input (Panels, Comfort Panels)
Function
This method returns a string containing characters from a file opened in Input or Binary mode.
Syntax
file.Input(number)
Parameters
File
Number
Any valid numeric expression that specifies the number of characters to return.
Return Values
String containing characters read from file.

Remarks
Data read with the Input method usually is written to a file with the LinePrint or Put functions.
Use this method only with files opened in Input or Binary mode.
Unlike the LineInputString method, the Input method returns all the characters it reads,
including commas, carriage returns, line feeds, quotation marks, and leading spaces.
With files opened for Binary access, an attempt to read through the file using the Input method
until the EOF function returns True generates an error. To avoid an error, use the LOF and
Loc functions instead of EOF when reading binary files with the Input method or use Get when
using the EOF function.
3.4.1.12 InputFields (Panels, Comfort Panels)
Function
This method reads data from an open sequential file and returns a single dimension Variant
array.
Sintaxis
file.InputFields(número)
Parameters
File
Number
Number of comma-delimited fields to read from the file.
Return Values
Array containing the fields read from the file.
Remarks
Data read with the InputFields method usually is written to a file with WriteFields. Use this
method only with files opened in Input or Binary mode.
InputFields reads standard string or numeric data without modification. The following table
shows how InputFields reads other input data.
Data Value Assigned to Variable

Delimiting comma or blank line Empty
#NULL# Null

Data Value Assigned to Variable

#TRUE# o #FALSE# True or False
#yyyy-mm-dd hh:mm:ss# The date and/or time represented by the expression
Double quotation marks ("") within input data are discarded.

If you reach the end of the file while you are inputting a data item, the input is terminated and
an error occurs.
To correctly read data from a file into variables using InputFields, use the WriteFields method
instead of the LinePrint method to write the data to the files. Using WriteFields ensures each
separate data field is properly delimited.
3.4.1.13 InputB (Panels, Comfort Panels)
Function
This method returns bytes from a file opened in Input or Binary mode.
Syntax
file.InputB(number)
Parameters
File
Number
Any valid numeric expression that specifies the number of bytes to return.
Return Values
Array containing bytes read from file.
Remarks
Data read with the InputB method usually is written to a file with the LinePrint or Put functions.
Use this method only with files opened in Input or Binary mode.
3.4.1.14 Kill (Panels, Comfort Panels)
Function
This method deletes files from a disk.

Syntax
filesystem.Kill pathname
Parameters
Filesystem
Pathname
Required. String expression that specifies one or more file names to be deleted. The pathname
can include the directory or folder.
Return Values
None.
Remarks
The Kill method supports the use of multiple-character (*) and single-character (?) wildcards
to specify multiple files.
An error occurs if you try to use Kill to delete an open file.
3.4.1.15 LineInputString (Panels, Comfort Panels)
Function
This method reads a single line from an open sequential file and assigns it to a string variable.
Syntax
file.LineInputString
Parameters
File
Return Values
None.

Remarks
Data read with LineInputString usually is written from a file with LinePrint.
The LineInputString method reads from a file one character at a time until it encounters a
carriage return (Chr(13)) or carriage return/line feed (Chr(13) + Chr(10)) sequence. Carriage
return/line feed sequences are skipped rather than appended to the character string.
3.4.1.16 LinePrint (Panels, Comfort Panels)
Function
This method writes a single line to an open sequential file.
Syntax
file.LinePrint output
Parameters
File
Output
String expression to write to a file.
Return Values
None.
Remarks
Data written with LinePrint is usually read from a file with LineInputString.
A carriage return/line feed (Chr(13) + Chr(10)) sequence is appended to the end of the string.
3.4.1.17 Loc (Panels, Comfort Panels)
Function
This property returns a number specifying the current read/write position.
Syntax
file.Loc

Parameters
File
Remarks
For files opened with the fsModeRandom file mode, Loc returns the number of the last record
read or written. For files opened with all other modes, Loc returns the position of the last byte
read or written.
3.4.1.18 LOF (Panels, Comfort Panels)
Function
This property returns a number representing the size, in bytes, of a file.
Syntax
file.LOF
Parameters
File
Remarks
The LOF property can be used with the Loc property to guarantee that a read operation does
not continue past the end of a file.
3.4.1.19 MkDir (Panels, Comfort Panels)
Function
This method creates a new directory.
Syntax
filesystem.MkDir PathName

Parameters
Filesystem
Pathname
String expression that contains the directory name.
Return Values
None.
Remarks
MkDir generates an error if the directory already exists.
3.4.1.20 MoveFile (Panels, Comfort Panels)
Function
This method renames an existing file or a directory, including all its subdirectories.
Syntax
filesystem.MoveFile PathName, NewPathName
Parameters
Filesystem
PathName
String that contains the file name.
NewPathName
String that contains the file name to copy to.
Return Values
None.

3.4.1.21 Open (Panels, Comfort Panels)
Function
This method opens a file in either the Input (1), Output (2), Random (4), Append (8), or Binary
mode (32).
Syntax
file.Open pathname, mode, [access], [lock], [reclength]
Parameters
File
Pathname
String expression that specifies a file name.
Mode
Specifies the file mode: Input (1), Output (2), Random (4) , Append (8), or Binary (32).
Access
Operation permitted on the open file: Read, Write, or ReadWrite [Default]. (1, 2, 3)
Lock
Operations permitted on the open file by other processes: Shared, LockRead, LockWrite
[Default], and LockReadWrite. (1, 2, 3, 0)
Reclength
Number, in bytes, that is less than 32,767. For files opened for random access, this value is
the record length. For sequential files, this value is the number of characters buffered.
Return Values
None.
Remarks
The reclength parameter is ignored if the mode is Binary. When opening a file in Random
mode, you must specifiy a record size of greater than zero or an error will occur.

3.4.1.22 Put (Panels, Comfort Panels)
Function
This method writes data from a variable to a disk file.
Syntax
file.Put data, [recnumber]
Parameters
Data
Required. Variant variable that contains data to be written to disk.
Recnumber
Optional. Variant (Long). Record number (Random mode files) or byte number (Binary mode
files) at which writing begins.
Return Values
None.
Remarks
Data written with Put usually is read from a file with Get.
The first record or byte in a file is at position 1, the second record or byte is at position 2, and
so on. If you omit recnumber, the next record or byte after the last Get or Put method or pointed
to by the last Seek function is written.
For files opened in Random mode, the following rules apply:
● If the length of the data being written is less than the length specified in the Len clause of
the Open method, Put writes subsequent records on record-length boundaries. The space
between the end of one record and the beginning of the next record is padded with the
existing contents of the file buffer. Because the amount of padding data cannot be
determined with any certainty, it generally is a good idea to have the record length match
the length of the data being written. If the length of the data being written is greater than
the length specified in the Len clause of the Open method, an error occurs.
● If the variable being written is a Variant of a numeric type, Put writes 2 bytes identifying the
VarType of the Variant and then writes the variable. For example, when writing a Variant
of VarType 3, Put writes 6 bytes: 2 bytes identifying the Variant as VarType 3 (Long) and
4 bytes containing the Long data. The record length specified by the Len clause in the Open
method must be at least 2 bytes greater than the actual number of bytes required to store
the variable.
You can use the Put method to write a Variant array to disk, but you cannot use Put to write
a scalar Variant containing an array to disk. You also cannot use Put to write objects to disk.
If the variable being written is a Variant of VarType 8 (String), Put writes 2 bytes identifying

the VarType and 2 bytes indicating the length of the string. It then writes the string data. The
record length specified by the Len clause in the Open method must be at least 4 bytes greater
than the actual length of the string.
If the variable being written is a dynamic array, Put writes a descriptor whose length equals 2
plus 8 times the number of dimensions, that is, 2 + 8 * NumberOfDimensions. The record length
specified by the Len clause in the Open method must be greater than or equal to the sum of
all the bytes required to write the array data and the array descriptor. For example, the following
array declaration requires 118 bytes when the array is written to disk.
For files opened in Binary mode, the Len clause in the Open method has no effect. Put writes
all variables to disk contiguously; that is, with no padding between records.
3.4.1.23 RmDir (Panels, Comfort Panels)
Function
This method deletes an existing empty directory.
Syntax
filesystem.RmDir PathName
Parameters
Filesystem
PathName
String that contains the directory name.
Return Values
None.
Remarks
The directory must be empty before it can be removed. You must specify a complete file path.
3.4.1.24 Seek (Panels, Comfort Panels)
Function
This property returns and sets the next position in a file that will be read or written.

Syntax
file.Seek [= position]
Parameters
File
Position
Numeric expression that specifies a position within a file.
Remarks
The Seek property specifies the next file position, whereas the Loc property specifies the
current position. Seek always will be one more than Loc, except when a file is first opened and
Seek and Loc are both 1.
Negative Seek or 0 causes an error.
3.4.1.25 SetAttr (Panels, Comfort Panels)
Function
This method sets attribute data for a file.
Sintaxis
filesystem.SetAttr pathname, attributes
Parameters
Filesystem
Pathname
Required. String expression that specifies a file name.

Attributes
Required. Numeric expression whose sum specifies file attributes. The following table shows
the parameter settings of attributes.

vbNormal 0 Normal (default)
vbReadOnly 1 Read-only
vbHidden 2 Hidden
VbSystem 4 System file
VbArchive 32 File has changed since last backup
Return Values
None
Remarks
A run-time error occurs if you try to set the attributes of an open file.
3.4.1.26 WriteFields (Panels, Comfort Panels)
Function
This method writes data to a sequential file.
Syntax
file.WriteFields [data]
Parameters
File
Data
Variant or Variant array of numeric or string expressions to write to a file.
Prinzip
Return Values
None.

Remarks
Data written with WriteFields is usually read from a file with InputFields.
If you omit d ata, a blank line is printed to the file.
● Numeric data is always written using the period as the decimal separator.
● For Boolean data, either #TRUE# or #FALSE# is printed. The True and False keywords
are not translated, regardless of locale.
● Date data is written to the file using the universal date format. When either the date or the
time component is missing or is zero, only the component provided gets written to the file.
● Nothing is written to the file if Data is Empty. However, for Null data, #NULL# is written.
● If d ata is Null, #NULL# is written to the file.
The WriteFields method inserts commas between items and quotation marks around strings
as they are written to the file. You do not have to put explicit delimiters in the list. WriteFields
inserts a newline character—that is, a carriage return/line feed (Chr(13) + Chr(10))—after it
has written the final character in data to the file.

3.5 Modelo de objetos VBS (Panels, Comfort Panels, RT Advanced, RT Professional)
3.5 Modelo de objetos VBS (Panels, Comfort Panels, RT Advanced, RT

Professional)
3.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:

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

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.
3.5.2 Objetos (Panels, Comfort Panels, RT Advanced)
3.5.2.1 HMIRuntime (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV 6PDUW7DJV
6FUHHQ 6PDUW7DJ

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 1548)
3.5.2.2 Screens (lista) (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Esta lista contiene los objetos "Screen".

La lista contiene dos elementos, a saber:

● El primer elemento (índice 0) representa la ventana permanente.
● El segundo elemento (índice 1) representa la imagen raíz.
Estos dos elementos se pueden direccionar también con sus nombres, concretamente del
siguiente modo:
● Ventana permanente: "Overview"
● 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.
La ventana permanente "Overview" se visualiza en la lista de objetos y con la función de
completar automáticamente.
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.

3.5.2.3 Screen (Panels, Comfort Panels, RT Advanced)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Representa la imagen de proceso visualizada actualmente en el panel de operador, o bien la

ventana 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 1298)

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

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.

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

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

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

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

3.5.3 Objetos (RT Professional)
3.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.

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

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

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 2245)
Remove (Página 2240)

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

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 1968)
Name (Página 1749)
3.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"

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

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

● 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 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 2244)
Item (Página 2222)
Add (Página 2160)

3.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.
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 2265)
Stop (Página 2264)
Language (Página 1702)
Tags (Página 1856)
Logging (Página 1725)
DataSet (Página 1635)
CurrentContext (Página 1630)
MenuToolBarConfig (Página 1729)
3.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)
3.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.
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 1749)

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

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

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 1309)
AlarmLogs (lista) (Página 1306)
3.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.

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 1749)
Path (Página 1773)
3.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 la ventana

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

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

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 2240)
Activate (Página 2155)
ObjectSizeDeclutteringEnable (Página 1755)
ObjectSizeDeclutteringMax (Página 1756)
ObjectSizeDeclutteringMin (Página 1757)
LayerDeclutteringEnable (Página 1709)
Layers (Página 1710)
DataSet (Página 1635)
ExtendedZoomingEnable (Página 1655)
AccessPath (Página 1546)

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

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
Activate (Página 2155)
Layer (Página 1706)

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

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

Consulte también
Item (Página 2222)
3.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 "".

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

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

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

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

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 1329)
3.5.3.19 Tag (RT Professional)
Descripción
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ

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.

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 1749)
Value (Página 1968)
ErrorDescription (Página 1648)
LastError (Página 1705)
QualityCode (Página 1780)
TimeStamp (Página 1882)

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

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

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 1648)
LastError (Página 1705)

3.5.4 Tipos de objeto (Panels, Comfort Panels, RT Advanced, RT Professional)
3.5.4.1 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 forma parte de la lista

ScreenItems.
Identificación de tipo en VBS

HMIAlarmControl
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 Validez
Pa Panels
A RT Advanced
P RT Professional
Tabla 3-1 Propiedades
Propiedades Read. Write Descripción

Activate (Página 2068) P P Define si el servidor de avisos solicitará los datos que se van a
representar.
AlarmListType P P Determina las categorías que deben notificarse en runtime.
AllServer P P Determina que se muestren los avisos de todos los servidores
disponibles.
ApplyProjectSettings (Pági‐ P P Define si se aplica la configuración del proyecto desde el editor
na 1564) "Avisos HMI".
ApplyProjectSettingsForDesign‐ P P Determina que se utilice la configuración del proyecto para el
Mode diseño.
AutoCompleteColumns (Pági‐ P P Determina si se mostrarán las columnas vacías cuando el control
na 1567) es más ancho que las columnas configuradas.
AutoCompleteRows (Pági‐ P P Determina si se mostrarán filas vacías cuando el control sea más
na 1568) largo que el número de filas configuradas.
AutoSelectionColors (Pági‐ P P Define si el color de selección para celda y fila se realizará con
na 1569) los colores preestablecidos por el sistema.
AutoSelectionRectColor (Pági‐ P P Define si el borde de selección se representará en el color defi‐
na 1569) nido por el sistema.
BackColor (Página 1572) P P Determina el color de fondo del objeto indicado.
Blocks P P Determina los bloques de aviso.
BorderColor (Página 1589) P P Determina el color de línea del objeto.
BorderWidth (Página 1600) P P Determina el grosor de línea del objeto.
Caption (Página 1608) P P Determina el texto que se muestra en la barra de título del objeto
indicado.
CellCut (Página 1611) P P Define si el contenido de las celdas se abreviará en caso de que
las celdas sean demasiado estrechas.
CellSpaceBottom (Página 1611) P P Establece la distancia inferior que se utilizará en las celdas de
la tabla.
CellSpaceLeft (Página 1612) P P Establece la sangría izquierda que se utilizará en las celdas de
la tabla.
CellSpaceRight (Página 1612) P P Establece la sangría derecha que se utilizará en las celdas de
la tabla.
CellSpaceTop (Página 1613) P P Establece la distancia superior que se utilizará en las celdas de
la tabla.
Closeable (Página 1617) P P Determina que el control pueda cerrarse en runtime.
ColumnResize (Página 1620) P P Determina si se puede modificar el ancho de las columnas.
ColumnScrollbar (Página 1621) P P Determina el tipo de barra de desplazamiento.


ColumnTitleAlignment (Pági‐ P P Determina cómo se alinearán los títulos de columnas.
na 1624)
ColumnTitles (Página 1624) P P Determina si se debe mostrar el título de las columnas.
ControlDesignMode (Pági‐ P P Determina el diseño.
na 1831)
DefaultMsgFilterSQL P P Define un Statement SQL como estándar para el filtro de avisos.
DefaultSort P P Define la clasificación.
DefaultSort2 P P Define la clasificación.
DefaultSort2Column P P Define la clasificación.
DisplayOptions (Página 1639) P P Establece los avisos que se muestran.
DoubleClickAction (Página 1639) P P Define la acción que se realizará cuando se haga doble clic en
una fila de avisos en runtime.
ExportDirectoryChangeable (Pá‐ P P Determina si el directorio para la exportación de datos se puede
gina 1650) modificar en runtime.
ExportDirectoryname (Pági‐ P P Determina el directorio al cual se exportarán los datos de runti‐
na 1650) me.
ExportFileExtension (Pági‐ P P Establece la extensión del archivo de exportación. Hasta el mo‐
na 1651) mento solamente es compatible la extensión "csv".
ExportFilename (Página 1651) P P Determina el nombre del archivo al cual se exportarán los datos
de runtime.
ExportFilenameChangeable (Pá‐ P P Determina si el nombre del archivo de exportación se puede
gina 1652) modificar en runtime.
ExportFormatGuid (Página 1652) P P Asignación establecida por la clave ID y Export-Provider.
ExportFormatName (Pági‐ P P Determina el formato de archivo para la exportación. Actualmen‐
na 1653) te sólo está disponible el formato de archivo "csv" para la expor‐
tación.
ExportParameters (Página 1654) P P Establece los parámetros del formato seleccionado mediante el
cuadro de diálogo "Propiedades".
ExportSelection (Página 1654) P P Establece la extensión del archivo de exportación. Hasta el mo‐
mento solamente es compatible la extensión "csv".
ExportShowDialog (Página 1655) P P Determina si el cuadro de diálogo para la exportación de datos
se mostrará en runtime.
Filters P P Establece criterios en sintaxis SQL para la base de datos.
Font (Página 1669) P P Define la fuente, o la devuelve.
GridLineColor (Página 1678) P P Establece el color de las líneas de cuadrícula.
GridLineWidth (Página 1679) P P Define en píxeles el grosor de las líneas de separación.
Height (Página 1679) P P Define la altura en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
HitlistColumnAdd (Página 1686) * P P Aplica el bloque de aviso seleccionado de la lista de bloques de
aviso existentes y lo introduce en la lista de bloques de aviso
seleccionados.
HitlistColumnCount (Pági‐ P P Indica el número de bloques de aviso seleccionados, que apa‐
na 1686) * recerán en la lista de aciertos en runtime.
HitlistColumnIndex (Página 1687) P P Hace referencia a uno de los bloques de aviso seleccionados
para la lista de aciertos.
HitlistColumnName (Pági‐ P P Indica el nombre del bloque de aviso de la lista de aciertos que
na 1687) * ha sido referenciado con el atributo "HitlistColumnIndex".


HitlistColumnRemove (Pági‐ P P Elimina el bloque de aviso seleccionado de la lista de bloques
na 1688) * seleccionados y lo introduce en la lista de bloques de aviso exis‐
tentes.
HitlistColumnRepos (Pági‐ P P Modifica la secuencia de los bloques de aviso. "Arriba" y "Abajo"
na 1688) * desplazan el bloque de aviso seleccionado en la lista.
HitlistColumnSort (Página 1689) * P P Establece cómo se clasificará en la lista de aciertos el bloque de
aviso referenciado en "HitlistColumnIndex".
HitlistColumnSortIndex (Pági‐ P P Indica la secuencia de clasificación del bloque de aviso de la
na 1689) * lista de aciertos referenciado en "HitlistColumnIndex".
HitlistColumnVisible (Pági‐ P P En la lista se mostrarán los bloques de aviso seleccionados de
na 1690) * la lista de avisos o de la lista de aciertos que se utilizarán en el
control en runtime.
HitListDefaultSort (Página 1690) P P Define la clasificación predeterminada en las columnas de la
tabla de la lista de aciertos.
HitListMaxSourceItems (Pági‐ P P Establece el número máximo de registros que se utilizan del fi‐
na 1691) chero de avisos para la creación de la lista de aciertos.
HitListMaxSourceItemsWarn (Pá‐ P P Determina si se mostrará una advertencia cuando se alcance el
gina 1691) número máximo de registros especificado en "HitlistMaxSour‐
ceItems".
HitListRelTime (Página 1693) P P Determina si se utilizará el intervalo de tiempo para la estadísti‐
ca.
HitListRelTimeFactor P P Establece el factor de tiempo que, con el tipo de tiempo "Hitlis‐
tRelativeTimeFactorType", determina el período para el que se
crea la estadística de la lista de aciertos.
HitListRelTimeFactorType P P Establece el tipo de tiempo que, con el factor de tiempo "Hitlis‐
tRelativeTimeFactor", determina el período para el que se crea
la estadística de la lista de aciertos.
HorizontalGridLines (Pági‐ P P Determina si se deben visualizar líneas horizontales.
na 1694)
IconSpace (Página 1697) P P Establece la distancia entre símbolo y texto en las celdas de la
tabla.
Layer (Página 1706) P P Dentro de la imagen, devuelve como LONG el nivel en el que se
encuentra un objeto.
Left (Página 1710) P P Define el valor de la coordenada X del objeto.
LineColor (Página 1721) P P Indica el color para las líneas de separación de la ventana.
LineWidth (Página 1723) P P Determina el grosor de línea del objeto indicado.
LongTermArchiveConsistency P P Si se ajusta "LongTimeArchiveConsistency" a "no", se muestran
(Página 1726) 1000 avisos en la lista de ficheros de largo plazo en el mono‐
puesto, en el servidor o en el cliente por servidor o por pareja de
servidores redundantes.
MessageBlockAlign (Pági‐ P P Determina cómo se van a alinear los contenidos del bloque de
na 1729) * aviso seleccionado en la tabla.
MessageBlockAutoPrecisions P P Determina si la cantidad de decimales se debe determinar auto‐
(Página 1730) * máticamente.
MessageBlockCaption (Pági‐ P P Establece el título de la columna en el visor de avisos para el
na 1730) * bloque de aviso seleccionado.
MessageBlockCount (Pági‐ P P Indica el número de bloques de aviso existentes que están dis‐
na 1731) ponibles para la lista de avisos y la lista de aciertos.


MessageBlockDateFormat (Pági‐ P P Determina qué formato de fecha se debe utilizar para los avisos.
na 1731) *
MessageBlockExponentialFor‐ P P Determina si los valores del bloque de aviso seleccionado se
mat (Página 1732) * mostrarán en representación exponencial.
MessageBlockFlashOn (Pági‐ P P Establece si el contenido del bloque de aviso seleccionado par‐
na 1732) * padeará en runtime cuando aparezca un aviso.
MessageBlockHideText (Pági‐ P P Determina si el contenido del bloque de aviso seleccionado se
na 1733) * mostrará en forma de texto.
MessageBlockHideTitleText (Pá‐ P P Determina si el título del bloque de aviso seleccionado se mos‐
gina 1733) * trará en forma de texto.
MessageBlockId (Página 1734) P P Asignación establecida por la clave ID y el bloque de aviso en
el visor de avisos.
MessageBlockIndex (Pági‐ P P Hace referencia a un bloque de aviso ya existente.
na 1734)
MessageBlockLeadingZeros (Pá‐ P P Determina si el formato del bloque de aviso seleccionado se
gina 1735) * mostrará con ceros a la izquierda.
MessageBlockLength (Pági‐ P P Establece la longitud en caracteres para el contenido del bloque
na 1735) * de aviso seleccionado.
MessageBlockName (Pági‐ P P Muestra el nombre para el bloque de aviso seleccionado.
na 1736)
MessageBlockPrecisions (Pági‐ P P Define el número de decimales de los valores del bloque de aviso
na 1736) * seleccionado.
MessageBlockSelected (Pági‐ P P Los bloques de aviso existentes son bloques que están disponi‐
na 1736) * bles para la lista de avisos o la lista de aciertos en el control en
runtime.
MessageBlockShowDate (Pági‐ P P Establece si en el bloque de aviso "Hora" se mostrará la fecha
na 1737) * junto con la hora.
MessageBlockShowIcon (Pági‐ P P Determina si el contenido del bloque de aviso seleccionado se
na 1737) * mostrará en forma de símbolo.
MessageBlockShowTitleIcon P P Determina si el título del bloque de aviso seleccionado se mos‐
(Página 1738) * trará en forma de texto.
MessageBlockTextId (Pági‐ P P Define el nombre del bloque de aviso seleccionado con ayuda
na 1738) de un ID de texto obtenido en la librería de textos.
MessageBlockTimeFormat (Pági‐ P P Determina qué formato de tiempo o de duración se debe utilizar
na 1739) * para visualizar los avisos.
MessageColumnAdd (Pági‐ P P Aplica el bloque de aviso marcado de la lista de bloques de aviso
na 1740) * existentes y lo introduce en la lista de bloques de aviso selec‐
cionados.
MessageColumnCount (Pági‐ P P Indica el número de bloques de aviso seleccionados, que apa‐
na 1741) * recerán en la lista de avisos en runtime.
MessageColumnIndex (Pági‐ P P Hace referencia a uno de los bloques de aviso seleccionados
na 1741) para la lista de avisos.
MessageColumnName (Pági‐ P P Indica el nombre del bloque de aviso de la lista de avisos refe‐
na 1742) * renciado con la propiedad "MessageColumnIndex".
MessageColumnRemove (Pági‐ P P Elimina el bloque de aviso seleccionado de la lista de bloques
na 1742) * seleccionados y lo introduce en la lista de bloques de aviso exis‐
tentes.
MessageColumnRepos (Pági‐ P P Modifica la secuencia de los bloques de aviso. "Arriba" y "Abajo"
na 1743) * desplazan el bloque de aviso seleccionado en la lista.


MessageColumnSort (Pági‐ P P Establece cómo se clasificará el bloque de aviso referenciado
na 1743) * en "MessageColumnIndex".
MessageColumnSortIndex (Pági‐ P P Indica la secuencia de clasificación del bloque de aviso referen‐
na 1744) * ciado en "MessageColumnIndex".
MessageColumnVisible (Pági‐ P P En la lista se muestran los bloques de aviso seleccionados de
na 1744) * la lista de avisos o la lista de aciertos que se utilizan en el visor
de avisos en runtime.
Moveable (Página 1748) P P Determina si la ventana puede moverse en runtime.
MsgFilterSQL (Página 1748) P P Define uno o varios Statements SQL para la selección persona‐
lizada de los avisos.
Name (Página 1749) P P Devuelve el nombre de objeto como STRING.
OperatorAlarms P P Define los ajustes para los avisos de operador.
OperatorMessageId (Pági‐ P P Asignación establecida por la clave ID y el evento de activación
na 1758) * en el visor de avisos.
OperatorMessageIndex (Pági‐ P P Hace referencia al evento de aviso para un aviso de operador.
na 1759) *
OperatorMessageName (Pági‐ P P Indica el nombre referenciado con el evento "OperatorMessa‐
na 1760) * geIndex" en eventos para avisos de operador.
OperatorMessageNumber (Pági‐ P P Determine un número de aviso para el aviso de operador del
na 1760) * evento de aviso seleccionado si no utiliza el aviso de operador
de WinCC.
OperatorMessageSelected (Pági‐ P P Active los eventos de aviso en la lista en la que se habilitarán
na 1761) * los avisos de operador.
OperatorMessageSource1 (Pági‐ P P Determine un bloque de aviso para el aviso utilizado, que se
na 1761) * añadirá al "Bloque de valor de proceso 1" del aviso de operador
configurado aquí.
OperatorMessageSource10 (Pá‐ P P Determine un bloque de aviso para el aviso utilizado, que se
gina 1766) * añadirá al "Bloque de valor de proceso 10" del aviso de operador
configurado aquí.
configurado aquí.
configurado aquí.
configurado aquí.
configurado aquí.
configurado aquí.
configurado aquí.


configurado aquí.
configurado aquí.
OperatorMessageSourceType1 P P Define en qué formato se transferirá el contenido del origen.
(Página 1767) *
(Página 1771) *
(Página 1767) *
(Página 1768) *
(Página 1768) *
(Página 1769) *
(Página 1769) *
(Página 1770) *
(Página 1770) *
(Página 1771) *
PageMode (Página 1772) P P Determina la orientación de la página (vertical/horizontal).
PageModeMessageNumber (Pá‐ P P Define la cantidad de avisos que se mostrarán por página cuan‐
gina 1772) do se pase de página en la lista de ficheros a largo plazo.
PrintJob P P Determina un trabajo de impresión.
RowScrollbar (Página 1788) P P Determina si las barras de desplazamiento de filas se deben
visualizar.
RowTitleAlignment P P Determina cómo se alinearán los títulos de las filas.
RowTitles P P Determina que se muestren los encabezados de las filas.
RTPersistence (Página 1789) P P Establece cómo se conservarán las configuraciones online de
WinCC.
RTPersistenceAuthorization (Pá‐ P P Determina la autorización que es necesaria en runtime para la
gina 2045) configuración online.
RTPersistenceType (Pági‐ - - Establece cómo se conservarán las configuraciones online de
na 1790) WinCC.
SelectedCellColor (Página 1802) P P Indica el color de fondo de las celdas marcadas.
SelectedCellForeColor (Pági‐ P P Indica el color de fuente de las celdas marcadas.
na 1802)
SelectedRowColor (Página 1804) P P Indica el color de fondo de las filas marcadas.
SelectedRowForeColor (Pági‐ P P Indica el color de fuente de las filas marcadas.
na 1804)
SelectedTitleColor (Página 1805) P P Indica el color de fondo del título de tabla seleccionado.


SelectedTitleForeColor (Pági‐ P P Indica el color de fuente del título de tabla seleccionado.
na 1806)
SelectionColoring (Página 1808) P P Determina si se utilizarán colores de selección para celdas o
filas.
SelectionRect (Página 1809) P P Determina si se utilizará un borde de selección para las celdas
o filas seleccionadas.
SelectionRectColor (Pági‐ P P Define el color del rectángulo de selección en la ventana de avi‐
na 1810) sos cuando SelectionType sea "1".
SelectionRectWidth (Pági‐ P P Establece el grosor de la línea del rectángulo de selección en la
na 1811) ventana de avisos cuando SelectionType sea "1".
SelectionType (Página 1811) P P Determina cuántas líneas pueden seleccionarse.
ServerNames (Página 1815) P P Establece los servidores de un sistema distribuido de los que
recibe datos el visor de avisos.
ShowSortButton (Página 1824) P P Determina si se mostrará la tecla de clasificación en la barra de
desplazamiento vertical.
ShowSortIcon (Página 1825) P P Determina si se debe mostrar el símbolo de clasificación.
ShowSortIndex (Página 1825) P P Determina si se debe mostrar el símbolo de clasificación.
ShowTitle (Página 1828) P P Determina si se visualiza el título de la ventana del control.
Sizeable (Página 1830) P P Determina si puede modificarse el tamaño del objeto en runtime.
SortSequence (Página 1832) P P Determina cómo se puede modificar la secuencia de clasifica‐
ción haciendo clic con el ratón.
StatusbarBackColor (Pági‐ P P Indica el color de fondo para la barra de estado.
na 1835)
StatusbarElementAdd (Pági‐ P P Crea un nuevo elemento de la barra de estado definido por el
na 1836) * usuario.
StatusbarElementAutoSize (Pági‐ P P Establece si el ancho del elemento seleccionado de la barra de
na 1836) * estado se ajustará automáticamente.
StatusbarElementCount (Pági‐ P P Indica el número de elementos configurables de la barra de es‐
na 1837) * tado.
StatusbarElementIconId (Pági‐ P P Asignación establecida por la clave ID y el símbolo de un ele‐
na 1838) * mento de la barra de estado.
StatusbarElementId (Pági‐ P P Clave ID unívoca para el elemento seleccionado de la barra de
na 1838) * estado.
StatusbarElementIndex (Pági‐ P P Hace referencia a un elemento de la barra de estado. Esta pro‐
na 1839) piedad permite asignar los valores de otras propiedades a un
elemento determinado de la barra de estado.
StatusbarElementName (Pági‐ P P Muestra el nombre de objeto para el elemento seleccionado de
na 1840) * la barra de estado.
StatusbarElementRemove (Pági‐ P P Elimina el elemento seleccionado de la barra de estado.
na 1840) *
StatusbarElementRename (Pági‐ P P Modifica el nombre del elemento de la barra de estado definido
na 1841) * por el usuario que está referenciado mediante la propiedad "Sta‐
tusbarElementIndex".
StatusbarElementRepos * P P Determina el índice que debe asignarse al elemento.
StatusbarElements (Página 1841) - - Define los elementos que deben mostrarse en la barra de esta‐
do.
StatusbarElementText * P P Define el texto del elemento de la barra de estado seleccionado
actualmente.


StatusbarElementTooltipText P P Determina el texto para el tooltip del elemento de la barra de
(Página 1842) * estado definido por el usuario.
StatusbarElementUserDefined P P Indica si el elemento de la barra de estado ha sido añadido por
(Página 1842) * el ingeniero como nuevo elemento definido por el usuario.
StatusbarElementVisible (Pági‐ P P En la lista, active los elementos de la barra de estado que desee
na 1843) * mostrar en runtime.
StatusbarElementWidth (Pági‐ P P Indica el ancho del elemento seleccionado de la barra de estado
na 1844) * en píxeles.
StatusbarFont - - Fuente de barra de estado
StatusbarFontColor (Pági‐ P P Indica el color de fuente de los textos de la barra de estado.
na 1844)
StatusbarShowTooltips (Pági‐ P P Determina si en runtime se mostrarán los tooltips de los elemen‐
na 1845) tos de la barra de estado.
StatusbarText (Página 1846) P P Texto definido en la barra de estado
StatusbarUseBackColor (Pági‐ P P Determina si se debe visualizar el color de fondo de la barra de
na 1846) estado.
StatusbarVisible (Página 1847) P P Determina si se debe visualizar la barra de estado del control.
TableColor P P Indica el color de fondo para las filas. Con el botón se abre el
cuadro de diálogo para la selección de color.
TableColor2 P P Indica el color de fondo del "Color de fila 2".
TableForeColor P P Indica el color de fuente de "Color de fila".
TableForeColor2 P P Indica el color de fuente del "Color de fila 2".
TimeBase (Página 1866) P P Define la base de tiempo.
TitleColor P P Define el color de la barra de título.
TitleCut P P Determina si los contenidos de los campos de una barra de título
deben acortarse cuando el ancho de columna sea insuficiente.
TitleDarkShadowColor P P Indica el color para la parte oscura del sombreado.
TitleForeColor P P Indica el color de fuente del título de la tabla para el estado se‐
leccionado.
TitleGridLineColor P P Indica el color de las líneas de separación en el título de la tabla.
TitleLightShadowColor P P Indica el color para la parte clara del sombreado.
TitleSort P P Determina cómo se inicia la clasificación por título de columna.
TitleStyle P P Determina qué color de sombreado se usa para el título de tabla.
ToolbarAlignment P P Define la posición de la barra de herramientas, o la devuelve.
ToolbarBackColor P P Indica el color de fondo de la barra de herramientas.
ToolbarButtonActive * P P Establece si la función enlazada con la tecla está activada en
runtime.
ToolbarButtonAdd * P P Establece una nueva función de teclas definida por el usuario.
ToolbarButtonBeginGroup * P P Determina si se añadirá un separador antes de la función de
teclas seleccionada.
ToolbarButtonClick P P Hace clic en un botón de la barra de herramientas.
ToolbarButtonCount * P P Indica el número de funciones de tecla configurables.
ToolbarButtonEnabled * P P Determina si se puede utilizar la tecla definida por el usuario de
la barra de herramientas.
ToolbarButtonHotKey * P P Muestra la tecla de acceso directo para la función de tecla se‐
leccionada.


ToolbarButtonId * P P Clave ID única para la función de tecla seleccionada.
ToolbarButtonIndex P P Hace referencia a una función de tecla.
ToolbarButtonLocked * P P Determina si para una tecla de la barra de herramientas definida
por el usuario, se mostrará el estado pulsado (encajado) de la
tecla.
ToolbarButtonName * P P Muestra el nombre para la función de tecla seleccionada.
ToolbarButtonPasswordLevel * P P Muestra el permiso para la función de tecla seleccionada.
ToolbarButtonRemove * P P Elimina la función de tecla seleccionada de la lista.
ToolbarButtonRename * P P Modifica el nombre del elemento de la barra de herramientas
definido por el usuario que está referenciado mediante la pro‐
piedad "ToolbarButtonIndex".
ToolbarButtonRepos * P P Modifica la secuencia de las funciones de tecla.
ToolbarButtons - - Determina los botones que están disponibles para la barra de
herramientas.
ToolbarButtonTooltipText * P P Establece el texto para el tooltip de la tecla.
ToolbarButtonUserDefined * P P Muestra si la tecla de la barra de herramientas ha sido añadida
por el ingeniero como tecla nueva definida por el usuario.
ToolbarButtonVisible * P P Determina que el botón sea visible.
ToolbarShowTooltips P P Determina si en runtime se mostrarán los tooltips de las funcio‐
nes de tecla.
ToolbarUseBackColor P P Determina si se debe visualizar el color de fondo de la barra de
herramientas.
ToolbarUseHotKeys P P Determina si las teclas de acceso directo están activas para las
funciones de tecla en runtime.
ToolbarVisible P P Determina si se debe visualizar la barra de herramientas del
control.
Top (Página 1909) P P Define el valor de la coordenada Y del objeto.
UseMessageColor (Página 1958) P P Determina si está activado el desplazamiento.
UseSelectedTitleColor (Pági‐ P P Determina si se utilizará un color de selección para los títulos de
na 1958) tabla de celdas seleccionadas.
UseTableColor2 (Página 1959) P P Determina si se utilizará un segundo color de fila en la represen‐
tación de la tabla.
VerticalGridLines (Página 1972) P P Determina si se deben visualizar líneas verticales.
Visible (Página 1973) P P Determina si el objeto indicado es visible.
Width (Página 1983) P P Define el ancho en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
* No visible en el ES
Tabla 3-2 Métodos
Métodos Validez Descripción

Activate (Página 2155) P, A Activa la ventana permanente o bien la imagen raíz.
ActivateDynamic (Página 2158) P Activa dinámicamente un disparador y el ciclo fijado para una propiedad
durante el runtime.
AttachDB (Página 2162) P, A Ejecuta la función del botón "Conectar copia de seguridad" del control.


CopyRows (Página 2163) P Ejecuta la función del botón "Copiar filas" del control.
DeactivateDynamic (Página 2165) P Desactiva en/durante el runtime el disparador usado del método "Activa‐
teDynamic" para la propiedad fijada.
DetachDB (Página 2168) P, A Ejecuta la función del botón "Desconectar copia de seguridad" del control.
Export (Página 2169) P, A Ejecuta la función del botón "Exportar fichero" o "Exportar datos" del con‐
trol.
GetHitlistColumnCollection (Pági‐ P Devuelve el listado de todos los objetos de columna de la lista de aciertos
na 2171) del visor de avisos como tipo "ICCAxCollection".
GetHitlistColumn (Página 2173) P Devuelve el objeto de columna designado por nombre o índice de la lista
de aciertos del visor de avisos como tipo "ICCAxMessageColumn".
GetMessageBlock (Página 2174) P Devuelve el objeto de bloque de aviso designado por nombre o índice
del visor de avisos como tipo "ICCAxMessageBlock".
GetMessageBlockCollection (Pági‐ P Devuelve el listado de todos los objetos de bloque de aviso del visor de
na 2175) avisos como tipo "ICCAxCollection".
GetMessageColumn (Página 2176) P Devuelve el objeto de columna designado por nombre o índice del visor
de avisos como tipo "ICCAxMessageColumn".
GetOperatorMessage (Pági‐ P Devuelve el objeto de aviso de operador designado por nombre o índice
na 2177) del visor de avisos como tipo "ICCAxOperatorMessage".
GetMessageColumnCollection (Pá‐ P Devuelve el listado de todos los objetos de columna del visor de avisos
gina 2178) como tipo "ICCAxCollection".
GetOperatorMessageCollection P Devuelve el listado de todos los objetos de aviso de operador del visor
(Página 2179) de avisos como tipo "ICCAxCollection".
GetRow (Página 2180) P Devuelve el objeto de filas designado mediante el número de fila de los
controles basados en tablas como tipo "ICCAxDataRow".
GetRowCollection (Página 2182) P Devuelve el listado de todos los objetos de filas de los controles basados
en tablas como tipo "ICCAxDataRowCollection".
GetSelectedRow (Página 2188) P Devuelve como tipo "ICCAxDataRow" el objeto de filas seleccionado de
un control basado en tablas.
GetSelectedRows (Página 2189) P Con selección múltiple, devuelve como tipo "ICCAxDataRow" los objetos
de filas seleccionados de un control basado en tablas.
GetStatusbarElement (Pági‐ P, A Devuelve el elemento de la barra de estado designado por nombre o
na 2195) índice del control como tipo "ICCAxStatusbarElement".
GetStatusbarElementCollection P, A Devuelve el listado de todos los elementos de la barra de estado del
(Página 2196) control como tipo "ICCAxCollection".
GetToolbarButton (Página 2203) P, A Devuelve la función de tecla designada por nombre o índice de la barra
de herramientas del control como tipo "ICCAxToolbarButton".
GetToolbarButtonCollection (Pági‐ P, A Devuelve el listado de todas las funciones de tecla de la barra de herra‐
na 2205) mientas del control como tipo "ICCAxCollection".
HideAlarm (Página 2221) P Ejecuta la función del botón "Ocultar aviso" del visor de avisos.
LockAlarm (Página 2223) P Ejecuta la función del botón "Bloquear aviso" del visor de avisos.
LoopInAlarm (Página 2224) P Ejecuta la función del botón "Loop in Alarm" del visor de avisos.
MoveToFirstLine (Página 2225) P Ejecuta la función del botón "Primer aviso" del visor de avisos.
MoveToFirstPage (Página 2226) P Ejecuta la función del botón "Primera página" del visor de avisos.
MoveToLastLine (Página 2227) P Ejecuta la función del botón "Último aviso" del visor de avisos.
MoveToLastPage (Página 2227) P Ejecuta la función del botón "Última página" del visor de avisos.
MoveToNextLine (Página 2228) P Ejecuta la función del botón "Aviso siguiente" del visor de avisos.
MoveToNextPage (Página 2229) P Ejecuta la función del botón "Página siguiente" del visor de avisos.


MoveToPreviousLine (Pági‐ P Ejecuta la función del botón "Aviso anterior" del visor de avisos.
na 2230)
MoveToPreviousPage (Pági‐ P Ejecuta la función del botón "Página anterior" del visor de avisos.
na 2230)
Print (Página 2234) P, A Ejecuta la función del botón "Imprimir" del control.
QuitHorn (Página 2234) P Ejecuta la función del botón "Acuse de avisador central" del visor de avi‐
sos.
QuitSelected (Página 2235) P Ejecuta la función del botón "Acuse individual" del visor de avisos.
QuitVisible (Página 2235) P Ejecuta la función del botón "Acuse de grupo" del visor de avisos.
SelectAll (Página 2248) P Selecciona todas las filas en un control basado en tablas.
SelectRow (Página 2249) P Selecciona una determinada fila en un control basado en tablas.
ShowComment (Página 2252) P Ejecuta la función del botón "Diálogo de comentario" del visor de avisos.
ShowDisplayOptionsDialog (Pági‐ P Ejecuta la función del botón "Diálogo de opciones de visualización" del
na 2252) visor de avisos.
ShowEmergencyQuitDialog (Pági‐ P Ejecuta la función del botón "Acuse de emergencia" del visor de avisos.
na 2253)
ShowHelp (Página 2253) P, A Ejecuta la función del botón "Ayuda" del control.
ShowHideList (Página 2254) P Ejecuta la función del botón "Lista de los avisos a ocultar" del visor de
avisos.
ShowHitList (Página 2254) P Ejecuta la función del botón "Lista de aciertos" del visor de avisos.
ShowInfoText (Página 2255) P Ejecuta la función del botón "Diálogo de texto informativo" del visor de
avisos.
ShowLockDialog (Página 2255) P Ejecuta la función del botón "Diálogo de bloqueos" del visor de avisos.
ShowLockList (Página 2256) P Ejecuta la función del botón "Lista de inhibiciones" del visor de avisos.
ShowLongTermArchiveList (Pági‐ P Ejecuta la función del botón "Lista de ficheros de largo plazo" del visor
na 2256) de avisos.
ShowMessageList (Página 2257) P Ejecuta la función del botón "Lista de avisos" del visor de avisos.
ShowPropertyDialog (Página 2258) P, A Ejecuta la función del botón "Diálogo de configuración" del control.
ShowSelectionDialog (Pági‐ P Ejecuta la función del botón "Diálogo de selección" del visor de avisos.
na 2259)
ShowShortTermArchiveList (Pági‐ P Ejecuta la función del botón "Lista de ficheros de corto plazo" del visor
na 2260) de avisos.
ShowSortDialog (Página 2261) P Ejecuta la función del botón "Diálogo de ordenación" del visor de avisos.
ShowTimebaseDialog (Pági‐ P Ejecuta la función del botón "Diálogo de base de tiempo" del visor de
na 2262) avisos.
UnhideAlarm (Página 2265) P Ejecuta la función del botón "Mostrar aviso" del visor de avisos.
UnlockAlarm (Página 2266) P Ejecuta la función del botón "Habilitar aviso" del visor de avisos.
UnselectAll (Página 2266) P Elimina todas las marcas de las celdas de un control basado en tablas.
UnselectRow (Página 2267) P Elimina las marcas de una determinada celda de un 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 MessageView forma parte de la lista

ScreenItems.
Si se modifican los ajustes de este objeto con una función definida por el 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.
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional
Propiedades Read Write Descripción

AlarmAreaHeight **
AlarmAreaWidth **
AlarmClasses - - Determina las categorías que deben notificarse en runtime.


AlarmLog - - Determina qué tipos de avisos se muestran en el visor de avisos.
AlarmSource - - Determina que se muestren avisos.
Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en runti‐
me.
BackColor A A Determina el color de fondo del objeto indicado.
ButtonBarElements ** Determina que se muestren botones.
ButtonBarStyle - -
Columns - - Determina qué columnas se muestran.
ColumnsMoveable - - Determina que las columnas sean movibles.
ColumnTextAckGroup - - Determina el título de la columna "AckGroup".
ColumnTextAlarmState - - Determina el título de la columna "State".
ColumnTextAlarmText - - Determina el título de la columna "Text".
ColumnTextClassName - - Determina el título de la columna "Class Name".
ColumnTextDate - - Determina el título de la columna "Date".
ColumnTextDevice - - Determina el título de la columna "Device".
ColumnTextDiagnosable - - Determina el título de la columna "Diagnosable".
ColumnTextNumber - - Determina el título de la columna "Number".
ColumnTextTime - - Determina el título de la columna "Time".
CountOfLinesPerAlarms - -
CountOfVisibleAlarms - -
Enabled A A Determina si el objeto indicado se puede manejar en runtime.
FilterTag ** Determina la variable del tipo String para el filtrado de textos de
aviso.
FilterText ** Determina el texto para el filtrado del texto de aviso.
FitToSize - - Determina que el tamaño del objeto se adapte automáticamente
al contenido.
Flashing - - Determina que el bloque de texto parpadee.
FocusColor A A Determina el color del borde del objeto indicado cuando está re‐
saltado dicho objeto.
FocusWidth A A Determina el ancho del borde del objeto indicado cuando está
resaltado dicho objeto.
ForeColor - - Establece el color de fuente del texto del objeto indicado.
GridlineColor A A Establece el color de las líneas de cuadrícula.
Height (Página 1679) A A Define la altura en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
HorizontalScrollingEnabled - -
IsRunningUnderCE * - -
Layer (Página 1706) - - Dentro de la imagen, devuelve como LONG el nivel en el que se
Left (Página 1710) A A Define el valor de la coordenada X del objeto.
LineAlarmView **
Name (Página 1749) A A Devuelve el nombre de objeto como STRING.
PreferredUseOnAck - -
S7Device - -


SecurityForSimpleViewEnabled
**
SelectionBackColor (Pági‐ A A Determina el color de fondo de las celdas seleccionadas.
na 1807)
SelectionForeColor (Pági‐ A A Determina el color de primer plano de las celdas seleccionadas.
na 1809)
SeparateLineForAlarmText - -
ShowAcknowledgeButton - -
ShowAlarmsFromDate (Pági‐ A A Establece que sólo se muestren los eventos de aviso que estén
na 1816) guardados en esa variable.
ShowAlarmsToAcknowledge - - Determina que se muestren avisos sin acusar.
ShowColumnHeaders - -
ShowHelpButton - -
ShowHorizontalGridlines - -
ShowLoopInAlarmButton - - Determina que se muestre el botón "Loop In Alarm".
ShowMilliseconds - - Determina que se muestre el tiempo en milisegundos.
ShowPendingAlarms - -
SortByTimeDirection (Pági‐ - - Determina si el último aviso aparecido se mostrará arriba en el
na 1831) objeto "AlarmControl".
SortByTimeEnabled (Pági‐ A A Determina si puede modificarse la clasificación de los avisos por
na 2051) hora en el objeto "AlarmControl".
TableBackColor (Página 1849) A A Determina el color de fondo de las celdas de la tabla del objeto
indicado.
TableFont - - Define la fuente en la tabla.
TableForeColor A A Indica el color de fuente de "Color de fila".
TableHeaderBackColor (Pági‐ A A Define el color de fondo del encabezado de la tabla del objeto
na 1854) indicado.
TableHeaderFont - - Define el color de texto del título.
TableHeaderForeColor (Pági‐ A A Define el color de texto del encabezado de la tabla del objeto
na 1854) indicado.
Top (Página 1909) A A Define el valor de la coordenada Y del objeto.
VerticalScrollBarEnabled - -
VerticalScrollingEnabled - -
ViewType - - Determina el tipo de visor de avisos.
ViewTypeForSaveStream ** Determina el tipo de visor para el Save Stream.
Visible (Página 1973) * A A Determina si el objeto indicado es visible.
Width (Página 1983) A A Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
* No visible en ES. ** Sin información al respecto

Tabla 3-4 Métodos
Métodos Val. Descripción

Activate (Página 2155) ??? Activa la ventana permanente o bien la imagen raíz.
???
Bar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Barra". El objeto Bar forma parte de la lista ScreenItems.


HMIBar
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional

AlarmLowerLimit (Página 1557) P P Establece el valor límite inferior con el que se dispara la alarma.
AlarmLowerLimitColor (Pági‐ P P Define el color de la barra para el valor límite "AlarmLowerLimit".
na 1557)
AlarmLowerLimitEnabled (Pági‐ P P Determina si se vigila el valor límite "AlarmLowerLimit".
na 1558)
AlarmLowerLimitRelative (Pági‐ P P Determina si el valor límite inferior con el que se dispara la alarma
na 1558) se evaluará de forma porcentual o absoluta.
AlarmUpperLimit (Página 1559) P P Establece el valor límite superior con el que se disparará la alarma.
AlarmUpperLimitColor (Pági‐ P P Define el color de la barra para el valor límite "AlarmUpperLimit".
na 1560)
AlarmUpperLimitEnabled (Pági‐ P P Determina si se vigilará el valor límite "AlarmUpperLimit".
na 1560)
AlarmUpperLimitRelative (Pági‐ P P Determina si el valor límite superior con el que se dispara la alarma
na 1561) se evaluará de forma porcentual o absoluta.
Authorization (Página 1566) P P Determina los derechos de manejo del objeto indicado en runtime.
AverageLast15Values P P Determina que se muestre la media de los últimos 15 valores.
BackColor (Página 1572) P, A P, A Determina el color de fondo del objeto indicado.
BackFillStyle (Página 1575) P P Define el patrón de relleno del objeto indicado.
BackFlashingColorOff (Pági‐ P P Define el color de fondo para el estado de parpadeo "Off".
na 1576) *
BackFlashingColorOn (Pági‐ P P Define el color de fondo para el estado de parpadeo "On".
na 1577) *
BackFlashingEnabled (Pági‐ P P Determina si el fondo del objeto indicado parpadea en runtime.
na 1578) *
BackFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo del fondo del objeto indicado.
na 1579) *
BarBackColor (Página 1580) P, A P, A Define el color del fondo de barra en el objeto indicado.
BarBackFillStyle (Página 1580) P P Define el patrón de relleno de la barra.
BarBackFlashingColorOff - - Define el color de fondo del marco del objeto para el estado "Off".
BarBackFlashingColorOn - - Define el color de fondo del marco del objeto para el estado "On".
BarBackFlashingEnabled - -
BarBackFlashingRate - - Determina la frecuencia de parpadeo del fondo.
BarEdgeStyle - - Determina el estilo de la línea del borde.
BarOrientation P P Define la alineación de la barra.


BorderBackColor (Página 1587) P P Define el color de fondo de la línea de borde quebrada del objeto
indicado.
BorderFlashingColorOff (Pági‐ P P Determina el color de la línea de borde del objeto indicado para el
na 1592) estado de parpadeo "Off".
BorderFlashingColorOn (Pági‐ P P Determina el color de la línea de borde del objeto indicado para el
na 1593) estado de parpadeo "On".
BorderFlashingEnabled (Pági‐ P P Determina si la línea de borde del objeto indicado parpadea en
na 1594) runtime.
BorderFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo de la línea de borde del ob‐
na 1595) jeto indicado.
BorderStyle (Página 1599) P P Determina el tipo de líneas de borde del objeto indicado.
BorderStyle3D - - Determina si el objeto posee un sombreado de borde 3D.
ColorChangeHysteresis (Pági‐ P P Determina la histéresis de forma porcentual al valor de visualiza‐
na 1618) ción.
ColorChangeHysteresisEnabled P P Determina si se muestra el objeto con histéresis.
(Página 1619)
CornerStyle (Página 1627) P P Determina el tipo de líneas de borde del objeto indicado.
CountDivisions (Página 1629) P P Determina el número de segmentos en los que se subdivide la
barra mediante las marcas grandes de la escala.
CountSubDivisions (Pági‐ A A Define el número de marcas de la escala entre dos marcas princi‐
na 1629) pales del objeto "Bar".
DrawInsideFrame (Página 1640) P P Determina si la línea del borde del objeto indicado se traza dentro
del borde o simétricamente respecto al borde a partir de un grosor
de línea superior a 1.
EdgeStyle (Página 1641) P P Establece el estilo de línea del objeto indicado.
Enabled (Página 1644) P P Determina si el objeto indicado se puede manejar en runtime.
FillPatternColor (Página 1657) P P Establece el color del patrón de relleno del objeto indicado.
FlashingColorOff (Página 1661) - - Determina el color de la línea de borde del objeto indicado para el
* estado de parpadeo "Off".
FlashingColorOn (Página 1663) - - Determina el color de la línea de borde del objeto indicado para el
* estado de parpadeo "On".
FlashingEnabled (Página 1664) - - Determina si la línea de borde del objeto indicado parpadea en
* runtime.
FlashingOnLimitViolation - - Determina que se active el parpadeo en caso de infracción de
límite.
FlashingRate (Página 1665) * - - Determina la frecuencia de parpadeo de la línea de borde del ob‐
jeto indicado.
Font (Página 1669) - - Define la fuente, o la devuelve.
FontBold (Página 1671) P P Determina si el texto del objeto indicado se muestra en negrita.
FontName (Página 1672) P P Establece la fuente del objeto indicado.
FontSize (Página 1673) P P Establece el tamaño de fuente del texto del objeto indicado.
ForeColor (Página 1674) P, A P, A Establece el color de fuente del texto del objeto indicado.
Height (Página 1679) P, A P, A Define la altura en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".


IntegerDigits (Página 1700) P P, A Define el número de dígitos antes de la coma (de 0 a 20).
LargeTickLabelingStep - - Define qué secciones de la escala llevan rotulación.
LargeTicksBold (Página 1703) P P Determina si las marcas largas de una escala se muestran en ne‐
grita.
LargeTicksSize (Página 1703) P P Define la longitud de las marcas largas de una escala.
Left (Página 1710) P, A P, A Define el valor de la coordenada X del objeto.
Limit4LowerLimit (Página 1711) P P Establece el valor límite inferior para "Reserve4".
Limit4LowerLimitColor (Pági‐ P P Define el color del valor límite inferior "Reserve4".
na 1712)
Limit4LowerLimitEnabled (Pági‐ P P Determina si se vigilará el valor límite inferior "Reserve4".
na 1712)
Limit4LowerLimitRelative (Pági‐ P P Determina si el valor límite inferior "Reserve4" se evaluará de for‐
na 1713) ma porcentual o absoluta.
Limit4UpperLimit (Página 1714) P P Establece el valor límite superior para "Reserve4".
Limit4UpperLimitColor (Pági‐ P P Define el color del valor límite superior "Reserve4".
na 1714)
Limit4UpperLimitEnabled (Pági‐ P P Determina si se vigilará el valor límite superior "Reserve4".
na 1715)
Limit4UpperLimitRelative (Pági‐ P P Determina si el valor límite superior "Reserve4" se evaluará de
na 1715) forma porcentual o absoluta.
Limit5LowerLimit (Página 1716) P P Establece el valor límite inferior para "Reserve5".
Limit5LowerLimitColor (Pági‐ P P Define el color del valor límite inferior "Reserve5".
na 1716)
Limit5LowerLimitEnabled (Pági‐ P P Determina si se vigilará el valor límite inferior "Reserve5".
na 1717)
Limit5LowerLimitRelative (Pági‐ P P Determina si el valor límite inferior "Reserve5" se evaluará de for‐
na 1718) ma porcentual o absoluta.
Limit5UpperLimit (Página 1718) P P Establece el valor límite superior para "Reserve5".
Limit5UpperLimitColor (Pági‐ P P Define el color del valor límite superior "Reserve5".
na 1719)
Limit5UpperLimitEnabled (Pági‐ P P Determina si se vigilará el valor límite superior "Reserve5".
na 1720)
Limit5UpperLimitRelative (Pági‐ P P Determina si el valor límite superior "Reserve5" se evaluará de
na 1720) forma porcentual o absoluta.
LineEndShapeStyle (Pági‐ P P Determina la forma de los finales de línea.
na 1721)
MaximumValue (Página 1728) P, A P, A Define el valor máximo de la escala en el objeto indicado.
MinimumValue (Página 1745) P, A P, A Define el valor mínimo de la escala en el objeto indicado.
Name (Página 1749) P, A - Devuelve el nombre de objeto como STRING.
Precision (Página 1778) P P Define el número de decimales (de 0 a 20).
ProcessValue (Página 1779) P, A P, A Determina el ajuste predeterminado para el valor que debe mos‐
trarse.
ScaleColor (Página 1792) P, A P, A Define el color de la escala del objeto indicado.
ScaleGradation (Página 1792) P, A P, A Define la distancia entre dos marcas grandes de la escala.


ScaleLabelFieldLength * - - Define la distancia a la posición de la rotulación del eje.
ScaleLabelingDoubleLined - - Determina que la escala tenga dos líneas si la barra está en direc‐
ción horizontal.
ScalePosition (Página 1794) P P Define la posición de la escala del objeto indicado.
ScaleStart - - Determina el valor mínimo de la escala.
ScalingType (Página 1797) P P Establece el tipo de escala de barras.
SegmentColoring (Página 1800) P, A P, A Define el tipo de cambio de color con el que se muestra la supe‐
ración de valores límite en el objeto "Bar".
ShowBadTagState (Pági‐ P P Determina si el objeto se muestra en gris cuando la variable vin‐
na 1817) culada presente un mal QualityCode o estado.
ShowLargeTicksOnly (Pági‐ P P Define la longitud de los segmentos de eje en píxeles, o la devuel‐
na 1820) ve.
ShowLimitLines - - Determina que se muestre una línea en los valores límite.
ShowLimitMarkers (Pági‐ P P Determina si los valores límite se mostrarán como valores de es‐
na 1820) cala.
ShowScale (Página 1823) P P Determina si los valores se mostrarán adicionalmente en una es‐
cala.
ShowSignForPositiveLabel - - Determina que se muestre un "+" en las rotulaciones positivas.
ShowTickLabels (Página 1827) - - Determina si debe mostrarse la rotulación en la escala.
ShowTrendIndicator (Pági‐ P P Determina si la tendencia se mostrará con una pequeña flecha
na 1830) (ascendente o descendente) del valor medido que se vigila.
StartValue (Página 1834) P P Define el valor del punto cero de la visualización de la escala.
ToleranceLowerLimit (Pági‐ P P Determina si se vigilará el valor límite "ToleranceLowerLimit".
na 1890)
ToleranceLowerLimitColor (Pá‐ P P Define el color del valor límite inferior "ToleranceLowerLimit".
gina 1890)
ToleranceLowerLimitEnabled P P Determina si se vigilará el valor límite "ToleranceLowerLimit".
(Página 1891)
ToleranceUpperLimit (Pági‐ P P Determina si se vigilará el valor límite "ToleranceUpperLimit".
na 1892)
ToleranceUpperLimitColor (Pá‐ P P Define el color del valor límite superior "ToleranceUpperLimit".
gina 1893)
ToleranceUpperLimitEnabled P P Determina si se vigilará el valor límite "ToleranceUpperLimit".
(Página 1893)
ToleranceUpperLimitRelative P P Determina si el valor límite inferior "ToleranceHigh" se evaluará de
(Página 1894) forma porcentual o absoluta.
ToolTipText (Página 1908) P P Define el texto del tooltip.
Top (Página 1909) P, A P, A Define el valor de la coordenada Y del objeto.
Transparency (Página 1912) P P Determina el porcentaje de transparencia del objeto, y lo devuelve.
TrendIndicatorColor (Pági‐ P P Define el color del visor de tendencias.
na 1922)
Unit (Página 1950) P, A P, A Define la unidad de medida en el objeto "IOField".
UseAutoScaling - - Determina que se adapten automáticamente los intervalos de la
escala.
UseDesignColorSchema (Pági‐ P P Define la fuente que se utiliza en la impresión.
na 1953)


UseDesignShadowSettings (Pá‐ P P Determina si el objeto se representa con el sombreado fijado en
gina 1955) el diseño activo.
UseExponentialFormat (Pági‐ P P Determina si se mostrarán los números con exponentes (p.
na 1957) ej.,"1,00e+000").
Visible (Página 1973) P, A P, A Determina si el objeto indicado es visible.
WarningLowerLimit (Pági‐ P P Establece el valor límite inferior "WarningLowerLimit".
na 1977)
WarningLowerLimitColor (Pági‐ P P Define el color del valor límite inferior "WarningLowerLimit".
na 1977)
WarningLowerLimitEnabled (Pá‐ P P Determina si se vigilará el valor límite "WarningLowerLimit".
gina 1978)
WarningLowerLimitRelative (Pá‐ P P Determina si el valor límite inferior "WarningLowerLimit" se eva‐
gina 1979) luará de forma porcentual o absoluta.
WarningUpperLimit (Pági‐ P P Establece el valor límite superior "WarningUpperLimit".
na 1981)
WarningUpperLimitColor (Pági‐ P P Define el color del valor límite superior "WarningUpperLimit".
na 1982)
WarningUpperLimitEnabled (Pá‐ P P Determina si se vigilará el valor límite "WarningUpperLimit".
gina 1982)
WarningUpperLimitRelative (Pá‐ P P Determina si el valor límite superior "WarningUpperLimit" se eva‐
gina 1983) luará de forma porcentual o absoluta.
Width (Página 1983) P, A P, A Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
ZeroPoint (Página 2007) P P Determina la posición del punto cero de forma porcentual respecto
a la altura de barra.
Tabla 3-6 Métodos

ActivateDynamic (Pági‐ P Activa dinámicamente un disparador y el ciclo fijado para una propiedad du‐
na 2158) rante el runtime.
DeactivateDynamic (Pági‐ P Desactiva en/durante el runtime el disparador usado del método "ActivateDy‐
na 2165) namic" para la propiedad fijada.

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.
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional

Height (Página 1679) A A Define la altura en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
Layer (Página 1706) - - Dentro de la imagen, devuelve como LONG el nivel en el que se en‐
cuentra un objeto.
Name (Página 1749) A - Devuelve el nombre de objeto como STRING.
Width (Página 1983) A A Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".

Tabla 3-8 Métodos

No se ha encontrado
Button (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Botón". El objeto Button forma parte de la lista ScreenItems.

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

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

HMIButton

Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional

AdaptBorder (Página 1552) P P Determina si el borde del objeto indicado se adapta dinámicamente
al tamaño del texto.
na 1576)
na 1577)
na 1578)
BackFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo del fondo del objeto indicado.
na 1579)
BitNumber (Página 1584) - - Define el bit cuyo estado debe cambiar para que se produzca una
modificación del valor.
BorderBackColor (Pági‐ P P Define el color de fondo de la línea de borde quebrada del objeto
na 1587) indicado.
BorderBrightColor3D (Pági‐ P P Define el color de las partes del borde que se indican posteriormente
na 1588) para la representación tridimensional del objeto indicado.
BorderFlashingEnabled (Pági‐ P P Determina si la línea de borde del objeto indicado parpadea en run‐
na 1594) time.
BorderFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo de la línea de borde del objeto
na 1595) indicado.
BorderShadeColor3D (Pági‐ P P Define el color de las partes del borde que se indican posteriormente
na 1598) para la representación tridimensional del objeto indicado.
BorderStyle3D A A Determina si el objeto posee un sombreado de borde 3D.
BorderWidth3D (Página 1602) P P Determina el ancho del borde para la representación tridimensional
del objeto indicado.


DrawInsideFrame (Pági‐ P P Determina si la línea del borde del objeto indicado se traza dentro
na 1640) del borde o simétricamente respecto al borde a partir de un grosor
Enabled (Página 1644) P, A P, A Determina si el objeto indicado se puede manejar en runtime.
FitToLargest - - Determina que el tamaño del objeto dependa de la longitud del texto
en todos los idiomas.
FlashingColorOff (Página 1661) P P Determina el color de la línea de borde del objeto indicado para el
estado de parpadeo "Off".
FlashingColorOn (Página 1663) P P Determina el color de la línea de borde del objeto indicado para el
estado de parpadeo "On".
FlashingEnabled (Página 1664) P P Determina si la línea de borde del objeto indicado parpadea en run‐
time.
FlashingRate (Página 1665) P P Determina la frecuencia de parpadeo de la línea de borde del objeto
indicado.
FocusColor (Página 1667) A A Determina el color del borde del objeto indicado cuando está resal‐
tado dicho objeto.
FocusWidth (Página 1668) A A Determina el ancho del borde del objeto indicado cuando está re‐
FontItalic (Página 1671) P P Determina si el texto del objeto indicado se muestra en cursiva.
FontUnderline (Página 1673) P P Determina si el texto del objeto indicado se muestra subrayado.
tangle".
HelpText A - Devuelve el tooltip que se visualiza en runtime como ayuda de ma‐
nejo del objeto indicado.
HorizontalAlignment (Pági‐ P, A P, A Determina la alineación horizontal del texto dentro del objeto indi‐
na 1693) cado.
HotKey (Página 1695) - - Determina la tecla de acceso directo.
na 1721)
Mode (Página 1747) P P Determina el tipo de campo del objeto indicado.
PictureAlignment (Pági‐ P P Establece el modo de representación de la imagen de fondo en el
na 1774) sinóptico del proceso, o lo devuelve.
PictureList - - Define la lista de gráficos que proporciona valores al objeto.
PictureOff (Página 1775) P P Establece la imagen que se muestra en el estado "Off".


PictureOn (Página 1776) P P Establece la imagen que se muestra en el estado "On".
Pressed (Página 1778) P P Determina si el objeto indicado se mostrará pulsado.
ProcessValue - - Determina el ajuste predeterminado para el valor que debe mostrar‐
se.
RelativeFillLevel (Página 1784) P P Determina el porcentaje de relleno del objeto.
ShowFillLevel (Página 1819) P P Determina si se rellena el objeto indicado.
StyleSettings (Página 1848) P P Determina el estilo en el que se mostrará el objeto.
TextList (Página 1859) - - Listado que contiene las asignaciones entre el valor de salida y el
texto de salida que realmente será mostrado.
TextOff (Página 1859) P, A P, A Determina el texto que se muestra con el estado "Off" del objeto
indicado.
TextOn A A Determina el texto que se muestra con el estado "On" del objeto
indicado.
TextOrientation (Página 1860) P P Establece la dirección del texto del objeto indicado.
Toggle (Página 1888) P P Determina si el objeto indicado en runtime quedará enclavado tras
ser accionado.
ToolTipText (Página 1908) P P, A Define el texto del tooltip.
TransparentColorPictureOff P P Determina qué color del objeto de mapa de bits asignado se pondrá
(Página 1915) en "transparente" para el estado "Off".
TransparentColorPictureOn P P Determina qué color del objeto de mapa de bits asignado se pondrá
(Página 1916) en "transparente" para el estado "On".
na 1953)
UseDesignShadowSettings P P Determina si el objeto se representa con el sombreado fijado en el
(Página 1955) diseño activo.
UseTransparentColorPictu‐ P P Determina si se utilizará el color transparente para el estado "Off"
reOff (Página 1961) definido con la propiedad "TransparentColorPictureOff".
UseTransparentColorPictu‐ P P Determina si se utilizará el color transparente para el estado "On"
reOn (Página 1961) definido con la propiedad "TransparentColorPictureOn".
VerticalAlignment (Pági‐ P, A P, A Determina la alineación vertical del texto dentro del objeto indicado.
na 1971)
tangle".
WindowsStyle (Página 1988) P P Determina si el objeto se mostrará en el estilo general de Windows.

Tabla 3-10 Métodos

ActivateDynamic (Pági‐ P Activa dinámicamente un disparador y el ciclo fijado para una propiedad durante
na 2158) el runtime.
DeactivateDynamic (Pági‐ P Desactiva en/durante el runtime el disparador usado del método "ActivateDyna‐
na 2165) mic" para la propiedad fijada.
ChannelDiagnose (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Diagnóstico de canal". El objeto ChannelDiagnose forma parte de la

lista ScreenItems.

HMIChannelDiagnose
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional


Flashing * - - Determina que el bloque de texto parpadee.
Height (Página 1679) P P Define la altura en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
Name (Página 1749) P - Devuelve el nombre de objeto como STRING.
Width (Página 1983) P P Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
Tabla 3-12 Métodos


CheckBox (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Casilla de verificación". El objeto CheckBox es un elemento de la lista

ScreenItems.

HMICheckBox
Abreviatura Validez
Pa Panels
A Runtime Advanced

AdaptBorder (Página 1552) P P Determina si el borde del objeto indicado se adapta dinámicamen‐
te al tamaño del texto.


na 1576)
na 1577)
na 1578)
BackFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo del fondo del objeto indica‐
na 1579) do.
indicado.
BorderFlashingColorOff (Pági‐ P P Determina el color de la línea de borde del objeto indicado para
na 1592) el estado de parpadeo "Off".
BorderFlashingColorOn (Pági‐ P P Determina el color de la línea de borde del objeto indicado para
na 1593) el estado de parpadeo "On".
na 1594) runtime.
BorderFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo de la línea de borde del ob‐
na 1595) jeto indicado.
CheckmarkAlignment (Pági‐ P P Determina si los campos se disponen justificados a la derecha.
na 1615)
CheckmarkCount (Página 1615) P P Determina el número de campos.
CornerStyle (Página 1627) - - Determina el tipo de líneas de borde del objeto indicado.
EdgeStyle (Página 1641) - - Establece el estilo de línea del objeto indicado.
FlashingColorOff (Página 1661) P P Determina el color de la línea de borde del objeto indicado para
el estado de parpadeo "Off".
FlashingColorOn (Página 1663) P P Determina el color de la línea de borde del objeto indicado para
el estado de parpadeo "On".
FlashingEnabled (Página 1664) P P Determina si la línea de borde del objeto indicado parpadea en
runtime.
FlashingRate (Página 1665) P P Determina la frecuencia de parpadeo de la línea de borde del ob‐
jeto indicado.


ForeColor (Página 1674) P P Establece el color de fuente del texto del objeto indicado.
Height (Página 1679) P P Define la altura en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
HorizontalAlignment (Pági‐ P P Determina la alineación horizontal del texto dentro del objeto indi‐
na 1693) cado.
Index (Página 1697) P P Determina el fondo de los elementos de control de la cuadrícula.
LineEndShapeStyle (Pági‐ - - Determina la forma de los finales de línea.
na 1721)
LogOperation (Página 1725) P P Determina si se emite un aviso al sistema de avisos tras utilizarse
este objeto.
ProcessValue (Página 1779) P P Determina el ajuste predeterminado para el valor que debe mos‐
trarse.
ShowBadTagState (Pági‐ P P Determina si el objeto se muestra en gris cuando la variable vin‐
na 1817) culada presenta un mal QualityCode o estado.
Text (Página 1858) P P Define la rotulación del campo de texto.
Texts - - Determina los textos de las casillas de verificación.
Transparency (Página 1912) P P Determina el porcentaje de transparencia del objeto, y lo devuel‐
ve.
na 1953)
VerticalAlignment (Página 1971) P P Determina la alineación vertical del texto dentro del objeto indica‐
do.
tangle".

Tabla 3-14 Métodos

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

HMICircle
Abreviatura Validez
Pa Panels
A Runtime Advanced


BackFillStyle (Página 1575) P, A P, A Define el patrón de relleno del objeto indicado.
na 1587) indicado.
BorderColor (Página 1589) P, A P, A Determina el color de línea del objeto.
na 1594) time.
na 1595) indicado.
BorderWidth (Página 1600) P, A P, A Determina el grosor de línea del objeto.
EdgeStyle (Página 1641) A A Establece el estilo de línea del objeto indicado.
FlashingColorOff (Pági‐ P P Determina el color de la línea de borde del objeto indicado para el
FlashingColorOn (Pági‐ P P Determina el color de la línea de borde del objeto indicado para el
FlashingEnabled P P Determina si la línea de borde del objeto indicado parpadea en run‐
time.
indicado.
tangle".
LineEndShapeStyle (Pági‐ P P Determina la forma del final de línea.
na 1721)
Radius P P, A Establece el radio del objeto "Circle" indicado.
RelativeFillLevel (Pági‐ P P Determina el porcentaje de relleno del objeto.
na 1784)


UseDesignColorSchema (Pá‐ P P Define la fuente que se utiliza en la impresión.
gina 1953)
tangle".
Tabla 3-16 Métodos


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
Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) P P Determina los derechos de manejo del objeto indicado en
runtime.
BorderBackColor (Página 1587) P P Define el color de fondo de la línea de borde quebrada del
objeto indicado.


BorderFlashingColorOff (Pági‐ P P Determina el color de la línea de borde del objeto indicado
na 1592) para el estado de parpadeo "Off".
BorderFlashingColorOn (Pági‐ P P Determina el color de la línea de borde del objeto indicado
na 1593) para el estado de parpadeo "On".
BorderFlashingEnabled (Pági‐ P P Determina si la línea de borde del objeto indicado parpadea
na 1594) en runtime.
BorderFlashingRate (Página 1595) P P Determina la frecuencia de parpadeo de la línea de borde
DrawInsideFrame (Página 1640) P P Determina si la línea del borde del objeto indicado se traza
dentro del borde o simétricamente respecto al borde a partir
de un grosor de línea superior a 1.
EdgeStyle P P Establece el estilo de línea del objeto indicado.
Enabled (Página 1644) P P Determina si el objeto indicado se puede manejar en runti‐
me.
EndAngle (Página 1646) P P Define el ángulo en el que se desvía del origen (0°) el punto
final del objeto indicado.
FlashingColorOff (Página 1661) P P Determina el color de la línea de borde del objeto indicado
para el estado de parpadeo "Off".
FlashingColorOn (Página 1663) P P Determina el color de la línea de borde del objeto indicado
para el estado de parpadeo "On".
FlashingEnabled P P Determina si la línea de borde del objeto indicado parpadea
en runtime.
FlashingRate (Página 1665) P P Determina la frecuencia de parpadeo de la línea de borde
"Rectangle".
Layer (Página 1706) - - Dentro de la imagen, devuelve como LONG el nivel en el que
se encuentra un objeto.
LineEndShapeStyle (Página 1721) P P Determina la forma del final de línea.
Radius P P Establece el radio del objeto "Circle" indicado.
StartAngle (Página 1833) P P Define el Statement SQL.
Transparency (Página 1912) P P Determina el porcentaje de transparencia del objeto, y lo de‐
vuelve.


na 1953)
UseDesignShadowSettings (Pági‐ P P Determina si el objeto se representa con el sombreado fijado
na 1955) en el diseño activo.
"Rectangle".
Tabla 3-18 Métodos

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
Abreviatura Validez
Pa Panels
A Runtime Advanced

Color (Página 1617) P P Determina el color de línea del objeto indicado.
EndAngle (Página 1646) P P Define el ángulo en el que se desvía del origen (0°) el punto final
FlashingEnabled P P Determina si la línea de borde del objeto indicado parpadea en run‐
time.
indicado.
tangle".
na 1721)
Style (Página 1847) P P Establece el estilo de línea del objeto indicado.


na 1953)
UseDesignShadowSettings (Pá‐ P P Determina si el objeto se representa con el sombreado fijado en el
gina 1955) diseño activo.
tangle".
Tabla 3-20 Métodos

Clock (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP

Representa el objeto "Reloj". El objeto Clock forma parte de la lista ScreenItems.

Clock
Abreviatura Validez
Pa Panels
A Runtime Advanced

Analog (Página 1562) P P Determina si el reloj se visualiza en forma de reloj analógico.
DialColor (Página 1635) P, A P, A Define el color de la esfera del objeto indicado.
Height (Página 1679) P, A P, A Define la altura en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
HourNeedleHeight (Pági‐ P, A P, A Define la longitud de la aguja horaria en el objeto "Clock".
na 1696)
HourNeedleWidth (Pági‐ P, A P, A Define el ancho de la aguja horaria en el objeto "Clock".
na 1696)
cuentra un objeto.
LockSquaredExtent (Pági‐ P P Determina si los valores de variables para el intervalo de tiempo que
na 1724) se representa se cargan desde los ficheros al abrir una imagen.
MinuteNeedleHeight (Pági‐ P, A P, A Define la longitud del minutero en el objeto "Clock".
na 1746)
MinuteNeedleWidth (Pági‐ P, A P, A Define el ancho del minutero en el objeto "Clock".
na 1746)
NeedleBorderColor (Pági‐ P, A P, A Determina el nombre de la fuente de datos.
na 1751)
NeedleColor (Página 1752) P, A P, A Define el color de las agujas en el objeto "Clock".
NeedleFillStyle (Pági‐ P P Define el estilo de relleno de las agujas.
na 1753)
Picture (Página 1774) - - Define la imagen que se muestra en el objeto gráfico en runtime.


SecondNeedleHeight (Pági‐ P, A P, A Define la longitud del segundero en el objeto "Clock".
na 1799)
SecondNeedleWidth (Pági‐ P, A P, A Define el ancho del segundero en el objeto "Clock".
na 1800)
ShowFocusRectangle (Pá‐ P P Determina si el botón tendrá un borde de selección en runtime cuando
gina 1819) se active.
ShowTicks (Página 1828) P, A P, A Determina si deben mostrarse las marcas en la escala del objeto.
TicksColor (Página 1862) P, A P, A Determina la representación de la escala.
Transparency (Pági‐ P P Determina el porcentaje de transparencia del objeto, y lo devuelve.
na 1912)
UseDesignColorSchema P P Define la fuente que se utiliza en la impresión.
(Página 1953)
Width (Página 1983) P, A P, A Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
Tabla 3-22 Métodos


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
Abreviatura Validez
Pa Panels
A Runtime Advanced

BorderEndStyle (Página 1591) P P Determina el tipo de finales de línea del objeto indicado.


ConnectionType (Página 1625) P P Define el tipo del conector. Puede seleccionar entre dos tipos de
conexión.
EndStyle (Página 1647) - - Determina cómo se debe representar el final de línea del objeto in‐
dicado.
FirstConnectedObjectIndex P P Define el número de índice del punto de conexión superior.
(Página 1660)
FirstConnectedObjectName P P Define el nombre del objeto que está acoplado en el punto de cone‐
(Página 1660) xión superior.
FlashingEnabled (Pági‐ P P Determina si la línea de borde del objeto indicado parpadea en run‐
na 1664) time.
indicado.
tangle".
LastConnectedObjectIndex P P Define el número de índice del punto de conexión con el último ob‐
(Página 1704) jeto conectado.
LastConnectedObjectName P P Define el nombre del objeto que está acoplado en el punto de cone‐
(Página 1704) xión inferior.
na 1721)
Points * - - Define los vértices.
StartStyle - - Determina cómo se debe representar el comienzo de línea del objeto
indicado.
SwapFirstWithLastConnection P P Determina si el texto del objeto se representa en posición horizontal.
(Página 1849)
na 1953)
UseDesignShadowSettings P P Determina que se utilice el tamaño de fuente de la fuente de datos.
(Página 1955)


Width (Página 1983) P - Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
Tabla 3-24 Métodos

ActivateDynamic (Página 2158) P Activa dinámicamente un disparador y el ciclo fijado para una propiedad du‐
rante el runtime.
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 forma parte de la lista
ScreenItems.

HMIDateTimeField

Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en runtime.
BackFillStyle - - Define el patrón de relleno del objeto indicado.
BorderBackColor (Página 1587) - - Define el color de fondo de la línea de borde quebrada del objeto
* indicado.
BorderColor A A Determina el color de línea del objeto.
BorderStyle3D (Página 1600) A A Determina si el objeto posee un sombreado de borde 3D.
DisplaySystemTime - - Establece que se muestre la hora del sistema.
EdgeStyle - - Establece el estilo de línea del objeto indicado.
FitToLargest - - Determina que el tamaño del objeto dependa de la longitud del texto
en todos los idiomas.
Font (Página 1669) * - - Define la fuente, o la devuelve.
ForeColor A A Establece el color de fuente del texto del objeto indicado.
Format - - Determina que se muestre el formato del bloque de texto.
gle".
HelpText (Página 1684) A - Devuelve el tooltip que se visualiza en runtime como ayuda de manejo
HorizontalAlignment A A Determina la alineación horizontal del texto dentro del objeto indicado.
cuentra un objeto.
LineWrap * - - Define el salto de línea dentro de un objeto.
LongDateTimeFormat - - Determina que la fecha y la hora se muestren en formato largo.
Mode (Página 1747) - - Determina el tipo de campo del objeto indicado.
ProcessValue (Página 1779) A A Determina el ajuste predeterminado para el valor que debe mostrarse.
ShowDate - - Determina que se muestre la fecha.
ShowTime - - Determina que sólo se muestre la hora.
VerticalAlignment (Página 1971) A A Determina la alineación vertical del texto dentro del objeto indicado.


gle".
Tabla 3-26 Métodos

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.

IXDiskSpaceView

Abreviatura Validez
Pa Panels
A Runtime Advanced

Alarm (Página 1555) P P Establece el límite para el visor de memoria a partir del cual se emite un
aviso.
AlarmColor (Página 1555) P P Determina qué tipos de avisos se muestran en el visor de avisos.
Drive (Página 1641) P P Define la letra de la unidad de disco que debe vigilarse.
Free (Página 1676) P P Devuelve el tamaño del espacio de memoria libre.
FreePercent (Página 1676) P P Devuelve los valores medidos para el espacio de memoria libre en por‐
centaje.
Height (Página 1679) P P Define la altura en los objetos indicados "Ellipse", "Circle" y "Rectangle".
Interval (Página 1700) P P Define el intervalo de tiempo para la actualización de los valores medidos
mostrados.
cuentra un objeto.
NormalColor P P Define el color del objeto en el rango normal.
Tolerance (Página 1889) P P Establece el límite para el visor de memoria a partir del cual se notifica
una desviación.
ToleranceColor (Pági‐ P P Define los colores en los que se muestra la barra del visor de memoria
na 1889) cuando se sobrepasa el margen de tolerancia.
Total (Página 1912) P P Devuelve la capacidad de la memoria.
Used (Página 1953) P P Determina si está activado el desplazamiento.
UsedPercent (Página 1956) P P Devuelve los valores medidos para el espacio de memoria ocupado en
porcentaje.
Warning (Página 1976) P P Establece el límite para el visor de memoria a partir del cual se emite
una advertencia.
Width (Página 1983) P P Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rectangle".

Tabla 3-28 Métodos

Ellipse (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Elipse". El objeto Ellipse forma parte de la lista ScreenItems.

HMIEllipse
Abreviatura Validez
Pa Panels
A Runtime Advanced


indicado.
na 1594) runtime.
na 1595) indicado.
EdgeStyle A A Establece el estilo de línea del objeto indicado.
runtime.
indicado.
tangle".
na 1721)
RadiusHeight P P Define el eje secundario del objeto "Ellipse".
RadiusWidth P P Define el eje principal del objeto "Ellipse".


na 1953)
tangle".
Tabla 3-30 Método
Método Val. Descripción


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.

HMIEllipseSegment
Abreviatura Validez
Pa Panels
A Runtime Advanced

na 1587) indicado.


na 1594) time.
na 1595) indicado.
EndAngle (Página 1646) P P Define el ángulo en el que se desvía del origen (0°) el punto final del
objeto indicado.
na 1664) time.
indicado.
gle".
na 1721)
RelativeFillLevel (Pági‐ P P Determina el porcentaje de relleno del objeto.
na 1784)


gina 1953)
tangle".
Tabla 3-32 Métodos

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
Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) P P Determina los derechos de manejo del objeto indicado en runti‐
me.
EndAngle (Página 1646) P P Define el ángulo en el que se desvía del origen (0°) el punto final
FlashingColorOff (Página 1661) - - Determina el color de la línea de borde del objeto indicado para
FlashingColorOn (Página 1663) - - Determina el color de la línea de borde del objeto indicado para
FlashingEnabled (Página 1664) - - Determina si la línea de borde del objeto indicado parpadea en
runtime.
FlashingRate (Página 1665) - - Determina la frecuencia de parpadeo de la línea de borde del
objeto indicado.
tangle".


ve.
na 1953)
UseDesignShadowSettings (Pági‐ P P Determina si el objeto se representa con el sombreado fijado en
na 1955) el diseño activo.
tangle".
Tabla 3-34 Métodos


ForeignControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Tipo de objeto del objeto ScreenItem. Representa el objeto gráfico "Control".

El tipo de objeto Control asume siempre las propiedades del tipo de control que Ud. ha elegido.
En los controles puestos a disposición por WinCC encontrará Ud. las propiedades en la
descripción de los controles respectivos.
En el caso de tratarse de controles de otros fabricantes, las propiedades de los controles serán
suministradas con los controles y por consiguiente no forman parte de esta descripción. Sin
embargo Ud. puede consultar las propiedades del control a través de la propiedad "Item".

Designación especial del tipo WinCC o ProgID independiente a la versión
Utilización
"Control1":
'VBS36
Dim objControl

Particularidad
En los controles suministrados por WinCC se devolverá como tipo una identificación especial.
Ella se puede encontrar en el rubro "Identificación de tipo en VBS" en las descripciones
individuales de los controles de WinCC.
Acceso a propiedades específicas en lugar de parámetros de evento de controles de otros fabricantes

En WinCC no se leen las listas de parámetros de eventos de controles de otros fabricantes.
Para poder acceder a parámetros propios de eventos de control, deben crearse en el control
propiedades en lugar de parámetros.
El siguiente ejemplo de código muestra el código fuente del control "UserControlTestModify",
en el que se definen las propiedades "Title" y "Description" en lugar de parámetros.
public partial class UserControlTestModify : UserControl

{
public event MyEventHandler MyEvent = null;
public string Title

{
get;
private set;
}
public string Description

{
get;
set;
}
public UserControlTestModify()
{
InitializeComponent();
}
private void OnMyEvent(Exception e)
{
if (this.MyEvent!= null)
{
// Place data in Properties before invoking event.
Title = "title";
Description = "description"; ";
this.MyEvent.Invoke();
}
}
private void button1_Click(object sender, EventArgs e)

{
this.OnMyEvent (null);
}
}
En WinCC con IntelliSense no se muestran las propiedades específicas de los controles de

otros fabricantes.

El siguiente ejemplo muestra cómo acceder en WinCC a la propiedad específica "Title" del
control de otro fabricante "FControl":
HMIRuntime.Screens("StartScreen").ScreenItems("FControl").Title = "MyForeignControl"
ProgID y UserfriendlyName de controles de otros fabricantes

En controles de otros fabricantes que no son WinCC se devolverá como tipo la ProgID
independiente de la versión.
A partir de la ProgID se puede averiguar la ProgID dependiente de versión o el
"UserFriendlyName": En el siguiente ejemplo es "Control1" un control incrustado en una
imagen que devuelve la ProgID independiente de la versión a través de la propiedad Type.
Nota
Como no todos los controles tienen una ProgID independiente de la versión, para consultar
la ProgID independiente de la versión o el UserFriendlyName se debería incluir un tratamiento
de error. Si no se utiliza ningún tratamiento de error se terminará el código inmediatamente
sin resultado en el caso de que no se haya encontrado ninguna ProgID.
Determine la ProgID independiente de la versión de la siguiente manera:
'VBS37
Dim objControl
Dim strCurrentVersion
strCurrentVersion = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type &
"\CurVer\")
MsgBox strCurrentVersion
Nota
Para que el ejemplo de arriba funcione se debería insertar en la imagen un control multimedios.
Determine así el UserFriendlyName:
'VBS38
Dim objControl
Dim strFriendlyName
strFriendlyName = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type & "\")
MsgBox strFriendlyName

Nota
Para que el ejemplo de arriba funcione se debería insertar en la imagen un control multimedios.
Si Ud. utiliza un control que no ha sido suministrado por WinCC, puede suceder que las
propiedades traídas por el control tengan el mismo nombre que las propiedades generales
de ScreenItem. En este caso tienen preferencia las propiedades ScreenItem. A través de la
propiedad adicional "object" se puede acceder a las propiedades "ocultas" de un control de
otro fabricante. Si Ud. considera adecuadas las propiedades de un control de otro fabricante,
es decir, p. ej. de la siguiente forma:
Control.object.type
En caso de homonimia se usan las propiedades del objeto ScreenItem si utiliza Ud. la siguiente
forma:
Control.type
Abreviatura Validez
Pa Panels
A Runtime Advanced

gle".
OCXState (Página 1757) * - - Establece el estado del OCX.
ProgID (Página 1780) * - - En controles de otros fabricantes que no son WinCC se devolverá
como tipo la ProgID independiente de la versión.
tangle".

Tabla 3-36 Métodos
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

de la lista ScreenItems.

HMIFunctionTrendControl
Abreviatura Validez
Pa Panels
A Runtime Advanced


Height (Página 1679) P - Define la altura en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
ObjectName (Página 2035) P - Devuelve el nombre de objeto como STRING.
Tipo (Página 2139) P - Devuelve como STRING el tipo del objeto indicado.
Width (Página 1983) P - Define el ancho en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
Tabla 3-38 Métodos

durante el runtime.
DeactivateDynamic (Página 2165) P Desactiva en/durante el runtime el disparador usado del método "Acti‐
vateDynamic" para la propiedad fijada.
DetachDB (Página 2168) P, A Ejecuta la función del botón "Desconectar copia de seguridad" del con‐
trol.
Export (Página 2169) P, A Ejecuta la función del botón "Exportar fichero" o "Exportar datos" del
control.
GetStatusbarElement (Página 2195) P, A Devuelve el elemento de la barra de estado designado por nombre o
índice del control como tipo "ICCAxStatusbarElement".
GetStatusbarElementCollection (Pá‐ P, A Devuelve el listado de todos los elementos de la barra de estado del
gina 2196) control como tipo "ICCAxCollection".
GetToolbarButton (Página 2203) P, A Devuelve la función de tecla designada por nombre o índice de la barra
de herramientas del control como tipo "ICCAxToolbarButton".
GetToolbarButtonCollection (Pági‐ P, A Devuelve el listado de todas las funciones de tecla de la barra de herra‐
na 2205) mientas del control como tipo "ICCAxCollection".
GetTrend (Página 2206) P, A Devuelve la curva designada por nombre o índice del visor de curvas
f(t) o f(x) como tipo "ICCAxTrend" o "ICCAxFunctionTrend".
GetTrendCollection (Página 2207) P, A Devuelve el listado de todas las curvas del visor de curvas f(t) o f(x) como
tipo "ICCAxCollection".
GetTrendWindow (Página 2208) P, A Devuelve el objeto de ventana de curvas designado por nombre o índice
del visor de curvas f(t) o f(x) como tipo "ICCAxTrendWindow".
GetTrendWindowCollection (Pági‐ P, A Devuelve el listado de todos los objetos de ventana de curvas del visor
na 2209) de curvas f(t) o f(x) como tipo "ICCAxCollection".
GetXAxis (Página 2216) P, A Devuelve el objeto de eje X designado por nombre o índice del visor de
curvas f(x) como tipo "ICCAxValueAxis".


GetXAxisCollection (Página 2217) P, A Devuelve el listado de todos los objetos de eje X del visor de curvas f(x)
como tipo "ICCAxCollection".
GetYAxis (Página 2218) P, A Devuelve el objeto de eje Y designado por nombre o índice del visor de
curvas f(x) como tipo "ICCAxValueAxis".
GetYAxisCollection (Página 2219) P, A Devuelve el listado de todos los objetos de eje Y del visor de curvas f(x)
del tipo "ICCAxCollection".
MoveAxis (Página 2224) P, A Ejecuta la función del botón "Desplazar área del eje" de los visores de
curvas f(t) y f(x).
NextTrend (Página 2231) P, A Ejecuta la función del botón "Siguiente curva" de los visores de curvas
f(t) y f(x).
OneToOneView (Página 2232) P, A Ejecuta la función del botón "Vista original" de los visores de curvas f(t)
y f(x).
PreviousTrend (Página 2233) P, A Ejecuta la función del botón "Curva anterior" de los visores de curvas
f(t) y f(x).
ShowPropertyDialog (Página 2258) P, A Ejecuta la función del botón "Diálogo de configuración" del control.
ShowTagSelection (Página 2262) P, A Ejecuta la función del botón "Seleccionar conexión de datos" del control.
ShowTimeSelection (Página 2263) P, A Ejecuta la función del botón "Rango de tiempo Seleccionar" del control.
ShowTrendSelection (Página 2263) P, A Ejecuta la función del botón "Seleccionar curvas" de los visores de cur‐
vas f(t) y f(x).
StartStopUpdate (Página 2264) P, A Ejecuta la función del botón "Iniciar" o "Detener" del control.
ZoomArea (Página 2271) P, A Ejecuta la función del botón "Ampliar sección" de los visores de curvas
f(t) y f(x).
ZoomInOut (Página 2272) P, A Ejecuta la función del botón "Zoom +/-" de los visores de curvas f(t) y
f(x).
ZoomInOutX (Página 2273) P, A Ejecuta la función del botón "Zoom eje X +/-" del visor de curvas f(x).
ZoomInOutY (Página 2274) P, A Ejecuta la función del botón "Zoom eje Y +/-" del visor de curvas f(x).
ZoomMove (Página 2274) P, A Ejecuta la función del botón "Desplazar área de curva" de los visores de
curvas f(t) y f(x).
Consulte también
BackColor (Página 1572)
Caption (Página 1608)
LoadDataImmediately (Página 1723)
Online (Página 1757)
TimeBase (Página 1866)
ShowRuler (Página 1822)
ApplyProjectSettings (Página 1564)
BorderColor (Página 1589)
BorderWidth (Página 1600)
Closeable (Página 1617)

ConnectTrendWindows (Página 1626)

ExportDirectoryChangeable (Página 1650)
ExportDirectoryname (Página 1650)
ExportFileExtension (Página 1651)
ExportFilename (Página 1651)
ExportFilenameChangeable (Página 1652)
ExportFormatGuid (Página 1652)
ExportFormatName (Página 1653)
ExportParameters (Página 1654)
ExportSelection (Página 1654)
ExportShowDialog (Página 1655)
Font (Página 1669)
GraphDirection (Página 1677)
Layer (Página 1706)
LineColor (Página 1721)
LineWidth (Página 1723)
Moveable (Página 1748)
Name (Página 1749)
RTPersistence (Página 1789)
RTPersistenceType (Página 1790)
UseTrendNameAsLabel (Página 1962)
ToolbarAlignment (Página 1894)
ToolbarBackColor (Página 1895)
ToolbarButtonActive (Página 1896)
ToolbarButtonAdd (Página 1896)
ToolbarButtonBeginGroup (Página 1897)
ToolbarButtonCount (Página 1898)
ToolbarButtonEnabled (Página 1898)
ToolbarButtonHotKey (Página 1899)
ToolbarButtonID (Página 1899)
ToolbarButtonIndex (Página 1900)
ToolbarButtonLocked (Página 1901)
ToolbarButtonName (Página 1901)
ToolbarButtonAuthorization (Página 1902)
ToolbarButtonRemove (Página 1902)

ToolbarButtonRename (Página 1903)

ToolbarButtonRepos (Página 1904)
ToolbarButtonTooltipText (Página 1904)
ToolbarButtonUserDefined (Página 1905)
ToolbarShowTooltips (Página 1905)
ToolbarUseBackColor (Página 1906)
ToolbarUseHotKeys (Página 1907)
ToolbarVisible (Página 1907)
TrendActualize (Página 1916)
TrendAdd (Página 1917)
TrendBeginTime (Página 1917)
TrendColor (Página 1918)
TrendCount (Página 1918)
TrendEndTime (Página 1919)
TrendExtendedColorSet (Página 1919)
TrendFill (Página 1920)
TrendFillColor (Página 1920)
TrendIndex (Página 1921)
TrendLabel (Página 1922)
TrendLineStyle (Página 1923)
TrendLineType (Página 1923)
TrendLineWidth (Página 1924)
TrendLowerLimit (Página 1924)
TrendLowerLimitColor (Página 1925)
TrendLowerLimitColoring (Página 1925)
TrendMeasurePoints (Página 1926)
TrendName (Página 1926)
TrendPointColor (Página 1927)
TrendPointStyle (Página 1928)
TrendPointWidth (Página 1928)
TrendProvider (Página 1929)
TrendRangeType (Página 1929)
TrendRemove (Página 1930)
TrendRename (Página 1930)
TrendRepos (Página 1931)

TrendSelectTagNameX (Página 1931)

TrendSelectTagNameY (Página 1932)
TrendTagNameX (Página 1932)
TrendTagNameY (Página 1933)
TrendTimeRangeBase (Página 1933)
TrendTimeRangeFactor (Página 1934)
TrendTrendWindow (Página 1934)
TrendUncertainColor (Página 1935)
TrendUncertainColoring (Página 1936)
TrendUpperLimit (Página 1936)
TrendUpperLimitColor (Página 1937)
TrendUpperLimitColoring (Página 1937)
TrendVisible (Página 1938)
TrendWindowAdd (Página 1938)
TrendWindowCoarseGrid (Página 1939)
TrendWindowCoarseGridColor (Página 1939)
TrendWindowFineGrid (Página 1940)
TrendWindowFineGridColor (Página 1941)
TrendWindowForegroundTrendGrid (Página 1941)
TrendWindowGridInTrendColor (Página 1942)
TrendWindowHorizontalGrid (Página 1942)
TrendWindowIndex (Página 1943)
TrendWindowName (Página 1943)
TrendWindowRemove (Página 1944)
TrendWindowRename (Página 1944)
TrendWindowRepos (Página 1945)
TrendWindowRulerColor (Página 1945)
TrendWindowRulerLayer (Página 1946)
TrendWindowRulerStyle (Página 1947)
TrendWindowRulerWidth (Página 1947)
TrendWindowSpacePortion (Página 1948)
TrendWindowVerticalGrid (Página 1948)
TrendWindowVisible (Página 1949)
TrendXAxis (Página 1949)
TrendYAxis (Página 1950)

ShowRulerInAxis (Página 1823)

ShowScrollbars (Página 1824)
ShowTitle (Página 1828)
ShowTrendIcon (Página 1829)
StatusbarBackColor (Página 1835)
StatusbarElementAdd (Página 1836)
StatusbarElementAutoSize (Página 1836)
StatusbarElementCount (Página 1837)
StatusbarElementIconId (Página 1838)
StatusbarElementID (Página 1838)
StatusbarElementIndex (Página 1839)
StatusbarElementName (Página 1840)
StatusbarElementRemove (Página 1840)
StatusbarElementRename (Página 1841)
StatusbarElements (Página 1841)
StatusbarElementTooltipText (Página 1842)
StatusbarElementUserDefined (Página 1842)
StatusbarElementVisible (Página 1843)
StatusbarElementWidth (Página 1844)
StatusbarFontColor (Página 1844)
StatusbarShowTooltips (Página 1845)
StatusbarText (Página 1846)
StatusbarUseBackColor (Página 1846)
StatusbarVisible (Página 1847)
XAxisAdd (Página 1989)
XAxisAutoPrecisions (Página 1989)
XAxisAutoRange(i) (Página 1990)
XAxisBeginValue (Página 1990)
XAxisColor (Página 1991)
XAxisCount (Página 1991)
XAxisEndValue (Página 1992)
XAxisExponentialFormat (Página 1992)
XAxisIndex (Página 1993)
XAxisInTrendColor (Página 1993)
XAxisName (Página 1994)

XAxisPrecisions (Página 1995)

XAxisRemove (Página 1995)
XAxisRepos (Página 1995)
XAxisTrendWindow (Página 1996)
XAxisVisible (Página 1997)
YAxisAdd (Página 1997)
YAxisAutoPrecisions (Página 1998)
YAxisAutoRange (Página 1999)
YAxisBeginValue (Página 1999)
YAxisColor (Página 2000)
YAxisCount (Página 2000)
YAxisEndValue (Página 2001)
YAxisExponentialFormat (Página 2001)
YAxisIndex (Página 2002)
YAxisInTrendColor (Página 2002)
YAxisLabel (Página 2003)
YAxisName (Página 2003)
YAxisPrecisions (Página 2003)
YAxisRemove (Página 2004)
YAxisRepos (Página 2005)
YAxisScalingType (Página 2005)
YAxisTrendWindow (Página 2006)
YAxisVisible (Página 2006)
ControlDesignMode (Página 1831)
RTPersistencePasswordLevel (Página 2045)

Gauge (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Indicador (gauge)". El objeto Gauge forma parte de la lista ScreenItems.

HMIGauge
Abreviatura Validez
Pa Panels
A Runtime Advanced

AngleMax (Página 1562) P, A P, A Define el ángulo para el final de escala del objeto "Gauge".
AngleMin (Página 1563) P, A P, A Define el ángulo para el principio de escala del objeto "Gauge".
BackPicture - - Establece un gráfico para el fondo.


BorderInnerStyle3D (Pági‐ P P Determina la visualización de la parte interior del borde del obje‐
na 1596) to.
BorderOuterStyle3D (Pági‐ P P Determina la visualización de la parte exterior del borde del ob‐
na 1597) jeto.
BorderWidth3D (Página 1602) P P Determina el ancho del borde para la representación tridimen‐
sional del objeto indicado.
CaptionColor (Página 1609) P, A P, A Determina el color del texto en el que se debe visualizar la barra
de título del objeto indicado.
CaptionFont - - Define el juego de caracteres para la rotulación.
CaptionText (Página 1609) P, A P, A Determina el texto que se muestra en la barra de título del objeto
indicado.
CaptionTop (Página 1610) P P Define la distancia del rótulo del instrumento al borde superior
CenterColor (Página 1613) P, A P, A Define el color del punto central del objeto "Gauge".
CenterSize (Página 1614) P P Determina el diámetro del centro redondo de la escala.
DangerRangeColor (Pági‐ P, A P, A Define el color del rango de peligro en la escala del objeto "Gau‐
na 1632) ge".
DangerRangeStart (Pági‐ P, A P, A Determina a partir de qué valor de la escala comienza el rango
na 1632) de peligro del objeto "Gauge".
DangerRangeVisible (Pági‐ P, A P, A Determina si debe mostrarse el rango de peligro en la escala del
na 1633) objeto "Gauge". {
DialColor (Página 1635) P, A P, A Define el color de la esfera del objeto indicado.
DialFillStyle (Página 1636) P P Determina el tipo de fondo del objeto indicado.
DialPicture - - Establece un gráfico para la esfera.
DialSize (Página 1636) P P Determina el diámetro de la esfera en relación con el menor valor
de los atributos de geometría "Width" y "Height".
Gradation (Página 1677) P, A P, A Define la diferencia de valor entre dos marcas principales del
objeto "Gauge".
tangle".
LockSquaredExtent (Pági‐ P P Determina si los valores de variables para el intervalo de tiempo
na 1724) que se representa se cargan desde los ficheros al abrir una ima‐
gen.
NormalRangeColor (Pági‐ P, A P, A Define el color del rango normal en la escala del objeto "Gauge".
na 1753) "
NormalRangeVisible (Pági‐ P, A P, A Determina si debe mostrarse el rango normal en la escala del
na 1754) objeto "Gauge".
PointerColor (Página 1777) P, A P, A Define el color del puntero del objeto "Gauge".


ProcessValue (Página 1779) P, A P, A Determina el ajuste predeterminado para el valor que debe mos‐
trarse.
ScaleLabelColor (Página 1793) P, A P, A Define el color de la rotulación de las divisiones de la escala del
objeto "Gauge".
ScaleLabelFont - - Define la fuente de la rotulación de la escala.
ScaleTickColor (Página 1794) P, A P, A Define el color de las divisiones de la escala del objeto "Gauge".
ScaleTickLabelPosition (Pági‐ P P Define el diámetro del círculo imaginario en el que se encuentra
na 1795) la rotulación de las divisiones de la escala.
ScaleTickLength (Página 1795) P P Determina la longitud de las divisiones principales de la escala.
ScaleTickPosition (Página 1796) P P Define el diámetro del círculo imaginario en el que se encuentran
las divisiones de la escala.
ShowDecimalPoint (Pági‐ P P Determina si la escala se rotula con números decimales (coma
na 1818) decimal y un decimal) o con números enteros.
ShowPeakValuePointer (Pági‐ P, A P, A Determina si se utiliza un puntero de arrastre para el objeto indi‐
na 1821) cado.
ve.
UnitColor (Página 1951) P, A P, A Define el color de texto para el nombre de la unidad de medida
en el objeto "Gauge".
UnitFont - - Define la fuente de la unidad.
UnitText (Página 1951) P, A P, A Define el texto para la unidad de medida del objeto indicado.
UnitTop (Página 1952) P P Define la distancia de la unidad de medida al borde superior del
objeto indicado.
na 1953)
WarningRangeColor (Pági‐ P, A P, A Define el color del rango de advertencia en la escala del objeto
na 1979) "Gauge".
WarningRangeStart (Pági‐ P, A P, A Determina a partir de qué valor de la escala comienza el rango
na 1980) de advertencia del objeto "Gauge".
WarningRangeVisible (Pági‐ P, A P, A Determina si debe mostrarse el rango de advertencia en la escala
na 1981) del objeto "Gauge".
Width (Página 1983) P, A P, A Define el ancho en los objetos indicados "Ellipse", "Circle" y
"Rectangle".

Tabla 3-40 Métodos

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 forma parte 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
BorderStyle3D x x x --
Enabled x -- x --
FocusColor x -- x --
FocusWidth x -- x --
HelpText x -- x --


TransparentColor x x x --
UseTransparent‐ x x x --
Color

HMIGraphicIOField
Abreviatura Validez
Pa Panels
A Runtime Advanced

AboveUpperLimitColor (Pági‐ - - Define el color del objeto indicado para el caso "Rebase por ex‐
na 1545) ceso del límite superior".
AdaptPicture - - Determina que el tamaño del objeto se adapte automáticamente
en runtime.
me.
AutoSizing - - Determina que el tamaño del objeto se adapte automáticamente
al contenido.
BackColor (Página 1572) A A Determina el color de fondo del objeto indicado.
BelowLowerLimitColor (Pági‐ - - Define el color del objeto indicado para el caso "Rebase por de‐
na 1584) fecto del límite inferior".
BitNumber (Página 1584) - - Define el bit cuyo estado debe cambiar para que se produzca
una modificación del valor.
indicado.
na 1594) runtime.
BorderFlashingRate (Pági‐ P P Determina la frecuencia de parpadeo de la línea de borde del
na 1595) objeto indicado.


del borde o simétricamente respecto al borde a partir de un gro‐
sor de línea superior a 1.
FitToLargest - - Determina que el tamaño del objeto dependa de la longitud del
texto en todos los idiomas.
runtime.
límite.
FlashingRate (Página 1665) P P Determina la frecuencia de parpadeo de la línea de borde del
objeto indicado.
FlashTransparentColor (Pági‐ P P Define el color del objeto de mapa de bits de una imagen parpa‐
na 1666) deante que se pondrá en "transparente".
FocusColor (Página 1667) A A Determina el color del borde del objeto indicado cuando está
FocusWidth (Página 1668) A A Determina el ancho del borde del objeto indicado cuando está
tangle".
HelpText A - Devuelve el tooltip que se visualiza en runtime como ayuda de
manejo del objeto indicado.
na 1721)
OnValue - - Define el valor para el estado "On" en el modo "Dos estados".
PictureList - - Define la lista de gráficos que proporciona valores al objeto.
PictureOff (Página 1775) - - Establece la imagen que se muestra en el estado "Off".
PictureOn (Página 1776) - - Establece la imagen que se muestra en el estado "On".
trarse.
ScrollBarOrientation - - Determina la orientación de la barra de desplazamiento.
ShowScrollBar - - Determina el tipo de barra de desplazamiento.
ve.
TransparentColor (Página 1914) P, A P, A Determina qué color del gráfico asignado (*.bmp, *.dib) del objeto
indicado se pondrá en "transparente".


UseFlashTransparentColor (Pági‐ P P Determina si el color del objeto de mapa de bits de una imagen
na 1957) parpadeante se pondrá en "transparente".
UseTransparentColor (Pági‐ P, A P, A Determina si el color especificado con la propiedad "Transpa‐
na 1960) rentColor" para el objeto indicado debe verse transparente.
"Rectangle".
Tabla 3-42 Métodos

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 forma parte de la lista

ScreenItems.


HMIGraphicView
Abreviatura Validez
Pa Panels
A Runtime Advanced

AdaptPicture A - Determina que el tamaño del objeto se adapte automáticamente
en runtime.
me.
AutoSizing - - Determina que el tamaño del objeto se adapte automáticamente
al contenido.
na 1577)
na 1576)
na 1578)
BackFlashingRate (Página 1579) P P Determina la frecuencia de parpadeo del fondo del objeto indica‐
do.
indicado.
na 1594) runtime.


tangle".
na 1721)
Picture (Página 1774) P P Define la imagen que se muestra en el objeto gráfico en runtime.
ve.
TransparentColor (Página 1914) P, A P, A Determina qué color del gráfico asignado (*.bmp, *.dib) del objeto
indicado se pondrá en "transparente".
na 1953)
UseTransparentColor (Pági‐ P, A P, A Determina si el color especificado con la propiedad "Transparent‐
na 1960) Color" para el objeto indicado debe verse transparente.
tangle".

Tabla 3-44 Métodos

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

HMIGroup
Abreviatura Validez
Pa Panels
A Runtime Advanced


gle".
Name (Página 1749) - - Devuelve el nombre de objeto como STRING.
Width (Página 1983) P P Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
Tabla 3-46 Métodos

HTMLBrowser (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Navegador HTML". El objeto HTMLBrowser forma parte de la lista

ScreenItems.

HMIHTMLBrowser
Abreviatura Validez
Pa Panels
A Runtime Advanced

Address (Página 1554) P, A P, A Determina la dirección web que se debe abrir en el navegador HTML.
gle".


cuentra un objeto.
ShowStatusBar (Pági‐ P P Determina si se muestra la barra de estado.
na 1826)
ShowToolBar (Página 1829) - - Determina si se muestra una barra de herramientas.
*
gle".
Tabla 3-48 Métodos

SetHtml ??

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 forma parte de la lista ScreenItems.

HMIIOField
Abreviatura Validez
Pa Panels
A Runtime Advanced

AboveUpperLimitColor (Pági‐ - - Define el color del objeto indicado para el caso "Rebase por
na 1545) exceso del límite superior".
AcceptOnExit (Página 1546) P P Define si el campo de entrada se confirma automáticamente al
salir de él.
AcceptOnFull (Página 1546) P P Define si se sale automáticamente del campo de entrada con
confirmación una vez que se ha introducido un número deter‐
minado de valores.


AdaptBorder (Página 1552) P P Determina si el borde del objeto indicado se adapta dinámica‐
mente al tamaño del texto.
AskOperationMotive (Página 1564) P P Determina si también se registrará la razón para la utilización
de este objeto.
Authorization (Página 1566) P P Determina los derechos de manejo del objeto indicado en run‐
time.
na 1576)
na 1577)
na 1578)
BackFlashingRate (Página 1579) P P Determina la frecuencia de parpadeo del fondo del objeto indi‐
cado.
BelowLowerLimitColor (Pági‐ - - Define el color del objeto indicado para el caso "Rebase por
na 1584) defecto del límite inferior".
BorderBackColor (Página 1587) P P Define el color de fondo de la línea de borde quebrada del ob‐
jeto indicado.
na 1594) runtime.
BorderFlashingRate (Página 1595) P P Determina la frecuencia de parpadeo de la línea de borde del
objeto indicado.
BottomMargin - - Determina la distancia del texto al borde inferior del objeto.
ClearOnError (Página 1616) P P Determina si se borra automáticamente una entrada errónea
en este objeto.
ClearOnFocus (Página 1616) P P Determina si la entrada del campo se borrará en cuanto se
active el campo E/S.
CursorControl (Página 1631) P P Determina si el puntero del ratón debe saltar al siguiente campo
de la secuencia de tabulación tras salir del campo.
DataFormat (Página 1633) P P Devuelve el tipo de datos del objeto IOField.
EditOnFocus (Página 1643) P P Determina si la entrada de datos es posible de inmediato cuan‐
do el campo de entrada se selecciona con la tecla de tabula‐
ción.


FieldLength (Página 1656) – - Determina que el campo "Longitud de campo de la cadena de
caracteres" sea de sólo lectura.
runtime.
límite.
objeto indicado.
FormatPattern (Página 1675) P P Define el formato del valor de salida.
"Rectangle".
HiddenInput (Página 1685) P P Determina si se muestra el valor mientras se introduce o bien
un * por cada carácter.
HorizontalAlignment (Página 1693) P, A P, A Determina la alineación horizontal del texto dentro del objeto
indicado.
InputValue (Página 1699) P P Define el valor introducido por el usuario en el campo E/S.
LeftMargin - A Determina la distancia del texto al borde izquierdo del objeto.
LogOperation (Página 1725) P P Determina si se emite un aviso al sistema de avisos tras utili‐
zarse este objeto.
LowerLimit (Página 1726) P P Establece el valor límite inferior para valores de entrada.
ProcessValue (Página 1779) P, A P, A Determina el ajuste predeterminado para el valor que debe
mostrarse.
RightMargin - - Determina la distancia del texto al borde derecho del objeto.


ShiftDecimalPoint (Página 1816) - - Determina que el campo "Desplazar coma decimal" sea de sólo
lectura.
ShowBadTagState (Página 1817) P P Determina si el objeto se muestra en gris cuando la variable
vinculada presenta un mal QualityCode o estado.
ShowLeadingZeros - - Determina que se muestren ceros a la izquierda.
TopMargin - - Determina la distancia del texto al borde superior del objeto.
vuelve.
Unit (Página 1950) P P Define la unidad de medida en el objeto "IOField".
UpperLimit (Página 1952) P P Establece el valor límite superior para valores de entrada.
na 1953)
UseTagLimitColors P P Determina si se utilizan los colores configurados en caso de
infracción de límite.
VerticalAlignment (Página 1971) P, A P, A Determina la alineación vertical del texto dentro del objeto in‐
dicado.
"Rectangle".
Tabla 3-50 Métodos

rante el runtime.

3.5.4.2 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 forma parte de la lista ScreenItems.

HMILine
Abreviatura Validez
Pa Panels
A Runtime Advanced

BorderEndStyle (Página 1591) P, A P, A Determina el tipo de finales de línea del objeto indicado.
BorderStyle (Página 1599) P, A P, A Determina el tipo de finales de línea del objeto indicado.


Color (Página 1617) P, A P, A Determina el color de línea del objeto indicado.
EndLeft - - Define la posición X del punto final.
EndStyle (Página 1647) P, A P, A Determina cómo se debe representar el final de línea del objeto in‐
dicado.
EndTop - - Define la posición Y del punto final.
FillStyle A A Define el patrón de relleno del objeto indicado.
na 1664) time.
indicado.
gle".
na 1721)
LineWidth (Página 1723) P, A P, A Determina el grosor de línea del objeto indicado.
RotationAngle (Página 1786) P P Define el ángulo de rotación en grados.
RotationCenterLeft (Pági‐ P P Define la coordenada X del punto en torno al que gira el objeto en
na 1786) runtime.
RotationCenterTop (Pági‐ P P Define la coordenada Y del punto en torno al que gira el objeto en
na 1787) runtime.
StartLeft - - Define la posición X del punto inicial.
StartStyle A A Determina cómo se debe representar el comienzo de línea del objeto
indicado.
StartTop (Página 1834) - - Determina la distancia vertical del punto inicial desde el borde supe‐
rior de la imagen en píxeles.
Style (Página 1847) P, A P, A Establece el estilo de línea del objeto indicado.
gina 1953)


tangle".
Tabla 3-52 Métodos

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
Abreviatura Validez
Pa Panels
A Runtime Advanced

de este objeto.
time.
jeto indicado.
CountVisibleItems (Página 1630) P P Determina cuántas líneas contiene la lista de selección.


"Rectangle".
HorizontalAlignment (Página 1693) P P Determina la alineación horizontal del texto dentro del objeto
indicado.
Index (Página 1697) P P Determina el fondo de los elementos de control de la cuadrícu‐
la.
zarse este objeto.
SelectedIndex (Página 1803) P P Define y devuelve el índice cuyo texto correspondiente se
muestra resaltado en el cuadro combinado o el cuadro de lista.
SelectedText (Página 1801) P P Muestra el texto definido con el atributo "Campo seleccionado"
(SelIndex) que se muestra resaltado en el cuadro combinado
o el cuadro de lista.
vuelve.
na 1953)
"Rectangle".
Tabla 3-54 Métodos


MediaPlayer (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Media Player". El objeto MediaControl forma parte de la lista

"ScreenItems".

HMIMediaControl
Utilización
"Control1":
'VBS60
Dim objControl
Abreviatura Validez
Pa Panels
A Runtime Advanced


AspectRatio P P Determina si la relación de aspecto debe mantenerse en caso de
cambiarse el tamaño.
AutoStart P P Determina que el Media Player se inicie automáticamente.
FileName P, A P, A Define el nombre del archivo que se cargará.
tangle".
PictureSizeMode P P Determina que se muestre la barra de estado.
PlayCount A A Reproduce el archivo varias veces.
PlayEndless P P Determina que el archivo de medios se reproduzca sin fin.
PopupMenuEnabled P P Determina que pueda utilizarse el menú contextual.
ShowControls P, A P, A Determina que se muestre una barra de herramientas.
ShowFeatureBackward P P Determina que se muestre la tecla "Atrás" en runtime.
ShowFeatureForward P P Determina que se muestre la tecla "Adelante" en runtime.
ShowFeatureFullScreen P P Determina que el Media Player pueda cambiarse al modo de pan‐
talla completa.
ShowFeaturePause P P Determina que Media Player pueda cambiarse al modo de pantalla
completa.
ShowFeaturePlay P P Determina que se muestre la tecla "Reproducción" en runtime.
ShowFeatureStop P P Determina que se muestre la tecla "Detener" en runtime.
ShowFeatureVolume P P Establece el volumen.
ShowStatusBar (Página 1826) A A Determina si se muestra la barra de estado.
ShowTracker A A Determina que se muestre la barra de tiempo.
StepSeconds P P Determina el intervalo de tiempo en segundos que se salta al pul‐
sar la tecla "Adelante" o "Atrás".
tangle".

Tabla 3-56 Métodos

MultiLineEdit (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Texto multilínea". El objeto MultiLineEdit forma parte de la lista

ScreenItems.

HMIMultiLineEdit

Utilización
"MultiLineEdit1":
'VBS21
Dim objMultiLineEdit
Set objMultiLineEdit = ScreenItems("MultiLineEdit1")
objMultiLineEdit.Left = objMultiLineEdit.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced

BackColor (Página 1572) P P, A Determina el color de fondo del objeto indicado.
indicado.
BorderColor (Página 1589) P P Determina el color de fondo del objeto indicado.
tangle".
HorizontalAlignment (Pági‐ P P Determina la alineación horizontal del texto dentro del objeto indi‐
na 1693) cado.
na 1721)


na 1953)
tangle".
Tabla 3-58 Métodos

GetSelectionText ??
SetSelection ??
SetSelectionText ??

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

ProgID independiente de la versión
Abreviatura Validez
Pa Panels
A Runtime Advanced

Tabla 3-60 Métodos
Métodos Dinamizable Validez Descripción

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
Abreviatura Validez
Pa Panels
A Runtime Advanced

ApplyProjectSettingsForDesignMode - - Determina que se utilice la configuración del proyecto para
(Página 1564) el diseño.
AutoCompleteColumns (Página 1567) P P Determina si se mostrarán las columnas vacías cuando el
control es más ancho que las columnas configuradas.
AutoCompleteRows (Página 1568) P P Determina si se mostrarán filas vacías cuando el control sea
más largo que el número de filas configuradas.


AutoSelectionColors (Página 1569) P P Define si el color de selección para celda y fila se realizará
con los colores preestablecidos por el sistema.
AutoSelectionRectColor (Página 1569) P P Define si el borde de selección se representará en el color
definido por el sistema.
Caption (Página 1608) P P Determina el texto que se muestra en la barra de título del
objeto indicado.
CellCut (Página 1611) P P Define si el contenido de las celdas se abreviará en caso de
que las celdas sean demasiado estrechas.
CellSpaceBottom (Página 1611) P P Establece la distancia inferior que se utilizará en las celdas
de la tabla.
CellSpaceLeft (Página 1612) P P Establece la sangría izquierda que se utilizará en las celdas
de la tabla.
CellSpaceRight (Página 1612) P P Establece la sangría derecha que se utilizará en las celdas
de la tabla.
CellSpaceTop (Página 1613) P P Establece la distancia superior que se utilizará en las celdas
de la tabla.
ColumnTitleAlignment P P Determina cómo se alinearán los títulos de columnas.
ControlDesignMode (Página 1831) P P Determina el diseño.
EnableEdit (Página 1645) P P Determina si se pueden modificar los datos mostrados en
runtime.
ExportDirectoryChangeable (Pági‐ P P Determina si el directorio para la exportación de datos se
na 1650) puede modificar en runtime.
ExportDirectoryname (Página 1650) P P Determina el directorio al cual se exportarán los datos de
runtime.
ExportFileExtension (Página 1651) P P Establece la extensión del archivo de exportación. Hasta el
momento solamente es compatible la extensión "csv".
ExportFilename (Página 1651) P P Determina el nombre del archivo al cual se exportarán los
datos de runtime.
ExportFilenameChangeable (Pági‐ P P Determina si el nombre del archivo de exportación se puede
na 1652) modificar en runtime.
ExportFormatName (Página 1653) P P Determina el formato de archivo para la exportación. Actual‐
mente sólo está disponible el formato de archivo "csv" para
la exportación.
ExportParameters (Página 1654) P P Establece los parámetros del formato seleccionado median‐
te el cuadro de diálogo "Propiedades".
ExportSelection (Página 1654) P P Establece la extensión del archivo de exportación. Hasta el
ExportShowDialog (Página 1655) P P Determina si el cuadro de diálogo para la exportación de
datos se mostrará en runtime.


"Rectangle".
HorizontalGridLines (Página 1694) P P Determina si se deben visualizar líneas horizontales.
IconSpace (Página 1697) P P Establece la distancia entre símbolo y texto en las celdas de
la tabla.
LoadDataImmediately (Página 1723) P P Determina si los valores de variables para el intervalo de
tiempo que se representa se cargan desde los ficheros al
abrir una imagen.
Online (Página 1757) P P Determina el nombre de la fuente de datos.
RowScrollbar (Página 1788) P P Determina si las barras de desplazamiento de filas se deben
visualizar.
RTPersistence (Página 1789) P P Establece cómo se conservarán las configuraciones online
de WinCC.
RTPersistencePasswordLevel (Pági‐ P P Determina la autorización que es necesaria en runtime para
na 2045) la configuración online.
RTPersistenceType (Página 1790) - - Establece cómo se conservarán las configuraciones online
de WinCC.
SelectedCellForeColor (Página 1802) P P Indica el color de fuente de las celdas marcadas.
SelectedRowForeColor (Página 1804) P P Indica el color de fuente de las filas marcadas.
SelectedTitleForeColor (Página 1806) P P Indica el color de fuente del título de tabla seleccionado.
SelectionColoring (Página 1808) P P Determina si se utilizarán colores de selección para celdas
o filas.
SelectionRect (Página 1809) P P Determina si se utilizará un borde de selección para las cel‐
das o filas seleccionadas.
SelectionRectColor (Página 1810) P P Define el color del rectángulo de selección en la ventana de
avisos cuando SelectionType sea "1".
SelectionRectWidth (Página 1811) P P Establece el grosor de la línea del rectángulo de selección
en la ventana de avisos cuando SelectionType sea "1".


ShowSortButton (Página 1824) P P Determina si se mostrará la tecla de clasificación en la barra
de desplazamiento vertical.
ShowSortIndex (Página 1825) P P Determina si se debe mostrar el símbolo de clasificación.
Sizeable (Página 1830) P P Determina si puede modificarse el tamaño del objeto en run‐
time.
SortSequence (Página 1832) P P Determina cómo se puede modificar la secuencia de clasifi‐
cación haciendo clic con el ratón.
StatusbarBackColor (Página 1835) P P Indica el color de fondo para la barra de estado.
StatusbarElementAdd (Página 1836) * P P Crea un nuevo elemento de la barra de estado definido por
el usuario.
StatusbarElementAutoSize (Pági‐ P P Establece si el ancho del elemento seleccionado de la barra
na 1836) * de estado se ajustará automáticamente.
StatusbarElementCount (Página 1837) * P P Indica el número de elementos configurables de la barra de
estado.
StatusbarElementIconId (Página 1838) * P P Asignación establecida por la clave ID y el símbolo de un
elemento de la barra de estado.
StatusbarElementId (Página 1838) * P P Clave ID unívoca para el elemento seleccionado de la barra
de estado.
StatusbarElementIndex (Página 1839) P P Hace referencia a un elemento de la barra de estado. Esta
propiedad permite asignar los valores de otras propiedades
a un elemento determinado de la barra de estado.
StatusbarElementName (Página 1840) * P P Muestra el nombre de objeto para el elemento seleccionado
na 1840) *
StatusbarElementRename (Pági‐ P P Modifica el nombre del elemento de la barra de estado defi‐
na 1841) * nido por el usuario que está referenciado mediante la pro‐
piedad "StatusbarElementIndex".
StatusbarElements (Página 1841) - - Define los elementos que deben mostrarse en la barra de
estado.
StatusbarElementText * P P Define el texto del elemento de la barra de estado seleccio‐
nado actualmente.
StatusbarElementTooltipText (Pági‐ P P Determina el texto para el tooltip del elemento de la barra de
na 1842) * estado definido por el usuario.
StatusbarElementUserDefined (Pági‐ P P Indica si el elemento de la barra de estado ha sido añadido
na 1842) * por el ingeniero como nuevo elemento definido por el usua‐
rio.
StatusbarElementVisible (Página 1843) P P En la lista, active los elementos de la barra de estado que
* desee mostrar en runtime.
StatusbarElementWidth (Página 1844) * P P Indica el ancho del elemento seleccionado de la barra de
estado en píxeles.
StatusbarFontColor (Página 1844) P P Indica el color de fuente de los textos de la barra de estado.
StatusbarShowTooltips (Página 1845) P P Determina si en runtime se mostrarán los tooltips de los ele‐
mentos de la barra de estado.


StatusbarUseBackColor (Página 1846) P P Determina si se debe visualizar el color de fondo de la barra
de estado.
StatusbarVisible (Página 1847) P P Determina si se debe visualizar la barra de estado del con‐
trol.
TableColor (Página 1850) P P Indica el color de fondo para las filas. Con el botón se abre
el cuadro de diálogo para la selección de color.
TableColor2 (Página 1851) P P Indica el color de fondo del "Color de fila 2".
TableForeColor (Página 1851) P P
TableForeColor2 (Página 1852) P P Indica el color de fuente del "Color de fila 2".
TimeBase (Página 1866) P P Define la zona horaria que sirve de base para mostrar los
valores de tiempo.
TimeColumnActualize (Página 1866) * P P Determina si se actualizarán los valores de la columna se‐
leccionada.
TimeColumnAdd (Página 1867) * P P Crea una nueva columna de tiempo.
TimeColumnAlign (Página 1867) * P P Determina cómo se alineará la columna de tiempo seleccio‐
nada.
TimeColumnBackColor (Página 1868) * P P Indica el color de fondo de la columna de tiempos seleccio‐
nada.
TimeColumnBeginTime (Página 1869) * P P Establece el instante de inicio del intervalo de tiempo para
la columna de tiempo seleccionada.
TimeColumnCaption (Página 1870) * P P Define el nombre de la columna de tiempos.
TimeColumnCount (Página 1870) * P P Indica el número de columnas de tiempo configuradas.
TimeColumnDateFormat (Página 1870) P P Determina qué formato de fecha se utilizará para la visuali‐
* zación de la columna de tiempo seleccionada.
TimeColumnEndTime (Página 1871) * P P Establece el instante final del intervalo de tiempo para la
columna de tiempo seleccionada.
TimeColumnForeColor (Página 1871) * P P Indica el color de fuente de la columna de tiempos seleccio‐
nada.
TimeColumnHideText (Página 1872) * P P Determina si el contenido de la columna de tiempo se mos‐
trará en forma de texto.
TimeColumnHideTitleText (Pági‐ P P Determina si el título de la columna de tiempo se mostrará
na 1873) * en forma de texto.
TimeColumnIndex (Página 1873) P P Hace referencia a una columna de tiempo configurada.
TimeColumnLength (Página 1874) * P P Define el ancho para la columna de tiempos seleccionada.
TimeColumnMeasurePoints (Pági‐ P P Determina el número de puntos de medida que se mostrarán
na 1874) * en la columna de tiempo seleccionada.
TimeColumnName (Página 1874) * P P Especifica el nombre de la columna de tiempo seleccionada.
TimeColumnRangeType (Página 1875) P P Determina el intervalo de tiempo para la columna de tiempo
* seleccionada.
TimeColumnRemove (Página 1875) * P P Elimina la columna de tiempo seleccionada de la lista.
TimeColumnRename (Página 1876) * P P Modifica el nombre de la columna de tiempo que será refe‐
renciada mediante la propiedad "TimeColumnIndex".
TimeColumnRepos (Página 1876) * P P Modifica la secuencia de las columnas de tiempos con las
correspondientes columnas de valor.
TimeColumnShowDate (Página 1877) * P P Determina si se debe mostrar la columna de tiempo selec‐
cionada con fecha y hora.


TimeColumnShowIcon (Página 1877) * P P Determina si el contenido de la columna de tiempo se mos‐
trará como símbolo.
TimeColumnShowTitleIcon (Pági‐ P P Determina si se actualizarán los valores de la columna se‐
na 1878) * leccionada.
TimeColumnSort (Página 1878) * P P Establece cómo se clasificará la columna de tiempo referen‐
ciada en "TimeColumnIndex".
TimeColumnSortIndex (Página 1879) * P P Indica la secuencia de clasificación de la columna de tiempo
referenciada en "TimeColumnIndex".
TimeColumnTimeFormat (Página 1879) P P Determina qué formato de hora se utilizará para la visualiza‐
* ción de la columna tiempo seleccionada.
TimeColumnTimeRangeBase (Pági‐ P P Define la unidad de tiempo para la determinación del inter‐
na 1880) * valo de tiempo.
TimeColumnTimeRangeFactor (Pági‐ P P Define el factor para la determinación del intervalo de tiempo.
na 1880) *
TimeColumnUseValueColumnColors P P Determina si se debe mostrar la columna de tiempo selec‐
(Página 1881) * cionada en el color de la columna de valores.
TimeColumnVisible (Página 1881) * P P En esta lista se mostrarán las columnas de tiempo que haya
creado.
TimeStepBase P P Un intervalo de tiempo se determina mediante una base y
un factor.
TimeStepFactor P P Un intervalo de tiempo se determina mediante una base y
un factor.
TitleCut (Página 1883) P P Determina si los contenidos de los campos de una barra de
título deben acortarse cuando el ancho de columna sea in‐
suficiente.
TitleDarkShadowColor (Página 1884) P P Indica el color para la parte oscura del sombreado.
TitleForeColor (Página 1885) P P Indica el color de fuente del título de la tabla para el estado
seleccionado.
TitleGridLineColor (Página 1885) P P Indica el color de las líneas de separación en el título de la
tabla.
TitleLightShadowColor (Página 1886) P P Indica el color para la parte clara del sombreado.
TitleSort (Página 1887) P P Determina cómo se inicia la clasificación por título de colum‐
na.
TitleStyle (Página 1888) P P Determina qué color de sombreado se usa para el título de
tabla.
ToolbarAlignment (Página 1894) P P Define la posición de la barra de herramientas, o la devuelve.
ToolbarBackColor (Página 1895) P P Indica el color de fondo de la barra de herramientas.
ToolbarButtonActive (Página 1896) * P P Establece si la función enlazada con la tecla está activada
en runtime.
ToolbarButtonAdd (Página 1896) * P P Establece una nueva función de teclas definida por el usua‐
rio.
ToolbarButtonBeginGroup (Pági‐ P P Determina si se añadirá un separador antes de la función de
na 1897) * teclas seleccionada.
ToolbarButtonCount (Página 1898) * P P Indica el número de funciones de tecla configurables.


ToolbarButtonEnabled (Página 1898) * P P Determina si se puede utilizar la tecla definida por el usuario
de la barra de herramientas.
ToolbarButtonHotKey (Página 1899) * P P Muestra la tecla de acceso directo para la función de tecla
seleccionada.
ToolbarButtonId (Página 1899) * P P Clave ID única para la función de tecla seleccionada.
ToolbarButtonIndex (Página 1900) P P Hace referencia a una función de tecla.
ToolbarButtonLocked (Página 1901) * P P Determina si para una tecla de la barra de herramientas de‐
finida por el usuario, se mostrará el estado pulsado (encaja‐
do) de la tecla.
ToolbarButtonName (Página 1901) * P P Muestra el nombre para la función de tecla seleccionada.
ToolbarButtonPasswordLevel (Pági‐ P P Muestra el permiso para la función de tecla seleccionada.
na 1902) *
ToolbarButtonRemove (Página 1902) * P P Elimina la función de tecla seleccionada de la lista.
ToolbarButtonRename (Página 1903) * P P Modifica el nombre del elemento de la barra de herramientas
definido por el usuario que está referenciado mediante la
propiedad "ToolbarButtonIndex".
ToolbarButtonRepos (Página 1904) * P P Modifica la secuencia de las funciones de tecla.
ToolbarButtons - - Determina los botones que están disponibles para la barra
de herramientas.
ToolbarButtonTooltipText (Pági‐ P P Establece el texto para el tooltip de la tecla.
na 1904) *
ToolbarButtonUserDefined (Pági‐ P P Muestra si la tecla de la barra de herramientas ha sido aña‐
na 1905) * dida por el ingeniero como tecla nueva definida por el usua‐
rio.
ToolbarShowTooltips (Página 1905) P P Determina si en runtime se mostrarán los tooltips de las fun‐
ciones de tecla.
ToolbarUseBackColor (Página 1906) P P Determina si se debe visualizar el color de fondo de la barra
de herramientas.
ToolbarUseHotKeys (Página 1907) P P Determina si las teclas de acceso directo están activas para
las funciones de tecla en runtime.
ToolbarVisible (Página 1907) P P Determina si se debe visualizar la barra de herramientas del
control.
UseColumnBackColor P P Determina si está activado el desplazamiento.
UseColumnForeColor P P Define la fuente que se utiliza en la impresión.
UseSelectedTitleColor (Página 1958) P P Determina si se utilizará un color de selección para los títulos
de tabla de celdas seleccionadas.
UseTableColor2 (Página 1959) P P Determina si se utilizará un segundo color de fila en la re‐
presentación de la tabla.
ValueColumnAdd * P P Agrega una columna de valores.
ValueColumnAlign * P P Define la alineación de una columna.
ValueColumnAutoPrecisions * P P Establece si el número de decimales mostrados se determi‐
nará automáticamente.
ValueColumnBackColor * P P Determina el color de fondo.
ValueColumnCaption * P P Define un título.
ValueColumnCount * P P Indica el número de columnas de valores.


ValueColumnExponentialFormat * P P Determina que se utilice la notación exponencial en una co‐
lumna.
ValueColumnForeColor * P P Define el color de primer plano de una columna de valores.
ValueColumnHideText * P P Determina si se muestra el texto.
ValueColumnHideTitleText * P P Determina si se muestra el texto.
ValueColumnIndex P P El índice especifica a qué columna se refieren otras propie‐
dades, como p. ej., el valor inicial.
ValueColumnLength * P P Determina el número de caracteres mostrados.
ValueColumnName * P P Define el nombre de una columna.
ValueColumnPrecisions * P P Determina el número de decimales.
ValueColumnProvider * P P
ValueColumnProviderCLSID * P P Determina la CLSID de proveedor para los datos de una co‐
lumna.
ValueColumnRemove * P P Borra una columna de valores.
ValueColumnRename * P P Cambia el nombre de una columna de valores.
ValueColumnRepos * P P Determina que una columna de valores se posicione de nue‐
vo.
ValueColumnSelectTagName * P P Define una variable.
ValueColumnShowIcon * P P Determina si se mostrará un símbolo.
ValueColumnShowTitleIcon * P P Determina si se mostrará un símbolo en el título.
ValueColumnSort * P P Determina el tipo de clasificación en una columna.
ValueColumnSortIndex * P P Determina el orden en la clasificación.
ValueColumnTagName * P P Determina el nombre de la variable cuyos valores se mues‐
tran en una columna.
ValueColumnTimeColumn * P P Determina la correspondiente columna de tiempo.
ValueColumnVisible * P P Determina la visibilidad de una columna de valores.
"Rectangle".
Tabla 3-62 Métodos

rante el runtime.
AttachDB (Página 2162) P Ejecuta la función del botón "Conectar copia de seguridad" del control.
CalculateStatistic (Página 2162) P Ejecuta la función del botón "Calcular estadística" del visor de curvas f(t) y
del visor de tablas.


Edit (Página 2168) P Ejecuta la función del botón "Editar" del visor de tablas.
Export (Página 2169) P, A Ejecuta la función del botón "Exportar fichero" o "Exportar datos" del control.
GetRow (Página 2180) P Devuelve el objeto de filas designado mediante el número de fila de los con‐
troles basados en tablas como tipo "ICCAxDataRow".
GetRowCollection (Pági‐ P Devuelve el listado de todos los objetos de filas de los controles basados en
na 2182) tablas como tipo "ICCAxDataRowCollection".
GetSelectedRow (Página 2188) P Devuelve como tipo "ICCAxDataRow" el objeto de filas seleccionado de un
control basado en tablas.
GetSelectedRows (Pági‐ P Con selección múltiple, devuelve como tipo "ICCAxDataRow" los objetos de
na 2189) filas seleccionados de un control basado en tablas.
GetStatusbarElement (Pági‐ P, A Devuelve el elemento de la barra de estado designado por nombre o índice
na 2195) del control como tipo "ICCAxStatusbarElement".
GetStatusbarElementCollection P, A Devuelve el listado de todos los elementos de la barra de estado del control
(Página 2196) como tipo "ICCAxCollection".
GetTimeColumn (Página 2201) P Devuelve el objeto de columna de tiempo designado por nombre o índice del
visor de tablas como tipo "ICCAxTimeColumn".
GetTimeColumnCollection (Pá‐ P Devuelve el listado de todos los objetos de columna de tiempo del visor de
gina 2202) tablas como tipo "ICCAxCollection".
GetToolbarButton (Pági‐ P, A Devuelve la función de tecla designada por nombre o índice de la barra de
na 2203) herramientas del control como tipo "ICCAxToolbarButton".
GetToolbarButtonCollection P, A Devuelve el listado de todas las funciones de tecla de la barra de herramien‐
(Página 2205) tas del control como tipo "ICCAxCollection".
GetValueColumn (Página 2213) P Devuelve el objeto de columna de valores designado por nombre o índice del
visor de curvas f(t) como tipo "ICCAxValueColumn".
GetValueColumnCollection (Pá‐ P Devuelve el listado de todos los objetos de columna de valores del visor de
gina 2214) curvas f(t) como tipo "ICCAxCollection".
MoveToFirst (Página 2225) P Ejecuta la función del botón "Primera fila" del control.
MoveToLast (Página 2226) P Ejecuta la función del botón "Último registro" del control.
MoveToNext (Página 2228) P Ejecuta la función del botón "Registro siguiente" del control.
MoveToPrevious (Página 2229) P Ejecuta la función del botón "Registro anterior" del control.
NextColumn (Página 2231) P Ejecuta la función del botón "Columna siguiente" del visor de tablas.
PreviousColumn (Página 2233) P Ejecuta la función del botón "Columna anterior" del visor de tablas.
SelectStatisticArea (Pági‐ P Ejecuta la función del botón "Definir área estadística" del visor de tablas.
na 2249)
ShowColumnSelection (Pági‐ P Ejecuta la función del botón "Seleccionar columnas" del visor de tablas.
na 2251)
ShowPropertyDialog (Pági‐ P, A Ejecuta la función del botón "Diálogo de configuración" del control.
na 2258)
ShowTagSelection (Pági‐ P, A Ejecuta la función del botón "Seleccionar conexión de datos" del control.
na 2262)
ShowTimeSelection (Pági‐ P, A Ejecuta la función del botón "Rango de tiempo Seleccionar" del control.
na 2263)


UnselectRow (Página 2267) P Elimina las marcas de una determinada celda de un control basado en tablas.
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

la lista ScreenItems.

HMIOnlineTrendControl
Abreviatura Validez
Pa Panels
A Runtime Advanced


(Página 1564) el diseño.
objeto indicado.
ConnectTrendWindows (Página 1626) P P Determina si se enlazan los visores de curvas configurados.
runtime.
ExportFileExtension (Página 1651) P P Establece la extensión del archivo de exportación. Hasta el
datos de runtime.
ExportFilenameChangeable (Pági‐ P P Determina si el nombre del archivo de exportación se puede
na 1652) modificar en runtime.
ExportFormatName (Página 1653) P P Determina el formato de archivo para la exportación. Actual‐
mente sólo está disponible el formato de archivo "csv" para
la exportación.
ExportParameters (Página 1654) P P Establece los parámetros del formato seleccionado mediante
el cuadro de diálogo "Propiedades".
ExportSelection (Página 1654) P P Establece la extensión del archivo de exportación. Hasta el
ExportShowDialog (Página 1655) P P Determina si el cuadro de diálogo para la exportación de da‐
tos se mostrará en runtime.
GraphDirection (Página 1677) P P Determina el borde de la ventana de curvas en el que se
muestran los valores actuales.
"Rectangle".
LineColor (Página 1721) P P Indica el color de las líneas de separación de la ventana.
LineWidth P P Determina el grosor de línea del objeto indicado.
LoadDataImmediately (Página 1723) P P Determina si los valores de variables para el intervalo de
tiempo que se representa se cargan desde los ficheros al
abrir una imagen.


Online (Página 1757) P P Determina el nombre de la fuente de datos.
PercentageAxis P P Determina que un eje se muestre con una escala porcentual.
PercentageAxisAlign P P
PercentageAxisColor P P Define el color del eje porcentual.
RTPersistence (Página 1789) P P Establece cómo se conservarán las configuraciones online
de WinCC.
RTPersistencPasswordLevel (Pági‐ P P Determina la autorización que es necesaria en runtime para
na 2045) la configuración online.
RTPersistenceType (Página 1790) - - Establece cómo se conservarán las configuraciones online
de WinCC.
ShowRuler (Página 1822) P P Determina si se muestra una escala graduada (línea auxiliar)
para la rotulación de eje del objeto "OnlineTrendControl".
ShowRulerInAxis (Página 1823) P P Determina si la regla se mostrará también en el eje de tiem‐
pos.
ShowScrollbars (Página 1824) P P Determina el tipo de barra de desplazamiento.
ShowStatisticRuler P P Define el Statement SQL.
ShowTrendIcon (Página 1829) P P Determina si debajo de los ejes de valores se mostrará un
símbolo.
Sizeable (Página 1830) P P Determina si puede modificarse el tamaño del objeto en run‐
time.
StatusbarElementAdd (Página 1836) * P P Crea un nuevo elemento de la barra de estado definido por
el usuario.
StatusbarElementAutoSize (Pági‐ P P Establece si el ancho del elemento seleccionado de la barra
na 1836) * de estado se ajustará automáticamente.
StatusbarElementCount (Pági‐ P P Indica el número de elementos configurables de la barra de
na 1837) * estado.
StatusbarElementIconId (Pági‐ P P Asignación establecida por la clave ID y el símbolo de un
na 1838) * elemento de la barra de estado.
StatusbarElementId (Página 1838) * P P Clave ID unívoca para el elemento seleccionado de la barra
de estado.
propiedad permite asignar los valores de otras propiedades
a un elemento determinado de la barra de estado.
StatusbarElementName (Pági‐ P P Muestra el nombre de objeto para el elemento seleccionado
na 1840) * de la barra de estado.
na 1840) *
StatusbarElementRename (Pági‐ P P Modifica el nombre del elemento de la barra de estado defi‐
na 1841) * nido por el usuario que está referenciado mediante la propie‐
dad "StatusbarElementIndex".


estado.
StatusbarElementText * P P Define el texto del elemento de la barra de estado seleccio‐
nado actualmente.
StatusbarElementTooltipText (Pági‐ P P Determina el texto para el tooltip del elemento de la barra de
na 1842) * estado definido por el usuario.
na 1842) * por el ingeniero como nuevo elemento definido por el usuario.
StatusbarElementVisible (Pági‐ P P En la lista, active los elementos de la barra de estado que
na 1843) * desee mostrar en runtime.
StatusbarElementWidth (Pági‐ P P Indica el ancho del elemento seleccionado de la barra de
na 1844) * estado en píxeles.
StatusbarShowTooltips (Página 1845) P P Determina si en runtime se mostrarán los tooltips de los ele‐
mentos de la barra de estado.
StatusbarUseBackColor (Pági‐ P P Determina si se debe visualizar el color de fondo de la barra
na 1846) de estado.
StatusbarVisible (Página 1847) P P Determina si se debe visualizar la barra de estado del con‐
trol.
TimeAxes - - Establece ajustes para ejes de tiempo.
TimeAxisActualize * P P
TimeAxisAdd * P P Agrega un eje.
TimeAxisAlignment * P P Define la alineación de un eje.
TimeAxisBeginTime (Página 1863) * P P Define el punto de inicio de la representación de la curva
indicada.
TimeAxisColor * P P Define el color de un eje.
TimeAxisCount * P P Indica el número de ejes de tiempo.
TimeAxisDateFormat * P P Determina el formato para la indicación de fecha.
TimeAxisEndTime (Página 1864) * P P Define el instante final de la representación de la curva indi‐
cada.
TimeAxisIndex P P El índice especifica a qué eje se refieren otras propiedades,
como p. ej., el valor inicial.
TimeAxisInTrendColor * P P Determina que se utilice el color de la curva para un eje.
TimeAxisLabel (Página 1864) * P P Define el nombre del eje de tiempo. El dato se evaluará o no
dependiendo de la propiedad "ConfigureTimeAxis(i)".
TimeAxisMeasurePoints * P P Define los puntos de medida.
TimeAxisName * P P Define el nombre de un eje.
TimeAxisRangeType * P P Determina el tipo de intervalo de tiempo.
TimeAxisRemove * P P Borra un eje de tiempo.
TimeAxisRename * P P Cambia el nombre de un eje de tiempo.
TimeAxisRepos * P P Determina que el eje de tiempo se posicione de nuevo.
TimeAxisShowDate * P P Determina que se muestre la fecha.
TimeAxisTimeFormat (Página 1865) * P P Determina el formato para la indicación de hora.


TimeAxisTimeRangeBase * P P Un intervalo de tiempo se determina mediante una base y un
factor.
TimeAxisTimeRangeFactor * P P Un intervalo de tiempo se determina mediante una base y un
factor.
TimeAxisTrendWindow * P P Define el diagrama.
TimeAxisVisible * P P Determina que el eje de tiempo sea visible.
TimeBase (Página 1866) P P Define la zona horaria que sirve de base para mostrar los
valores de tiempo.
ToolbarAlignment (Página 1894) P P Define la posición de la barra de herramientas, o la devuelve.
en runtime.
ToolbarButtonAdd (Página 1896) * P P Establece una nueva función de teclas definida por el usua‐
rio.
ToolbarButtonBeginGroup (Pági‐ P P Determina si se añadirá un separador antes de la función de
na 1897) * teclas seleccionada.
ToolbarButtonEnabled (Página 1898) P P Determina si se puede utilizar la tecla definida por el usuario
* de la barra de herramientas.
seleccionada.
ToolbarButtonLocked (Página 1901) * P P Determina si para una tecla de la barra de herramientas de‐
finida por el usuario, se mostrará el estado pulsado (encaja‐
do) de la tecla.
na 1902) *
ToolbarButtonRemove (Página 1902) P P Elimina la función de tecla seleccionada de la lista.
*
ToolbarButtonRename (Página 1903) P P Modifica el nombre del elemento de la barra de herramientas
* definido por el usuario que está referenciado mediante la
propiedad "ToolbarButtonIndex".
de herramientas.
na 1904) *
ToolbarButtonUserDefined (Pági‐ P P Muestra si la tecla de la barra de herramientas ha sido aña‐
na 1905) * dida por el ingeniero como tecla nueva definida por el usua‐
rio.
ToolbarShowTooltips (Página 1905) P P Determina si en runtime se mostrarán los tooltips de las fun‐
ciones de tecla.


ToolbarUseBackColor (Página 1906) P P Determina si se debe visualizar el color de fondo de la barra
de herramientas.
ToolbarUseHotKeys (Página 1907) P P Determina si las teclas de acceso directo están activas para
las funciones de tecla en runtime.
ToolbarVisible (Página 1907) P P Determina si se debe visualizar la barra de herramientas del
control.
TrendAdd (Página 1917) * P P Crea una curva nueva.
TrendAutoRangeBeginTagName * P P Determina una variable que define el valor inicial.
TrendAutoRangeBeginValue * P P Define el valor inicial para el área de visualización adaptada
automáticamente.
TrendAutoRangeEndTagName * P P Determina una variable que define el valor final.
TrendAutoRangeEndValue * P P Determina una variable que define el valor final.
TrendAutoRangeSource * P P Define una fuente para el área de visualización.
TrendColor * P P Define el color del visor de tendencias o lo devuelve.
TrendCount (Página 1918) * P P Indica el número de curvas configuradas.
TrendExtendedColorSet (Pági‐ P P Determina si se puede configurar el color de punto y el color
na 1919) * de relleno y si se mostrarán los colores en runtime.
TrendFill (Página 1920) * P P Determina si se debe mostrar rellena la superficie debajo de
la curva.
TrendFillColor (Página 1920) * P P Indica el color de relleno de la curva.
TrendIndex (Página 1921) P P Hace referencia a una curva configurada.
TrendLabel (Página 1922) * P P Define el nombre de la curva seleccionada.
TrendLineStyle (Página 1923) * P P Determina qué tipo de línea se utilizará para la representa‐
ción de la curva.
TrendLineType (Página 1923) * P P Determina cómo se debe mostrar la curva.
TrendLineWidth (Página 1924) * P P Establece el grosor de la línea mostrada.
TrendLowerLimit (Página 1924) * P P Indica el valor límite inferior para una variable.
TrendLowerLimitColor (Página 1925) P P Establece el color que marca los valores de variable que se
* encuentran por debajo del valor de "TrendLowerLimit".
TrendLowerLimitColoring (Pági‐ P P Define si el borde de selección se representará en el color
na 1925) * definido por el sistema.
TrendName (Página 1926) * P P Muestra el nombre de la curva seleccionada.
TrendPointColor (Página 1927) * P P Indica el color de los puntos de la curva.
TrendPointStyle (Página 1928) * P P Determina cómo se mostrarán los puntos en la curva.
TrendPointWidth (Página 1928) * P P Establece el ancho de punto en píxeles.
TrendProvider (Página 1929) * P P Define el origen de datos de la curva seleccionada.
TrendProviderCLSID * P P Determina la CLSID de proveedor para los datos de una cur‐
va.
TrendRemove (Página 1930) * P P Elimina las curvas seleccionadas de la lista.
TrendRename (Página 1930) * P P Modifica el nombre de la curva que será referenciada me‐
diante la propiedad "TrendIndex".
TrendRepos (Página 1931) * P P Modifica la secuencia de la curva seleccionada en la ventana
de curvas.
TrendSelectTagName * P P Define una variable.


TrendTagName * P P Define el nombre de una variable para la dirección Y.
TrendTimeAxis * P P Define el eje de tiempo.
TrendTrendWindow (Página 1934) * P P Determina en qué ventana de curvas se mostrará la curva
seleccionada.
TrendUncertainColor (Página 1935) * P P Los valores tienen un estado inseguro, si el valor inicial des‐
pués de activar runtime es desconocido o se utilizará un valor
de sustitución.
TrendUncertainColoring (Pági‐ P P Los valores tienen un estado inseguro, si el valor inicial des‐
na 1936) * pués de activar runtime es desconocido o se utilizará un valor
de sustitución.
TrendUpperLimit (Página 1936) * P P Indica el valor límite superior para una variable. Si la variable
no alcanza el valor de "TrendUpperLimit", se marcarán los
valores con el color configurado en "TrendUpperLimitColor".
TrendUpperLimitColor (Página 1937) P P Establece el color que marca los valores de variable que se
* encuentran por debajo del valor de "TrendLowerLimit".
TrendUpperLimitColoring (Pági‐ P P Define si el borde de selección se representará en el color
na 1937) * definido por el sistema.
TrendValueAxis * P P Define el eje de valores.
TrendVisible (Página 1938) * P P En esta lista se mostrarán las curvas que haya creado.
TrendWindowAdd (Página 1938) * P P Crea un nuevo visor de curvas.
TrendWindowCoarseGrid (Pági‐ P P Determina si se mostrarán las líneas de cuadrícula para la
na 1939) * escala principal.
TrendWindowCoarseGridColor (Pági‐ P P Indica el color de las líneas de cuadrícula para la escala prin‐
na 1939) * cipal.
TrendWindowCount * P P Indica el número de diagramas.
TrendWindowFineGrid (Página 1940) P P Determina si se mostrarán las líneas de cuadrícula para la
* escala auxiliar.
TrendWindowFineGridColor (Pági‐ P P Indica el color de las líneas de cuadrícula para la escala au‐
na 1941) * xiliar.
TrendWindowForegroundTrendGrid P P Determina si se mostrarán solamente las líneas de cuadrícu‐
(Página 1941) * la para la curva de primer plano de la ventana de curvas
seleccionada.
TrendWindowGridInTrendColor (Pági‐ P P Determina si se mostrarán las líneas de cuadrícula para la
na 1942) * escala principal en el color de la curva.
TrendWindowHorizontalGrid (Pági‐ P P Determina si se mostrarán las líneas de cuadrícula horizon‐
na 1942) * tales.
TrendWindowIndex (Página 1943) P P Hace referencia a una ventana de curvas configurada.
TrendWindowName (Página 1943) * P P Establece el nombre de la ventana de curvas seleccionada.
TrendWindowRemove (Página 1944) P P Elimina el visor de curvas seleccionado de la lista.
*
TrendWindowRename (Página 1944) P P Modifica el nombre de la ventana de curvas que será refe‐
* renciado mediante la propiedad "TrendWindowIndex".
TrendWindowRepos (Página 1945) * P P Modifica la secuencia del visor de curvas.
TrendWindowRulerColor (Pági‐ P P Indica el color de la regla.
na 1945) *
TrendWindowRulerLayer (Pági‐ P P Determina el nivel de representación de la regla en el visor
na 1946) * de curvas.


TrendWindowRulerStyle (Pági‐ P P Establece la representación de la regla.
na 1947) *
TrendWindowRulerWidth (Pági‐ P P Define en píxeles el grosor de la regla.
na 1947) *
TrendWindows - - Establece ajustes para diagramas.
TrendWindowSpacePortion (Pági‐ P P Establece la porción de la ventana de curvas seleccionada
na 1948) * en la representación en el control.
TrendWindowStatisticRulerColor * P P Define el color de la regla de estadística.
TrendWindowStatisticRulerStyle * P P Define el estilo de la regla de estadística.
TrendWindowStatisticRulerWidth * P P Determina el ancho de la regla de estadística.
TrendWindowVerticalGrid (Pági‐ P P Determina si se mostrarán las líneas de cuadrícula verticales.
na 1948) *
TrendWindowVisible (Página 1949) * P P En esta lista se mostrarán los visores de curvas que se hayan
creado.
UseTrendNameAsLabel (Pági‐ P P Determina si las propiedades "Nombre" o "Rotulación" se uti‐
na 1962) lizarán como nombre de la curva en runtime.
ValueAxes - - Establece ajustes para ejes de valores.
ValueAxisAdd * P P Agrega un eje.
ValueAxisAlignment * P P Define la alineación de un eje.
ValueAxisAutoPrecisions * P P Determina que se adapte automáticamente el número de de‐
cimales mostrados de un eje.
ValueAxisAutoRange * P P Establece que el rango de valores se determine automática‐
mente.
ValueAxisBeginValue * P P Define el valor inicial de un eje.
ValueAxisColor * P P Define el color de un eje de valores.
ValueAxisCount * P P Indica el número de ejes de valores.
ValueAxisEndValue * P P Define el valor final de un eje.
ValueAxisExponentialFormat * P P Determina que la rotulación de un eje utilice la notación ex‐
ponencial.
ValueAxisIndex P P El índice especifica a qué eje se refieren otras propiedades,
como p. ej., el valor inicial.
ValueAxisInTrendColor * P P Determina que se utilice el color de la curva para un eje.
ValueAxisLabel (Página 1969) * P P Define el nombre del eje de valores.
ValueAxisName * P P Define el nombre de un eje.
ValueAxisPrecisions * P P Determina el número de decimales mostrados.
ValueAxisRemove * P P Cambia el nombre de un eje.
ValueAxisRename * P P Cambia el nombre de un eje.
ValueAxisRepos * P P Determina que el eje de valores se posicione de nuevo.
ValueAxisScalingType (Página 1970) P P Determina el tipo de escala de los ejes.
*
ValueAxisTrendWindow * P P Define el diagrama.
ValueAxisVisible * P P Determina si un eje de valores es visible.
"Rectangle".

* No visible en ES
Tabla 3-64 Métodos

durante el runtime.
CalculateStatistic (Página 2162) P Ejecuta la función del botón "Calcular estadística" del visor de curvas f(t) y
del visor de tablas.
DeactivateDynamic (Pági‐ P Desactiva en/durante el runtime el disparador usado del método "Activa‐
na 2165) teDynamic" para la propiedad fijada.
GetRulerData (Página 2187) P Devuelve el valor de la curva solicitada en la posición de la regla.
GetTimeAxis (Página 2198) P Devuelve el objeto de eje de tiempo designado por nombre o índice del visor
de curvas f(t) como tipo "ICCAxTimeAxis".
GetTimeAxisCollection (Pági‐ P Devuelve el listado de todos los objetos de eje de tiempo del visor de curvas
na 2199) f(t) como tipo "ICCAxCollection".
GetToolbarButton (Pági‐ P Devuelve la función de tecla designada por nombre o índice de la barra de
GetToolbarButtonCollection (Pá‐ P Devuelve el listado de todas las funciones de tecla de la barra de herramien‐
gina 2205) tas del control como tipo "ICCAxCollection".
GetTrend (Página 2206) P, A Devuelve la curva designada por nombre o índice del visor de curvas f(t) o
f(x) como tipo "ICCAxTrend" o "ICCAxFunctionTrend".
GetTrendCollection (Pági‐ P, A Devuelve el listado de todas las curvas del visor de curvas f(t) o f(x) como
na 2207) tipo "ICCAxCollection".
GetTrendWindow (Página 2208) P, A Devuelve el objeto de ventana de curvas designado por nombre o índice del
visor de curvas f(t) o f(x) como tipo "ICCAxTrendWindow".
GetTrendWindowCollection (Pá‐ P, A Devuelve el listado de todos los objetos de ventana de curvas del visor de
gina 2209) curvas f(t) o f(x) como tipo "ICCAxCollection".
GetValueAxis (Página 2210) P Devuelve el objeto de eje de valores designado por nombre o índice del visor
de curvas f(t) como tipo "ICCAxValueAxis".
GetValueAxisCollection (Pági‐ P Devuelve el listado de todos los objetos de eje de valores del visor de curvas
na 2212) f(t) como tipo "ICCAxCollection".
MoveAxis (Página 2224) P, A Ejecuta la función del botón "Desplazar área del eje" de los visores de curvas
f(t) y f(x).
MoveToPrevious (Página 2229) P Ejecuta la función del botón "Registro anterior" del control.


NextTrend (Página 2231) P, A Ejecuta la función del botón "Siguiente curva" de los visores de curvas f(t) y
f(x).
OneToOneView (Página 2232) P, A Ejecuta la función del botón "Vista original" de los visores de curvas f(t) y f(x).
PreviousTrend (Página 2233) P, A Ejecuta la función del botón "Curva anterior" de los visores de curvas f(t) y
f(x).
ShowPercentageAxis (Pági‐ P Ejecuta la función del botón "Eje relativo" del visor de curvas f(t).
na 2257)
na 2258)
ShowTagSelection (Pági‐ P, A Ejecuta la función del botón "Seleccionar conexión de datos" del control.
na 2262)
ShowTimeSelection (Pági‐ P, A Ejecuta la función del botón "Rango de tiempo Seleccionar" del control.
na 2263)
ShowTrendSelection (Pági‐ P, A Ejecuta la función del botón "Seleccionar curvas" de los visores de curvas
na 2263) f(t) y f(x).
ZoomArea (Página 2271) P, A Ejecuta la función del botón "Ampliar sección" de los visores de curvas f(t) y
f(x).
ZoomInOut (Página 2272) P, A Ejecuta la función del botón "Zoom +/-" de los visores de curvas f(t) y f(x).
ZoomInOutTime (Página 2272) P Ejecuta la función del botón "Zoom eje de tiempos +/-" del visor de curvas
f(t).
ZoomInOutValues (Pági‐ P Ejecuta la función del botón "Zoom eje de valores +/-" del visor de curvas f(t).
na 2273)
ZoomMove (Página 2274) P, A Ejecuta la función del botón "Desplazar área de curva" 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.

HMIOptionGroup
Abreviatura Validez
Pa Panels
A Runtime Advanced

AdaptBorder (Página 1552) P P Determina si el borde del objeto indicado se adapta dinámi‐
camente al tamaño del texto.
runtime.


na 1576)
na 1577)
BackFlashingEnabled (Pági‐ P P Determina si el fondo del objeto indicado parpadea en runti‐
na 1578) me.
BackFlashingRate (Página 1579) P P Determina la frecuencia de parpadeo del fondo del objeto
indicado.
objeto indicado.
BorderFlashingRate (Página 1595) P P Determina la frecuencia de parpadeo de la línea de borde
CheckmarkAlignment (Pági‐ P P Determina si los campos se disponen justificados a la dere‐
na 1615) cha.
CheckmarkCount (Página 1615) P P Determina el número de campos.
Enabled (Página 1644) P P Determina si el objeto indicado se puede manejar en runti‐
me.
FlashingEnabled (Página 1664) P P Determina si la línea de borde del objeto indicado parpadea
en runtime.
FlashingRate (Página 1665) P P Determina la frecuencia de parpadeo de la línea de borde
FontBold (Página 1671) P P Determina si el texto del objeto indicado se muestra en ne‐
grita.
FontItalic (Página 1671) P P Determina si el texto del objeto indicado se muestra en cur‐
siva.


FontUnderline (Página 1673) P P Determina si el texto del objeto indicado se muestra subra‐
yado.
"Rectangle".
indicado.
Index (Página 1697) P P Determina el fondo de los elementos de control de cuadrícu‐
la.
LineEndShapeStyle (Página 1721) - - Determina la forma de los finales de línea.
LogOperation (Página 1725) P P Determina si se emite un aviso al sistema de avisos tras
utilizarse este objeto.
ProcessValue (Página 1779) P P Determina el ajuste predeterminado para el valor que debe
mostrarse.
vuelve.
na 1953)
VerticalAlignment (Página 1971) P P Determina la alineación vertical del texto dentro del objeto
indicado.
"Rectangle".

Tabla 3-66 Métodos

Polygon (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Polygon". El objeto Polygon forma parte de la lista ScreenItems.

HMIPolygon
Abreviatura Validez
Pa Panels
A Runtime Advanced


ActualPointIndex (Página 1550) P P Determina el número del vértice actual del objeto indicado.
ActualPointLeft (Página 1551) P P Determina la coordenada X del vértice actual en referencia al origen
de la imagen.
ActualPointTop (Página 1551) P P Determina la coordenada Y del vértice actual en referencia al origen
de la imagen.
indicado.
na 1594) runtime.
na 1595) indicado.
runtime.
indicado.
tangle".
na 1721)
Points - - Define los vértices.


PointsCount (Página 1777) P - Determina el número de vértices de la línea poligonal o del polígo‐
no.
na 1786) runtime.
na 1787) runtime.
na 1953)
UseDesignShadowSettings (Pá‐ P P Determina si el objeto se representa con el sombreado fijado en el
gina 1955) diseño activo.
tangle".
Tabla 3-68 Métodos


Polyline (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Polilínea". El objeto Polyline forma parte de la lista ScreenItems.

HMIPolyline
Abreviatura Validez
Pa Panels
A Runtime Advanced

ActualPointIndex (Pági‐ P P Determina el número del vértice actual del objeto indicado.
na 1550)
ActualPointLeft (Pági‐ P P Determina la coordenada X del vértice actual en referencia al origen
na 1551) de la imagen.
ActualPointTop (Pági‐ P P Determina la coordenada Y del vértice actual en referencia al origen
na 1551) de la imagen.


BorderEndStyle (Pági‐ P, A P Determina el tipo de finales de línea del objeto indicado.
na 1591)
BorderStyle (Página 1599) P, A P Determina el tipo de líneas de borde del objeto indicado.
Color (Página 1617) P, A P, A Determina el color de línea del objeto indicado.
EndStyle (Página 1647) A A Determina cómo se debe representar el final de línea del objeto indi‐
cado.
FillStyle A A Define el patrón de relleno del objeto indicado.
FlashingEnabled (Pági‐ P P Determina si la línea de borde del objeto indicado parpadea en runti‐
na 1664) me.
indicado.
gle".
na 1721)
LineWidth (Página 1723) P, A P, A Determina el grosor de línea del objeto indicado.
PointsCount (Página 1777) P - Determina el número de vértices de la línea poligonal o del polígono.
RotationAngle (Pági‐ P P Define el ángulo de rotación en grados.
na 1786)
na 1786) runtime.
na 1787) runtime.
StartStyle A A Determina cómo se debe representar el comienzo de línea del objeto
indicado.
Style (Página 1847) A A Establece el estilo de línea del objeto indicado.
Transparency (Pági‐ P P Determina el porcentaje de transparencia del objeto, y lo devuelve.
na 1912)
UseDesignColorSchema P P Define la fuente que se utiliza en la impresión.
(Página 1953)


gle".
Tabla 3-70 Métodos

ProjectName (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Nombre del proyecto". El objeto ProjectName forma parte de la lista
ScreenItems.

Abreviatura Validez
Pa Panels
A Runtime Advanced

BackColor - - Determina el color de fondo del objeto indicado.
BackFillStyle - - Define el patrón de relleno del objeto indicado.
BorderBackColor (Pági‐ - - Define el color de fondo de la línea de borde quebrada del objeto
na 1587) indicado.
BorderColor - - Determina el color de línea del objeto.
BorderWidth - - Determina el grosor de línea del objeto.
EdgeStyle (Página 1641) - Establece el estilo de línea del objeto indicado.
FillPatternColor (Página 1657) - - Establece el color del patrón de relleno del objeto indicado.
FontBold (Página 1671) - - Determina si el texto del objeto indicado se muestra en negrita.
FontItalic (Página 1671) - - Determina si el texto del objeto indicado se muestra en cursiva.
FontName (Página 1672) - - Establece la fuente del objeto indicado.
FontSize (Página 1673) - - Establece el tamaño de fuente del texto del objeto indicado.
FontUnderline (Página 1673) - - Determina si el texto del objeto indicado se muestra subrayado.
ForeColor - - Establece el color de fuente del texto del objeto indicado.
Format - - Determina que se muestre el formato del bloque de texto.
Height (Página 1679) - - Define la altura en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
HorizontalAlignment - - Determina la alineación horizontal del texto dentro del objeto indica‐
do.
Left (Página 1710) - - Define el valor de la coordenada X del objeto.
LineWrap - - Define el salto de línea dentro de un objeto.
Name (Página 1749) - - Devuelve el nombre de objeto como STRING.
Top (Página 1909) - - Define el valor de la coordenada Y del objeto.
VerticalAlignment - - Determina la alineación vertical del texto dentro del objeto indicado.
Visible (Página 1973) - - Determina si el objeto indicado es visible.
Width (Página 1983) - - Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
Ninguna de las propiedades es visible en el ES.

Tabla 3-72 Métodos
ProtectedAreaName (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Nombre (RFID)". El objeto ProtectedAreaName es un
elemento de la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced

gle".


cuentra un objeto.
gle".
Tabla 3-74 Métodos
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
Abreviatura Validez
Pa Panels
A Runtime Advanced


gle".
gle".
Tabla 3-76 Métodos

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
Abreviatura Validez
Pa Panels
A Runtime Advanced

tangle".
tangle".
Tabla 3-78 Métodos

RecipeView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de recetas". El objeto RecipeView forma parte de la lista

ScreenItems.
Si se modifican los ajustes de este objeto con una función definida por el usuario, éstos se
conservarán incluso después de volver a llamar la imagen con este objeto.
Nota
El objeto "Visor de recetas simple" no se puede dinamizar mediante un script de usuario.
Abreviatura Validez
Pa Panels
A Runtime Advanced


AllowEdit - - Determina que sea posible editar.
Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en runti‐
me.
BackButtonVisible - - Determina que se muestre el botón "Atrás".
ComboboxFont - - Define la fuente de la lista de selección.
DataRecordNameCaption - - Define la rotulación para el nombre del registro.
DataRecordNrCaption - - Define la rotulación para el número del registro.
Display3D - - Define la vista tridimensional.
DisplayButton2Plc - - Determina que se muestre el botón "Escribir en controlador".
DisplayButtonComparison - - Determina que se muestre el botón "Sincronización".
DisplayButtonDelete - - Determina que se muestre el botón "Borrar registro".
DisplayButtonFromPlc - - Determina que se muestre el botón "Leer del controlador".
DisplayButtonHelp - - Determina que se muestre el botón "Tooltip".
DisplayButtonNew - - Determina que se muestre el botón "Agregar registro".
DisplayButtonSave - - Determina que se muestre el botón "Guardar".
DisplayButtonSaveAs - - Determina que se muestre el botón "Guardar como".
DisplayComboBox - - Determina que se muestre la lista de selección.
DisplayGridLines - - Determina que se muestren las líneas de cuadrícula.
DisplayLabeling - - Determina que se muestren las rotulaciones.
DisplayNumbers - - Determina que se muestren los números.
DisplaySize * - -
DisplayStatusBar - - Determina que se muestre la barra de estado.
DisplayTable - - Determina que se muestre la tabla.
EntryNameCaption - - Define la rotulación del nombre del elemento de receta.
EntryValueColFirst - - Determina que la columna "Valor de entrada" sea la primera.
EntryValueFieldLength - - Define la longitud de campo del valor del elemento.
EntryValuePos - - Determina la posición del primer valor.
al contenido.
FixedRecipeNumber * - -
ForeColor A A Establece el color de fuente del texto del objeto indicado.
HeaderFont - - Define la fuente del título.


Height (Página 1679) A - Define la altura en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
KeyboardOnline - - Determina que puedan utilizarse las combinaciones de teclas.
ListAreaHeight - -
ListAreaWidth - -
MenuButtonVisible - - Determina que los botones del menú sean visibles.
NameColumnWidth - -
NumberOfLines - - Determina para el objeto Lista de textos cuántas líneas debe in‐
cluir la lista de selección, o devuelve el valor.
Recipe - - Define la receta.
RecipeNameCaption - - Define la rotulación del nombre de la receta.
RecipeNameSelected * - -
RecipeNrCaption - - Determina que la columna "Número de receta" sea la primera.
RecipeNrColFirst - - Determina que la columna "Número de receta" sea la primera.
RecipeVarSelected * - -
Record * - -
RecordNameSelected * - -
RecordNrColFirst - - Determina que la columna "Número de registro" sea la primera.
RecordVarSelected * - -
RenameButtonVisible - - Determina que se muestre el botón "Cambiar nombre".
na 1807)
na 1809)
StatusFont - -
indicado.
TableForeColor A A
TableGridlineColor (Pági‐ A A Establece el color de las líneas de cuadrícula.
na 1853)
na 1854) indicado.
na 1854) indicado.
ValueCaption - - Define la rotulación de los valores.
ValueColumnWidth - -
VerticalScrolling - - Determina que el objeto tenga una barra de desplazamiento ver‐
tical.
ViewType - - Determina el tipo de visor de avisos.
ViewTypeForSaveStream * - - Determina el tipo de visor para el Save Stream.


Visible (Página 1973) A A Determina si el objeto indicado es visible.
VisibleItems - - Define el número de entradas visibles.
Width (Página 1983) A - Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rec‐
tangle".
Tabla 3-80 Métodos

Rectangle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Rectángulo". El objeto Rectangle forma parte de la lista ScreenItems.

HMIRectangle
Abreviatura Validez
Pa Panels
A Runtime Advanced

me.
indicado.


na 1594) runtime.
runtime.
objeto indicado.
tangle".
na 1721)
RoundCornerHeight (Pági‐ P P Define el radio de esquina, o lo devuelve.
na 1788)
RoundCornerWidth (Pági‐ P P Define el radio de esquina, o lo devuelve.
na 1788)
ve.
na 1953)


tangle".
Tabla 3-82 Métodos

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
Abreviatura Validez
Pa Panels
A Runtime Advanced

time.
na 1576)
na 1577)
na 1578)
cado.
jeto indicado.
BorderBrightColor3D (Pági‐ P P Define el color de las partes del borde que se indican poste‐
na 1588) riormente para la representación tridimensional del objeto indi‐
cado.
na 1594) runtime.
objeto indicado.
BorderShadeColor3D (Pági‐ P P Define el color de las partes del borde que se indican poste‐
na 1598) riormente para la representación tridimensional del objeto indi‐
cado.
BorderWidth3D (Página 1602) P P Determina el ancho del borde para la representación tridimen‐
sional del objeto indicado.


CornerStyle (Página 1627) * - - Determina el tipo de líneas de borde del objeto indicado.
dentro del borde o simétricamente respecto al borde a partir de
un grosor de línea superior a 1.
runtime.
objeto indicado.
FontUnderline (Página 1673) P P Determina si el texto del objeto indicado se muestra subraya‐
do.
"Rectangle".
indicado.
LineEndShapeStyle (Página 1721) - - Determina la forma de los finales de línea.
*
PictureAlignment (Página 1774) P P Establece el modo de representación de la imagen de fondo
en el sinóptico del proceso, o lo devuelve.
PictureDeactivated (Página 1775) P P Establece la imagen que se muestra en el estado "Desactiva‐
do".
PictureOff (Página 1775) P P Establece la imagen que se muestra en el estado "Off".
PictureOn (Página 1776) P P Establece la imagen que se muestra en el estado "On".
Pressed (Página 1778) P P Determina si el objeto indicado se mostrará pulsado.


Toggle (Página 1888) P P Determina si el objeto indicado en runtime quedará enclavado
tras ser accionado.
vuelve.
TransparentColorDeactivatedPictu‐ P P Determina qué color del objeto de mapa de bits asignado se
re (Página 1914) pondrá en "transparente" para el estado "Desactivado".
TransparentColorPictureOff (Pági‐ P P Determina qué color del objeto de mapa de bits asignado se
na 1915) pondrá en "transparente" para el estado "Off".
TransparentColorPictureOn (Pági‐ P P Determina qué color del objeto de mapa de bits asignado se
na 1916) pondrá en "transparente" para el estado "On".
na 1953)
UseTransparentColorDeactivated‐ P P Determina si se utilizará el color transparente para el estado
Picture (Página 1960) "Desactivado" definido con la propiedad "TransparentColor‐
DeactivatedPicture".
UseTransparentColorPictureOff P P Determina si se utilizará el color transparente para el estado
(Página 1961) "Off" definido con la propiedad "TransparentColorPictureOff".
UseTransparentColorPictureOn P P Determina si se utiliza el color transparente para el estado "On"
(Página 1961) definido con la propiedad "TransparentColorPictureOn".
VerticalAlignment (Página 1971) P P Determina la alineación vertical del texto dentro del objeto in‐
dicado.
"Rectangle".
Tabla 3-84 Métodos

rante el runtime.

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.

HMIScreenWindow
Abreviatura Validez
Pa Panels
A Runtime Advanced

AdaptScreenToWindow (Pági‐ - - Define si la imagen representada en una ventana de imagen se
na 1553) adapta o no en runtime al tamaño de la ventana de imagen.
AdaptWindowToScreen (Pági‐ - - Define si la ventana de imagen se adapta o no en runtime a la
na 1553) imagen representada en ella.
BorderEnabled (Página 1591) - - TRUE si la ventana se muestra con borde en runtime.


CaptionText (Página 1609) P P Determina el texto que se muestra en la barra de título del objeto
indicado.
tangle".
HorizontalScrollBarPosition (Pá‐ P P Define el desplazamiento horizontal de la barra de desplazamiento
gina 1695) de la imagen en una ventana de imagen con barras de desplaza‐
miento o devuelve el valor.
IndependentWindow - - Determina si la ventana de imagen está incrustada en la imagen
o se muestra como ventana de imagen independiente.
LeftOffset (Página 1711) P P Determina el desplazamiento horizontal de la visualización de un
gráfico que es más grande que la ventana de imagen.
MenuToolBarConfig (Pági‐ - - Carga el archivo de configuración indicado con los menús y barras
na 1729) de herramientas definidos por el usuario o reproduce el nombre
del archivo de configuración.
MonitorNumber - - Define el número de monitor.
ScreenName (Página 1798) P P Define la imagen que se muestra en la ventana de imagen en run‐
time o devuelve el nombre de la imagen.
ShowCaption (Página 1818) - - Determina si la barra de título se muestra o se oculta.
ShowScrollBars (Página 1824) - - Determina si se deben visualizar las barras de desplazamiento.
TagPrefix (Página 1855) P P Define el prefijo que se antepondrá a todas las variables existentes
en la imagen.
TopOffset (Página 1911) P P Define la distancia de la imagen desde el borde superior de la
ventana de imagen, o la devuelve.
VerticalScrollBarPosition (Pági‐ P P Define el desplazamiento vertical de la barra de desplazamiento
na 1972) de la imagen en una ventana de imagen con barras de desplaza‐
miento o devuelve el valor.
tangle".
WindowCloseEnabled (Pági‐ - - Determina si una ventana puede cerrarse en runtime.
na 1985)
WindowMaximizeEnabled (Pá‐ - - TRUE si el objeto puede maximizarse en runtime.
gina 1986)
WindowMovingEnabled (Pági‐ - - TRUE si el objeto puede desplazarse en runtime.
na 1986)
WindowOnTop (Página 1987) - - TRUE si el objeto en runtime permanece siempre en el primer pla‐
no.
WindowSizingEnabled (Pági‐ - - Determina si puede modificarse el tamaño del objeto indicado en
na 1988) runtime.


WindowStartupPosition - - ??
ZoomFactor (Página 2007) P P Establece el factor de zoom de una imagen o ventana de imagen
o lo lee.
Tabla 3-86 Métodos

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

de la lista ScreenItems.

HMIApplicationWindow

Abreviatura Validez
Pa Panels
A Runtime Advanced

BorderEnabled (Página 1591) - - TRUE si la ventana se muestra con borde en runtime.
gle".
cuentra un objeto.
ShowCaption (Página 1818) - - Determina si la barra de título se muestra o se oculta.
Template (Página 1857) - - Devuelve la plantilla para la visualización del contenido del objeto
"Ventana de la aplicación".
gle".
WindowCloseEnabled (Pági‐ - - Determina si una ventana puede cerrarse en runtime.
na 1985)
WindowMaximizeEnabled (Pági‐ - - TRUE si el objeto puede maximizarse en runtime.
na 1986)
WindowMovingEnabled (Pági‐ - - TRUE si el objeto puede desplazarse en runtime.
na 1986)
WindowOnTop (Página 1987) - - TRUE si el objeto en runtime permanece siempre en el primer plano.
WindowsContents (Página 1987) - - Devuelve el contenido de la ventana de aplicación.
WindowSizingEnabled (Pági‐ - - Determina si puede modificarse el tamaño del objeto indicado en run‐
na 1988) time.
Tabla 3-88 Métodos

rante el runtime.

Slider (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Deslizador". El objeto Slider forma parte de la lista ScreenItems.

HMISlider
Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en
runtime.
BackPicture - - Establece un gráfico para el fondo.


BarBackColor (Página 1580) P, A P, A Define el color del fondo de barra en el objeto indicado.
BarColor (Página 1583) P, A P, A Define el color del deslizador en el objeto "Slider".
BorderBrightColor3D (Página 1588) P, A P, A Define el color de las partes del borde que se indican poste‐
riormente para la representación tridimensional del objeto
indicado.
BorderInnerStyle3D (Página 1596) P P Determina la visualización de la parte interior del borde del
objeto.
BorderInnerWidth3D (Página 1597) P, A P, A Define el ancho del borde interior en una representación tri‐
dimensional del objeto indicado.
BorderOuterStyle3D (Página 1597) P P Determina la visualización de la parte exterior del borde del
objeto.
BorderOuterWidth3D (Página 1598) P, A P, A Define el ancho del borde exterior en una representación
tridimensional del objeto indicado.
BorderShadeColor3D (Página 1598) P, A P, A Define el color de las partes del borde que se indican poste‐
riormente para la representación tridimensional del objeto
indicado.
Caption (Página 1608) P, A P, A Determina el texto que se muestra en la barra de título del
objeto indicado.
ContinousChange (Página 1626) P P Determina si el valor de la propiedad "ProcessValue" se
transfiere al soltar el botón del ratón o directamente al modi‐
ficar la posición del deslizador en runtime.
Enabled (Página 1644) P, A P, A Determina si el objeto indicado se puede manejar en runti‐
me.
FocusColor (Página 1667) P, A P, A Determina el color del borde del objeto indicado cuando está
FocusWidth (Página 1668) P, A P, A Determina el ancho del borde del objeto indicado cuando
está resaltado dicho objeto.
Font - - Define la fuente, o la devuelve.
Height (Página 1679) P, A P, A Define la altura en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
LabelColor (Página 1702) P, A P, A Define el color de rotulación de la escala en el objeto "Slider".
Layer (Página 1706) - - Define el valor de la coordenada X del objeto.
PositionFont - - Define la fuente de la rotulación.
ProcessValue (Página 1779) P, A P, A Determina el ajuste predeterminado para el valor que debe
mostrarse.
ShowBar (Página 1817) P, A P, A Determina si el valor de proceso visualizado en el objeto "Sli‐
der" se muestra adicionalmente con una barra llena.
ShowPosition (Página 1821) P, A P, A Determina si el valor de la posición actual del deslizador debe
mostrarse adicionalmente en formato numérico.


ShowThumb (Página 1827) P, A P, A Determina si debe mostrarse el deslizador del objeto "Sli‐
der".
ShowTickLabels (Página 1827) P, A P, A Determina si debe mostrarse la rotulación en la escala.
ShowTicks (Página 1828) P, A P, A Determina si deben mostrarse las marcas en la escala del
objeto.
ThumbBackColor (Página 1861) P, A P, A Determina el color de fondo del deslizador en el objeto "Sli‐
der".
ThumbPicture - - Define un gráfico para el deslizador.
TickStyle (Página 1863) P P Determina la representación de la escala.
vuelve.
na 1953)
"Rectangle".
Tabla 3-90 Métodos

durante el runtime.
Consulte también
ObjectName (Página 2035)
Font (Página 1669)

SmartClientView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor Sm@rtClient". El objeto SmartClientView forma parte de la lista

ScreenItems.

HMISmartClientView
Abreviatura Validez
Pa Panels
A Runtime Advanced

AllowMenu (Página 1562) - - Determina si se debe activar el menú contextual para controlar el visor
Sm@rtClient.
ConnectionType (Pági‐ - - Define el tipo del conector. Puede seleccionar entre dos tipos de co‐
na 1625) nexión.
ConnectOnStart - - Determina que se establezca la conexión al iniciar.


Height (Página 1679) A - Define la altura en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
cuentra un objeto.
LocalCursor (Página 1724) - - Determina si los datos del cursor deben transferirse por separado
para aumentar el rendimiento.
MachineName (Página 1727) A A Determina el ID de red del dispositivo que debe vigilarse.
Password (Página 1773) A A Define la contraseña para establecer la supervisión a distancia.
ScaleDenominator (Pági‐ - - Define el contador para la escala en el cliente.
na 1796)
ScaleNumerator (Pági‐ - - Define el contador para la escala en el cliente.
na 1793)
Scaling (Página 1797) - - TRUE si se utiliza adicionalmente una escala para representar los
valores.
ServerScale (Página 1815) - - Determina si el visor Sm@rtClient se puede ampliar o reducir.
Shared (Página 1815) - - Determina que varios visores Sm@rtClient puedan compartir un panel
de operador.
ShowControls - - Determina que se muestre una barra de herramientas.
UseCursorKeyScroll - - Determina si se utiliza el color de fondo del objeto al imprimir.
ViewOnly (Página 1973) A A Determina si el visor Sm@rtClient se debe utilizar para la supervisión
o el mantenimiento a distancia.
Width (Página 1983) A - Define el ancho en los objetos indicados "Ellipse", "Circle" y "Rectan‐
gle".
Tabla 3-92 Métodos

Activate (Página 2155) A Activa la ventana permanente o bien la imagen raíz.

StatusForce (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Estado/forzar". El objeto StatusForce forma parte de la lista

ScreenItems.
Si se modifican los ajustes de este objeto con un script de usuario, éstos se conservarán
incluso después de volver a llamar la imagen con este objeto.

HMIStatusForce
Abreviatura Validez
Pa Panels
A Runtime Advanced

Appearance - - Define la apariencia para este programa de pieza CN.
CountVisibleItems (Página 1630) - - Determina cuántas líneas contiene la lista de selección.
*


al contenido.
tangle".
PLCFilter - - Define el tipo de controlador.
na 1807)
na 1809)
SetOfVisibleColumns - - Determina las columnas visibles.
ShowReadButton - - Determina que se muestre el botón "Leer".
ShowTableGridlines (Pági‐ A A Determina si se muestran líneas de retícula en la tabla del objeto
na 1826) indicado.
ShowWriteButton - - Determina que se muestre el botón "Escribir".
indicado.
TableForeColor A A ??
na 1854) indicado.
na 1854) indicado.
tangle".
Tabla 3-94 Métodos


Switch (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Interruptor". El objeto Switch forma parte de la lista ScreenItems.
Propiedad "Interruptor con texto" "Interruptor con gráfico" "Interruptor"

CaptionColor -- -- x
CaptionText -- -- x
HorizontalAlignment X -- --
InnerBackColorOff -- -- x
InnerBackColorOn -- -- x
TextOn x -- x
TextOff x -- x
VerticalAlignment x -- --

HMISwitch
Abreviatura Validez
Pa Panels
A Runtime Advanced


Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en run‐
time.
AutoSizing - - Determina que el tamaño del objeto se adapte automáticamen‐
te al contenido.
BackColor (Página 1572) A A Determina el color de fondo del objeto indicado.
BackFlashingColorOff (Pági‐ - - Define el color de fondo para el estado de parpadeo "Off".
na 1576) *
BackFlashingColorOn (Pági‐ - - Define el color de fondo para el estado de parpadeo "On".
na 1577) *
BackFlashingEnabled (Pági‐ - - Determina si el fondo del objeto indicado parpadea en runtime.
na 1578) *
BackFlashingRate (Pági‐ - - Determina la frecuencia de parpadeo del fondo del objeto indi‐
na 1579) * cado.
BorderColor (Página 1589) * - - Determina el color de línea del objeto.
BorderFlashingColorOff (Pá‐ - - Determina el color de la línea de borde del objeto indicado para
gina 1592) * el estado de parpadeo "Off".
BorderFlashingColorOn (Pá‐ - - Determina el color de la línea de borde del objeto indicado para
gina 1593) * el estado de parpadeo "On".
BorderFlashingEnabled (Pá‐ - - Determina si la línea de borde del objeto indicado parpadea en
gina 1594) * runtime.
BorderFlashingRate (Pági‐ - - Determina la frecuencia de parpadeo de la línea de borde del
na 1595) * objeto indicado.
BorderWidth (Página 1600) * - - Determina el grosor de línea del objeto.
BorderWidth3D (Pági‐ - - Determina el ancho del borde para la representación tridimen‐
na 1602) * sional del objeto indicado.
CaptionColor (Página 1609) A A Determina el color del texto en el que se debe visualizar la barra
de título del objeto indicado.
CaptionFont - - Define el juego de caracteres para la rotulación.
CaptionText (Página 1609) A A Determina el texto que se muestra en la barra de título del ob‐
jeto indicado.
CornerStyle (Página 1627) * - - Determina el tipo de líneas de borde del objeto indicado.
EdgeStyle * - - Establece el estilo de línea del objeto indicado.
Enabled (Página 1644) A A Determina si el objeto indicado se puede manejar en runtime.
FlashingColorOff (Pági‐ - - Determina el color de la línea de borde del objeto indicado para
na 1661) * el estado de parpadeo "Off".


FlashingColorOn (Pági‐ - - Determina el color de la línea de borde del objeto indicado para
na 1663) * el estado de parpadeo "On".
FlashingEnabled (Pági‐ - - Determina si la línea de borde del objeto indicado parpadea en
na 1664) * runtime.
límite.
FlashingRate (Página 1665) * - - Determina la frecuencia de parpadeo de la línea de borde del
objeto indicado.
FocusColor (Página 1667) A A Determina el color del borde del objeto indicado cuando está
FocusWidth (Página 1668) A A Determina el ancho del borde del objeto indicado cuando está
ForeColor (Página 1674) A A Establece el color de fuente del texto del objeto indicado.
Height (Página 1679) A A Define la altura en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
HorizontalAlignment (Pági‐ A A Determina la alineación horizontal del texto dentro del objeto
na 1693) indicado.
InnerBackColorOff (Pági‐ A A Define el color debajo del deslizador del objeto "Switch" cuando
na 1698) el objeto está en estado OFF.
InnerBackColorOn (Pági‐ A A Define el color debajo del deslizador del objeto "Switch" cuando
na 1698) el objeto está en estado ON.
LineEndShapeStyle (Pági‐ - - Determina la forma del final de línea.
na 1721) *
PictureOff (Página 1775) - - Establece la imagen que se muestra en el estado "Off".
PictureOn (Página 1776) - - Establece la imagen que se muestra en el estado "On".
ProcessValue - - Determina el ajuste predeterminado para el valor que debe
mostrarse.
SwitchOrientation - - Determina la dirección de conmutación del objeto.
TextOff (Página 1859) A A Determina el texto que se muestra con el estado "Off" del objeto
indicado.
TextOn A A Determina el texto que se muestra con el estado "On" del objeto
indicado.
TextOrientation (Pági‐ - - Establece la dirección del texto del objeto indicado.
na 1860) *
VerticalAlignment (Pági‐ A A Determina la alineación vertical del texto dentro del objeto in‐
na 1971) dicado.


Width (Página 1983) A A Define el ancho en los objetos indicados "Ellipse", "Circle" y
"Rectangle".
Tabla 3-96 Métodos

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 forma parte de la lista
ScreenItems.

BackColor x x x x
BorderColor -- x -- x
BorderWidth -- -- -- x
BorderStyle3D -- x -- --


Enabled x -- x --
HelpText x -- x --
VerticalAlignment -- x -- x
HorizontalAlignment -- x -- x

HMISymbolicIOField
Abreviatura Validez
Pa Panels
A Runtime Advanced

AboveUpperLimitColor (Página 1545) - - Define el color del objeto indicado para el caso "Rebase por
exceso del límite superior".
AcceptOnExit (Página 1546) P P Define si el campo de entrada se confirma automáticamente
al salir de él.
AdaptBorder (Página 1552) - - Determina si el borde del objeto indicado se adapta dinámi‐
camente al tamaño del texto.
de este objeto.
runtime.
BackFlashingColorOff (Página 1576) P P Define el color de fondo para el estado de parpadeo "Off".
BackFlashingColorOn (Página 1577) P P Define el color de fondo para el estado de parpadeo "On".
BackFlashingEnabled (Página 1578) P P Determina si el fondo del objeto indicado parpadea en runti‐
me.
BackFlashingRate (Página 1579) P P Determina la frecuencia de parpadeo del fondo del objeto in‐
dicado.
BelowLowerLimitColor (Página 1584) - - Define el color del objeto indicado para el caso "Rebase por
defecto del límite inferior".
BitNumber (Página 1584) P P Define el bit cuyo estado debe cambiar para que se produzca
una modificación del valor.
objeto indicado.


objeto indicado.
CaptionBackColor (Página 1608) P P Determina el color de fondo de la barra de título del objeto
indicado.
CaptionColor (Página 1609) P P Determina el color del texto en el que se debe visualizar la
barra de título del objeto indicado.
CountVisibleItems (Página 1630) P P Determina cuántas líneas contiene la lista de selección.
CursorControl (Página 1631) P P Determina si el puntero del ratón debe saltar al siguiente cam‐
po de la secuencia de tabulación tras salir del campo.
DrawInsideFrame (Página 1640) - - Determina si la línea del borde del objeto indicado se traza
EditOnFocus (Página 1643) P P Determina si la entrada de datos es posible de inmediato
cuando se selecciona el campo de entrada con la tecla de
tabulación.
FieldLength - - Determina que el campo "Longitud de campo de la cadena
de caracteres" sea de sólo lectura.
FitToLargest - - Determina que el tamaño del objeto dependa de la longitud
del texto en todos los idiomas.
FlashingEnabled (Página 1664) P P Determina si la línea de borde del objeto indicado parpadea
en runtime.
FlashingOnLimitViolation - - Determina que se active el parpadeo en caso de infracción
de límite.
objeto indicado.
FocusColor (Página 1667) - - Determina el color del borde del objeto indicado cuando está
FocusWidth (Página 1668) - - Determina el ancho del borde del objeto indicado cuando está


FontBold (Página 1671) P P Determina si el texto del objeto indicado se muestra en negri‐
ta.
FontItalic (Página 1671) P P Determina si el texto del objeto indicado se muestra en cursi‐
va.
do.
"Rectangle".
HelpText A - Devuelve el tooltip que se visualiza en runtime como ayuda
de manejo del objeto indicado.
indicado.
InputValue (Página 1699) - - Define el valor introducido por el usuario en el campo E/S.
ItemBorderStyle (Página 1700) P P Establece el tipo de las líneas de separación en la lista de
selección del objeto indicado.
LeftMargin - - Determina la distancia del texto al borde izquierdo del objeto.
zarse este objeto.
ProcessValue (Página 1779) P P Determina el ajuste predeterminado para el valor que debe
mostrarse.
SelectBackColor (Página 1801) P P Determina el color de fondo de las celdas seleccionadas.
SelectForeColor (Página 1807) P P Determina el color de primer plano de las celdas selecciona‐
das.
SeparatorBackColor (Página 1812) P P Establece el color de fondo de las líneas de separación que‐
bradas en la lista de selección del objeto indicado.
SeparatorColor (Página 1813) P P Establece el color de las líneas de separación en la lista de
SeparatorCornerStyle (Página 1813) P P Define la forma de las esquinas para el objeto del tipo "Scree‐
nItem" con la especificación "SymbolicIOField".
SeparatorLineEndShapeStyle (Pági‐ P P Define la forma de los finales de línea para el objeto del tipo
na 1814) "ScreenItem" con la especificación "SymbolicIOField".
SeparatorStyle (Página 1813) P P Establece el tipo de las líneas de separación en la lista de
SeparatorWidth (Página 1814) P P Establece el ancho de las líneas de separación en la lista de


ShowDropDownButton - - Determina que se muestre un botón para la lista de selección.
ShowDropDownList - - Determina que se seleccione la entrada en una lista de selec‐
ción.
TextList (Página 1859) - - Define la rotulación del campo de texto.
TextOff (Página 1859) - - Determina el texto que se muestra con el estado "Off" del
objeto indicado.
TextOn - - Determina el texto que se muestra con el estado "On" del
objeto indicado.
vuelve.
na 1953)
VerticalAlignment (Página 1971) P, A P, A Determina la alineación vertical del texto dentro del objeto
indicado.
"Rectangle".
Tabla 3-98 Métodos


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 forma parte de la lista

ScreenItems.

HMISymbolLibrary
Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en run‐
time.


BlinkColor (Página 1585) P, A P, A Define el color con el que parpadea el objeto "SymbolLibrary".
BlinkMode (Página 1585) P P Determina el tipo de imagen parpadeante para el objeto indica‐
do.
BlinkSpeed (Página 1586) P P Determina la frecuencia de parpadeo.
ChangeMouseCursor (Pági‐ P P Determina cómo se modifica el aspecto del puntero del ratón
na 1614) en runtime cuando se encuentra sobre el símbolo.
FillColorMode (Página 1657) P P Determina el tipo de primer plano para el objeto indicado.
FixedAspectRatio (Página 1661) P P Determina si la relación de aspecto se mantiene o puede modi‐
ficarse en caso de cambiarse el tamaño del símbolo.
límite.
Flip (Página 1667) P P Voltea el símbolo sobre el eje central horizontal o vertical del
símbolo.
"Rectangle".
ProcessValue - - Determina el ajuste predeterminado para el valor que debe
mostrarse.
Rotation (Página 1785) P P Establece el ángulo de giro del objeto indicado en grados.
"Rectangle".
Tabla 3-100 Métodos


SystemDiagnoseView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de diagnóstico del sistema". El objeto SystemDiagnoseView forma

parte de la lista ScreenItems.

HMISysDiagView
Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) A A Determina los derechos de manejo del objeto indicado en
runtime.
BackgroundColor A A Determina el color de fondo.
ComponentInfoText A A Determina el tooltip del visor de diagnóstico del sistema
en runtime.


Enabled A A Determina si el objeto indicado se puede manejar en run‐
time.
Height (Página 1679) A A Define la altura en los objetos indicados "Ellipse", "Circle"
y "Rectangle".
InfoArea_BackgroundColor A A Determina el fondo de los elementos de control de cuadrí‐
cula.
InfoArea_ColumnsMovable A A Define la movilidad de las columnas.
InfoArea_DefaultTextColor A A Define el color de texto.
InfoArea_ErrorTextBackgroundColor A A Define el color de fondo de una celda en caso de fallo.
InfoArea_ErrorTextColor A A Define el color de texto de una celda en caso de fallo.
InfoArea_FocusFrameColor A A Define el color del borde cuando se resalta.
InfoArea_FocusFrameWidth A A Determina el grosor de línea del rectángulo resaltado.
InfoArea_Font A A Define las fuentes de las vistas de cuadrícula.
InfoArea_ShowGridLines A A Define las líneas de la cuadrícula.
InfoArea_TableHeaderBackgroundCo‐ A A Determina el color de fondo del encabezado de la tabla.
lor
InfoArea_TableHeaderTextColor A A Determina el color de texto del encabezado de la tabla.
InputAddressText A A Determina la dirección de entrada.
ItemText_AKZ A A Determina el título de la columna "AKZ".
ItemText_Descriptor A A Determina el título de la columna "Descriptor".
ItemText_ErrorText A A Determina el título de la columna "ErrorText".
ItemText_InstallationDate A A Determina el título de la columna "InstallationDate".
ItemText_LADDR A A Determina el título de la columna "LADDR".
ItemText_Name A A Determina el título de la columna "Name".
ItemText_OKZ A A Determina el título de la columna "OKZ".
ItemText_OperationState A A Determina el título de la columna "OperationState".
ItemText_OrderID A A Determina el título de la columna "OrderID".
ItemText_Rack A A Determina el título de la columna "Rack".
ItemText_Slot A A Determina el título de la columna "Slot".
ItemText_SoftwareRevision A A Determina el título de la columna "SoftwareRevision".
ItemText_State A A Determina el título de la columna "State".
ItemText_Station A A Determina el título de la columna "Station".
ItemText_SubAddress A A Determina el título de la columna "SubAddress".
ItemText_SubSlot A A Determina el título de la columna "SubSlot".
ItemText_SubSystem A A Determina el título de la columna "SubSystem".
ItemText_Type A A Determina el título de la columna "Type".
IV_ShowItem_AKZ A A Determina si se muestra la columna "AKZ".
IV_ShowItem_Descriptor A A Determina si se muestra la columna "Descriptor".
IV_ShowItem_ErrorText A A Determina si se muestra la columna "ErrorText".
IV_ShowItem_InstallationDate A A Determina si se muestra la columna "InstallationDate".
IV_ShowItem_LADDR A A Determina si se muestra la columna "LADDR".
IV_ShowItem_Name A A Determina si se muestra la columna "Name".
IV_ShowItem_OKZ A A Determina si se muestra la columna "OKZ".
IV_ShowItem_OperationState A A Determina si se muestra la columna "OperationState".


IV_ShowItem_OrderID A A Determina si se muestra la columna "OrderID".
IV_ShowItem_Rack A A Determina si se muestra la columna "Rack".
IV_ShowItem_Slot A A Determina si se muestra la columna "Slot".
IV_ShowItem_SoftwareRevision A A Determina si se muestra la columna "SoftwareRevision".
IV_ShowItem_State A A Determina si se muestra la columna "State".
IV_ShowItem_Station A A Determina si se muestra la columna "Station".
IV_ShowItem_SubAddress A A Determina si se muestra la columna "SubAddress".
IV_ShowItem_SubSlot A A Determina si se muestra la columna "SubSlot".
IV_ShowItem_SubSystem A A Determina si se muestra la columna "SubSystem".
IV_ShowItem_Type A A Determina si se muestra la columna "Type".
Layer (Página 1706) A - Dentro de la imagen, devuelve como LONG el nivel en el
que se encuentra un objeto.
NavigationPath_Font A A Establece la fuente de la ruta de navegación.
NavigationPath_TextColor A A Determina el color de texto de la ruta de navegación.
ObjectName (Página 2035) A - Devuelve el nombre de objeto como STRING.
OutputAddressText A A Define el texto para la dirección de salida.
ShowNavigationButtons A A Determina si se muestran botones de navegación.
ShowPathInformation A A Determina si se muestra la ruta de navegación.
ShowSplittedView A A Determina si se divide la visualización.
TableHeaderFont A A Define el color de texto del título.
Tipo (Página 2139) A - Devuelve como STRING el tipo del objeto indicado.
Parent (Página 2120) A - Devuelve la imagen en la que está incrustado el objeto
indicado.
UV_ShowItem_AKZ A A Determina si se muestra la columna "AKZ".
UV_ShowItem_Descriptor A A Determina si se muestra la columna "Descriptor".
UV_ShowItem_InstallationDate A A Determina si se muestra la columna "InstallationDate".
UV_ShowItem_LADDR A A Determina si se muestra la columna "LADDR".
UV_ShowItem_Name A A Determina si se muestra la columna "Name".
UV_ShowItem_OKZ A A Determina si se muestra la columna "OKZ".
UV_ShowItem_OperationState A A Determina si se muestra la columna "OperationState".
UV_ShowItem_OrderID A A Determina si se muestra la columna "OrderID".
UV_ShowItem_Rack A A Determina si se muestra la columna "Rack".
UV_ShowItem_Slot A A Determina si se muestra la columna "Slot".
UV_ShowItem_SoftwareRevision A A Determina si se muestra la columna "SoftwareRevision".
UV_ShowItem_State A A Determina si se muestra la columna "State".
UV_ShowItem_Station A A Determina si se muestra la columna "Station".
UV_ShowItem_SubAddress A A Determina si se muestra la columna "SubAddress".
UV_ShowItem_SubSlot A A Determina si se muestra la columna "SubSlot".
UV_ShowItem_SubSystem A A Determina si se muestra la columna "SubSystem".
UV_ShowItem_Type A A Determina si se muestra la columna "Type".


Width (Página 1983) A A Determina si se muestra la columna "Slot".

Consulte también
Name (Página 1749)
SystemDiagnoseWindow (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Ventana de diagnóstico del sistema". El objeto SystemDiagnoseWindow

forma parte de la lista ScreenItems.

HMISysDiagWindow

Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) A A Determina los derechos de manejo del objeto indicado
en runtime.
BackgroundColor A A Determina el color de fondo.
Caption (Página 1608) A A Determina el texto que se muestra en la barra de título
CaptionActive A A Determina que se muestre la rotulación.
Closable A A Determina que el control pueda cerrarse en runtime.
ComponentInfoText A A Determina el tooltip del visor de diagnóstico del sistema
en runtime.
Enabled A A Determina si el objeto indicado se puede manejar en
runtime.
Height (Página 1679) A A Define la altura en los objetos indicados "Ellipse", "Cir‐
cle" y "Rectangle".
InfoArea_BackgroundColor A A Determina el fondo de los elementos de control de cua‐
drícula.
InfoArea_ColumnsMovable A A Define la movilidad de las columnas.
InfoArea_DefaultTextColor A A Define el color de texto.
InfoArea_ErrorTextBackgroundColor A A Define el color de fondo de una celda en caso de fallo.
InfoArea_ErrorTextColor A A Define el color de texto de una celda en caso de fallo.
InfoArea_FocusFrameColor A A Define el color del borde cuando se resalta.
InfoArea_FocusFrameWidth A A Determina el grosor de línea del rectángulo resaltado.
InfoArea_Font A A Define las fuentes de las vistas de cuadrícula.
InfoArea_ShowGridLines A A Define las líneas de la cuadrícula.
InfoArea_TableHeaderBackgroundColor A A Determina el color de fondo del encabezado de la tabla.
InfoArea_TableHeaderTextColor A A Determina el color de texto del encabezado de la tabla.
InputAddressText A A Determina la dirección de entrada.
ItemText_AKZ A A Determina el título de la columna "AKZ".
ItemText_Descriptor A A Determina el título de la columna "Descriptor".
ItemText_ErrorText A A Determina el título de la columna "ErrorText".
ItemText_InstallationDate A A Determina el título de la columna "InstallationDate".
ItemText_LADDR A A Determina el título de la columna "LADDR".
ItemText_Name A A Determina el título de la columna "Name".
ItemText_OKZ A A Determina el título de la columna "OKZ".
ItemText_OperationState A A Determina el título de la columna "OperationState".
ItemText_OrderID A A Determina el título de la columna "OrderID".


ItemText_Rack A A Determina el título de la columna "Rack".
ItemText_Slot A A Determina el título de la columna "Slot".
ItemText_SoftwareRevision A A Determina el título de la columna "SoftwareRevision".
ItemText_State A A Determina el título de la columna "State".
ItemText_Station A A Determina el título de la columna "Station".
ItemText_SubAddress A A Determina el título de la columna "SubAddress".
ItemText_SubSlot A A Determina el título de la columna "SubSlot".
ItemText_SubSystem A A Determina el título de la columna "SubSystem".
ItemText_Type A A Determina el título de la columna "Type".
IV_ShowItem_AKZ A A Determina si se muestra la columna "AKZ".
IV_ShowItem_Descriptor A A Determina si se muestra la columna "Descriptor".
IV_ShowItem_ErrorText A A Determina si se muestra la columna "ErrorText".
IV_ShowItem_InstallationDate A A Determina si se muestra la columna "InstallationDate".
IV_ShowItem_LADDR A A Determina si se muestra la columna "LADDR".
IV_ShowItem_Name A A Determina si se muestra la columna "Name".
IV_ShowItem_OKZ A A Determina si se muestra la columna "OKZ".
IV_ShowItem_OperationState A A Determina si se muestra la columna "OperationState".
IV_ShowItem_OrderID A A Determina si se muestra la columna "OrderID".
IV_ShowItem_Rack A A Determina si se muestra la columna "Rack".
IV_ShowItem_Slot A A Determina si se muestra la columna "Slot".
IV_ShowItem_SoftwareRevision A A Determina si se muestra la columna "SoftwareRevi‐
sion".
IV_ShowItem_State A A Determina si se muestra la columna "State".
IV_ShowItem_Station A A Determina si se muestra la columna "Station".
IV_ShowItem_SubAddress A A Determina si se muestra la columna "SubAddress".
IV_ShowItem_SubSlot A A Determina si se muestra la columna "SubSlot".
IV_ShowItem_SubSystem A A Determina si se muestra la columna "SubSystem".
IV_ShowItem_Type A A Determina si se muestra la columna "Type".
Layer (Página 1706) A - Dentro de la imagen, devuelve como LONG el nivel en
el que se encuentra un objeto.
Modal A A Determina que la ventana de avisos deba acusarse an‐
tes de seguir trabajando.
NavigationPath_Font A A Establece la fuente de la ruta de navegación.
NavigationPath_TextColor A A Determina el color de texto de la ruta de navegación.
ObjectName (Página 2035) A - Devuelve el nombre de objeto como STRING.
OutputAddressText A A Define el texto para la dirección de salida.
Resizable A A Determina que el tamaño de la ventana pueda modifi‐
carse.
ShowNavigationButtons A A Determina si se muestran botones de navegación.
ShowPathInformation A A Determina si se muestra la ruta de navegación.
ShowSplittedView A A Determina si se divide la visualización.
TableHeaderFont A A Define el color de texto del título.


Tipo (Página 2139) A - Devuelve como STRING el tipo del objeto indicado.
Parent (Página 2120) A - Devuelve la imagen en la que está incrustado el objeto
indicado.
UV_ShowItem_AKZ A A Determina si se muestra la columna "AKZ".
UV_ShowItem_Descriptor A A Determina si se muestra la columna "Descriptor".
UV_ShowItem_InstallationDate A A Determina si se muestra la columna "InstallationDate".
UV_ShowItem_LADDR A A Determina si se muestra la columna "LADDR".
UV_ShowItem_Name A A Determina si se muestra la columna "Name".
UV_ShowItem_OKZ A A Determina si se muestra la columna "OKZ".
UV_ShowItem_OperationState A A Determina si se muestra la columna "OperationState".
UV_ShowItem_OrderID A A Determina si se muestra la columna "OrderID".
UV_ShowItem_Rack A A Determina si se muestra la columna "Rack".
UV_ShowItem_Slot A A Determina si se muestra la columna "Slot".
UV_ShowItem_SoftwareRevision A A Determina si se muestra la columna "SoftwareRevi‐
sion".
UV_ShowItem_State A A Determina si se muestra la columna "State".
UV_ShowItem_Station A A Determina si se muestra la columna "Station".
UV_ShowItem_SubAddress A A Determina si se muestra la columna "SubAddress".
UV_ShowItem_SubSlot A A Determina si se muestra la columna "SubSlot".
UV_ShowItem_SubSystem A A Determina si se muestra la columna "SubSystem".
UV_ShowItem_Type A A Determina si se muestra la columna "Type".
Width (Página 1983) A A Define el ancho en los objetos indicados "Ellipse", "Cir‐
cle" y "Rectangle".
WindowMode A A Establece el modo de ventana.

Consulte también
Name (Página 1749)

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 forma parte de la lista ScreenItems.

HMITextField
Abreviatura Validez
Pa Panels
A Runtime Advanced

AdaptBorder (Página 1552) P P Determina si el borde del objeto indicado se adapta dinámica‐
mente al tamaño del texto.
time.


na 1576)
na 1577)
na 1578)
cado.
objeto indicado.
na 1594) runtime.
objeto indicado.
dentro del borde o simétricamente respecto al borde a partir de
un grosor de línea superior a 1.
runtime.
objeto indicado.


do.
"Rectangle".
indicado.
LeftMargin - - Determina la distancia del texto al borde izquierdo del objeto.
LineWrap * - - Define el salto de línea dentro de un objeto.
RotationCenterLeft (Página 1786) P P Define la coordenada X del punto en torno al que gira el objeto
en runtime.
RotationCenterTop (Página 1787) P P Define la coordenada Y del punto en torno al que gira el objeto
en runtime.
Text (Página 1858) P, A P, A Define la rotulación del campo de texto.
vuelve.
na 1953)
VerticalAlignment (Página 1971) P, A P, A Determina la alineación vertical del texto dentro del objeto in‐
dicado.
"Rectangle".


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
"Control1":
'VBS60
Dim objControl
Abreviatura Validez
Pa Panels
A Runtime Advanced

el diseño.
AutoCompleteRows (Página 1568) P P Determina si se mostrarán filas vacías cuando el control
sea más largo que el número de filas configuradas.
AutoPosition P P Determina que la posición se adapte automáticamente.
AutoShow P P Determina que la tabla de valores se muestre automática‐
mente.
BlockAlign * P P Determina la alineación.
BlockAutoPrecisions * P P Determina que se adapte automáticamente el número de
decimales mostrados de un eje.
BlockCaption * P P Define el título.
BlockCount * P P Determina el número de bloques.
BlockDateFormat * P P Determina el formato para la indicación de fecha.
BlockExponentialFormat * P P Determina que se utilice la notación exponencial.
BlockHideText * P P Determina si se muestra el texto.
BlockHideTitleText * P P Determina si se muestra el texto.
BlockId * P P Define el ID.
BlockIndex P P El índice especifica a qué bloque se refieren otras propie‐
dades, como p. ej., el nombre.
BlockLength * P P Determina el número de caracteres mostrados.


BlockName * P P Define el nombre de un bloque.
BlockPrecisions * P P Determina el número de decimales mostrados.
Blocks - - Determina los bloques de aviso.
BlockShowDate * P P Determina que se muestre la fecha.
BlockShowIcon * P P Determina el texto del tooltip.
BlockShowTitleIcon * P P Determina que el título se muestre como símbolo.
BlockTimeFormat * P P Determina el formato para la indicación de hora.
BlockUseSourceFormat * P P Determina que se utilice el formato de fuente.
objeto indicado.
CellCut (Página 1611) P P Define si el contenido de las celdas se abreviará en caso
de que las celdas sean demasiado estrechas.
de la tabla.
CellSpaceLeft (Página 1612) P P Establece la sangría izquierda que se utilizará en las cel‐
das de la tabla.
de la tabla.
CellSpaceTop (Página 1613) P P Establece la distancia superior que se utilizará en las cel‐
das de la tabla.
ColumnAdd * P P Agrega una columna.
ColumnCount * P P Indica el número de columnas.
ColumnIndex P P El índice especifica a qué columna se refieren otras pro‐
piedades, como p. ej., el valor inicial.
ColumnName * P P Define el nombre de una columna.
ColumnRemove * P P Borra una columna.
ColumnRepos * P P Determina que la columna se posicione de nuevo.
ColumnSort * P P Establece el tipo de clasificación.
ColumnSortIndex * P P Determina el orden en la clasificación.
ColumnVisible * P P Determina la visibilidad de una columna.
runtime.
ExportFileExtension (Página 1651) P P Establece la extensión del archivo de exportación. Hasta
el momento solamente es compatible la extensión "csv".


datos de runtime.
ExportFilenameChangeable (Pági‐ P P Determina si el nombre del archivo de exportación se pue‐
na 1652) de modificar en runtime.
ExportFormatName (Página 1653) P P Determina el formato de archivo para la exportación. Ac‐
tualmente sólo está disponible el formato de archivo "csv"
para la exportación.
ExportParameters (Página 1654) P P Establece los parámetros del formato seleccionado me‐
diante el cuadro de diálogo "Propiedades".
ExportSelection (Página 1654) P P Establece la extensión del archivo de exportación. Hasta
Height (Página 1679) P - Define la altura en los objetos indicados "Ellipse", "Circle"
y "Rectangle".
IconSpace (Página 1697) P P Establece la distancia entre símbolo y texto en las celdas
de la tabla.
Layer (Página 1706) - - Dentro de la imagen, devuelve como LONG el nivel en el
RowScrollbar (Página 1788) P P Determina si las barras de desplazamiento de filas se de‐
ben visualizar.
RTPersistence (Página 1789) P P Establece cómo se conservarán las configuraciones onli‐
ne de WinCC.
RTPersistencePasswordLevel (Pági‐ P P Determina la autorización que es necesaria en runtime
na 2045) para la configuración online.
RTPersistenceType (Página 1790) - - Establece cómo se conservarán las configuraciones onli‐
ne de WinCC.
RulerType P P Determina el tipo de regla.


o filas.
SelectionRect (Página 1809) P P Determina si se utilizará un borde de selección para las
celdas o filas seleccionadas.
SelectionRectColor (Página 1810) P P Define el color del rectángulo de selección en la ventana
de avisos cuando SelectionType sea "1".
ShareSpaceWithSourceControl P P Determina que la tabla de valores se muestre en el área
de visualización de la fuente de datos.
ShowSortButton (Página 1824) P P Determina si se mostrará la tecla de clasificación en la
barra de desplazamiento vertical.
ShowSortIndex (Página 1825) P P
Sizeable (Página 1830) P P Determina si puede modificarse el tamaño del objeto en
runtime.
SortSequence (Página 1832) P P Determina cómo se puede modificar la secuencia de cla‐
sificación haciendo clic con el ratón.
SourceControl P P Determina la fuente de datos.
SourceControlType P P Determina el tipo de la fuente de datos.
StatusbarElementAdd (Página 1836) * P P Crea un nuevo elemento de la barra de estado definido
por el usuario.
StatusbarElementAutoSize (Pági‐ P P Establece si el ancho del elemento seleccionado de la ba‐
na 1836) * rra de estado se ajustará automáticamente.
StatusbarElementCount (Página 1837) * P P Indica el número de elementos configurables de la barra
de estado.
StatusbarElementId (Página 1838) * P P Clave ID unívoca para el elemento seleccionado de la ba‐
rra de estado.
propiedad permite asignar los valores de otras propieda‐
des a un elemento determinado de la barra de estado.
StatusbarElementName (Página 1840) * P P Muestra el nombre de objeto para el elemento selecciona‐
do de la barra de estado.
na 1840) *
StatusbarElementRename (Pági‐ P P Modifica el nombre del elemento de la barra de estado
na 1841) * definido por el usuario que está referenciado mediante la
propiedad "StatusbarElementIndex".
estado.


StatusbarElementText P P Define el texto del elemento de la barra de estado selec‐
cionado actualmente.
StatusbarElementTooltipText (Pági‐ P P Determina el texto para el tooltip del elemento de la barra
na 1842) * de estado definido por el usuario.
na 1842) * por el ingeniero como nuevo elemento definido por el
usuario.
StatusbarElementWidth (Página 1844) P P Indica el ancho del elemento seleccionado de la barra de
* estado en píxeles.
StatusbarShowTooltips (Página 1845) P P Determina si en runtime se mostrarán los tooltips de los
elementos de la barra de estado.
StatusbarUseBackColor (Página 1846) P P Determina si se debe visualizar el color de fondo de la
barra de estado.
StatusbarVisible (Página 1847) P P Determina si se debe visualizar la barra de estado del
control.
TitleCut (Página 1883) P P Determina si los contenidos de los campos de una barra
de título deben acortarse cuando el ancho de columna sea
insuficiente.
seleccionado.
TitleGridLineColor (Página 1885) P P Indica el color de las líneas de separación en el título de
la tabla.
TitleSort (Página 1887) P P Determina cómo se inicia la clasificación por título de co‐
lumna.
TitleStyle (Página 1888) P P Determina qué color de sombreado se usa para el título
de tabla.
ToolbarAlignment (Página 1894) P P Define la posición de la barra de herramientas, o la de‐
vuelve.
en runtime.
ToolbarButtonAdd (Página 1896) * P P Establece una nueva función de teclas definida por el
usuario.


ToolbarButtonBeginGroup (Pági‐ P P Determina si se añadirá un separador antes de la función
na 1897) * de teclas seleccionada.
ToolbarButtonEnabled (Página 1898) * P P Determina si se puede utilizar la tecla definida por el usua‐
rio de la barra de herramientas.
seleccionada.
ToolbarButtonLocked (Página 1901) * P P Determina si para una tecla de la barra de herramientas
definida por el usuario, se mostrará el estado pulsado (en‐
cajado) de la tecla.
na 1902) *
ToolbarButtonRemove (Página 1902) * P P Elimina la función de tecla seleccionada de la lista.
ToolbarButtonRename (Página 1903) * P P Modifica el nombre del elemento de la barra de herramien‐
tas definido por el usuario que está referenciado mediante
la propiedad "ToolbarButtonIndex".
de herramientas.
na 1904) *
ToolbarButtonUserDefined (Pági‐ P P Muestra si la tecla de la barra de herramientas ha sido
na 1905) * añadida por el ingeniero como tecla nueva definida por el
usuario.
ToolbarShowTooltips (Página 1905) P P Determina si en runtime se mostrarán los tooltips de las
funciones de tecla.
ToolbarUseBackColor (Página 1906) P P Determina si se debe visualizar el color de fondo de la
barra de herramientas.
ToolbarUseHotKeys (Página 1907) P P Determina si las teclas de acceso directo están activas
para las funciones de tecla en runtime.
ToolbarVisible (Página 1907) P P Determina si se debe visualizar la barra de herramientas
del control.
UseSelectedTitleColor (Página 1958) P P Determina si se utilizará un color de selección para los
títulos de tabla de celdas seleccionadas.
UseSourceBackColors P P Determina que se utilice el color de fondo de la fuente de
datos.
UseSourceForeColors P P Determina que se utilice el color de primer plano de la
fuente de datos.
UseTableColor2 (Página 1959) P P Determina si se utilizará un segundo color de fila en la
representación de la tabla.


Width (Página 1983) P - Define el ancho en los objetos indicados "Ellipse", "Circle"
y "Rectangle".

durante el runtime.
GetRow (Página 2180) P Devuelve el objeto de filas designado mediante el número de fila de los
controles basados en tablas como tipo "ICCAxDataRow".
GetRowCollection (Página 2182) P Devuelve el listado de todos los objetos de filas de los controles basados en
tablas como tipo "ICCAxDataRowCollection".
GetRulerBlock (Página 2183) P Devuelve el objeto de bloque designado por nombre o índice de la tabla de
evaluación como tipo "ICCAxRulerBlock".
GetRulerBlockCollection (Pági‐ P Devuelve el listado de todos los objetos de bloque de la tabla de evaluación
na 2184) como tipo "ICCAxCollection".
GetRulerColumn (Página 2185) P Devuelve el objeto de columna designado por nombre o índice de la tabla
de evaluación como tipo "ICCAxRulerColumn".
GetRulerColumnCollection (Pá‐ P Devuelve el listado de todos los objetos de columna de la tabla de evaluación
gina 2186) como tipo "ICCAxCollection".
GetSelectedRow (Página 2188) P Devuelve como tipo "ICCAxDataRow" el objeto de filas seleccionado de un
control basado en tablas.
GetSelectedRows (Página 2189) P Con selección múltiple, devuelve como tipo "ICCAxDataRow" los objetos de
filas seleccionados de un control basado en tablas.
GetStatisticAreaColumn (Pági‐ P Devuelve el objeto de columna designado por nombre o índice de la ventana
na 2191) del área estadística de la tabla de evaluación como tipo "ICCAxRulerCo‐
lumn".
GetStatisticAreaColumnCollec‐ P Devuelve el listado de todos los objetos de columna de la ventana del área
tion (Página 2192) estadística de la tabla de evaluación como tipo "ICCAxCollection".
GetStatisticResultColumn (Pági‐ P Devuelve el objeto de columna designado por nombre o índice de la ventana
na 2193) estadística de la tabla de evaluación como tipo "ICCAxRulerColumn".
GetStatisticResultColumnCollec‐ P Devuelve el listado de todos los objetos de columna de la ventana estadística
tion (Página 2194) de la tabla de evaluación como tipo "ICCAxCollection".
GetToolbarButton (Página 2203) P, A Devuelve la función de tecla designada por nombre o índice de la barra de
herramientas del control como tipo "ICCAxToolbarButton".
GetToolbarButtonCollection (Pá‐ P, A Devuelve el listado de todas las funciones de tecla de la barra de herra‐
gina 2205) mientas del control como tipo "ICCAxCollection".


na 2258)
TrendView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de curvas". El objeto TrendView forma parte de la lista

ScreenItems.

HMITrendView

Abreviatura Validez
Pa Panels
A Runtime Advanced

Authorization (Página 1566) - - Determina los derechos de manejo del objeto indicado en
runtime.
AxisXBunchCount - - Define el tamaño de las divisiones principales del eje X.
AxisXMarkCount - - Define el tamaño de las divisiones del eje X.
AxisXNoOfDigits - -
AxisXShowBunchValues - - Determina que se muestre la rotulación de la escala de los
valores intermedios del eje X.
AxisXStyle * - -
AxisY1BunchCount - - Define el tamaño de las divisiones principales del eje Y a la
izquierda.
AxisY1MarkCount - - Define el tamaño de las divisiones del eje Y a la izquierda.
AxisY1ShowBunchValues - - Determina que se muestre a la izquierda la rotulación de la
escala de los valores intermedios del eje Y.
AxisY2BunchCount - - Define el tamaño de las divisiones principales del eje Y a la
derecha.
AxisY2MarkCount - - Define el tamaño de las divisiones del eje Y a la derecha.
AxisY2ShowBunchValues - - Determina que se muestre a la derecha la rotulación de la
escala de los valores intermedios del eje Y.
CountVisibleItems (Página 1630) - - Determina cuántas líneas contiene la lista de selección.
Enabled A A Determina si el objeto indicado se puede manejar en runti‐
me.
EnableNavigateButtons - -
EnableNavigateKeys - - Determina que se navegue con el teclado.
FitToSize - - Determina que el tamaño del objeto se adapte automática‐
mente al contenido.
FocusColor A A Determina el color del borde del objeto indicado cuando está
FocusWidth A A Determina el ancho del borde del objeto indicado cuando
está resaltado dicho objeto.
Height (Página 1679) A - Define la altura en los objetos indicados "Ellipse", "Circle" y
"Rectangle".


HelpText (Página 1684) A - Devuelve el tooltip que se visualiza en runtime como ayuda
de manejo del objeto indicado.
Look3D - - Determina que se active la representación tridimensional.
RulerColor (Página 1791) A A Define el color de la escala graduada (línea auxiliar) en la
rotulación del eje del objeto "OnlineTrendControl".
ScaleColor (Página 1792) A A Define el color de la escala del objeto indicado.
SelectionBackColor * - - Determina el color de fondo de las celdas seleccionadas.
SelectionForeColor * - - Determina el color de primer plano de las celdas selecciona‐
das.
ShowRuler A A Determina si se muestra una escala graduada (línea auxiliar)
para la rotulación de eje del objeto "OnlineTrendControl".
ShowTableGridLines - -- Determina que se muestren las líneas de cuadrícula de la
tabla.
ShowTimeAxis - - Determina que se muestre el eje X.
ShowTimeAxisLabeling - - Determina que se muestre la rotulación del eje X.
ShowValueAxis1 - - Determina que se muestre el eje Y izquierdo.
ShowValueAxis1Label - - Determina que se muestre la rotulación del eje Y izquierdo.
ShowValueAxis2 - - Determina que se muestre el eje Y derecho.
ShowValueAxis2Label - - Define el título de la ventana.
ShowValueTable - - Determina que se muestre la tabla de valores.
ShowY1HlpLine - - Determina que se muestre la línea auxiliar.
ShowY2HlpLine - - Determina que se muestre la línea auxiliar.
TableBackColor (Página 1849) A A Determina el color de fondo de las celdas de la tabla del
objeto indicado.
TableGridLineColor (Página 1853) A A Determina el color de las líneas de retícula en la tabla del
objeto indicado.
na 1854) indicado.
na 1854) indicado.
TagForExternalTime - - Define la variable para la hora externa.
TimeAxisBegin - - Define el valor inicial del eje de tiempo.
TimeAxisBeginTime - - Define el punto de inicio de la representación de la curva
indicada.
TimeAxisCountPoints - - Define el número de valores del eje de tiempo.
TimeAxisEnd - - Define el valor final del eje de tiempo.
TimeAxisMode - - Define el modo del eje de tiempo.
TimeAxisRange (Página 1865) - - Intervalo de tiempo que muestra el eje de tiempo.
TimeAxisSide - - Define el lado para nuevos valores en el eje de tiempo.


de herramientas.
ToolbarEnabled * - - Determina si el visor de curvas tiene una barra de herra‐
mientas.
ToolbarStyle - - Define el aspecto de la barra de herramientas.
TrendsForPrinting * - -
ValueAxis1AutoRange * - - Determina que el área de datos se adapte automáticamente.
ValueAxis1Begin - - Define el valor inicial del eje.
ValueAxis1End - - Define el valor final del eje.
ValueAxis1LabelLength - - Define la longitud de la rotulación del eje.
ValueAxis1Style * - -
ValueAxis2AutoRange * - - Determina que el área de datos se adapte automáticamente.
ValueAxis2Begin - - Define el valor inicial del eje.
ValueAxis2End - - Define el valor final del eje.
ValueAxis2LabelLength - - Define la longitud de la rotulación del eje.
ValueAxis2Style * - - Determina que el área de datos se adapte automáticamente.
ValueY1HlpLine - - Define el valor de la línea auxiliar.
ValueY2HlpLine - - Valor de la línea auxiliar eje Y a la derecha.
Width (Página 1983) A - Define el ancho en los objetos indicados "Ellipse", "Circle" y
"Rectangle".


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
Abreviatura Validez
Pa Panels
A Runtime Advanced


EndAngle (Página 1646) P P Define el ángulo en el que se desvía del origen (0°) el punto final del
objeto indicado.
gle".
gina 1953)
tangle".


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
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
Abreviatura Validez
Pa Panels
A Runtime Advanced


tangle".
na 1953)
tangle".


TubePolyline (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Tubo poligonal". El objeto TubePolyline forma parte de la lista

ScreenItems.

HMITubePolyline
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
Abreviatura Validez
Pa Panels
A Runtime Advanced


ActualPointIndex (Pági‐ P P Determina el número del vértice actual del objeto indicado.
na 1550)
ActualPointLeft (Página 1551) P P Determina la coordenada X del vértice actual en referencia al origen
de la imagen.
ActualPointTop (Página 1551) P P Determina la coordenada Y del vértice actual en referencia al origen
de la imagen.
gle".
PointsCount (Página 1777) P P Determina el número de vértices de la línea poligonal o del polígono.
gina 1953)
tangle".

rante el runtime.

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.

Tipo de objeto del objeto ScreenItem. Representa el objeto gráfico "Pieza en T".

HMITubeTeeObject
Utilización
"TubeTeeObject1":
'VBS21
Dim objTubeTeeObject
Set objTubeTeeObject = ScreenItems("TubeTeeObject1")
objTubeTeeObject.Left = objTubeTeeObject.Left + 10

Abreviatura Validez
Pa Panels
A Runtime Advanced

gle".
gina 1953)
gle".


UserArchiveControl (RT Professional)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de recetas". El objeto UserArchiveControl forma parte de la lista

ScreenItems.

HMIUserArchiveControl
Abreviatura Validez
Pa Panels
A Runtime Advanced

el diseño.
ArchiveName * P P Define el nombre del fichero.
ArchiveType P - Define el tipo de fichero.


AutoCompleteRows (Página 1568) P P Determina si se mostrarán filas vacías cuando el control
sea más largo que el número de filas configuradas.
Blocks - - Determina los bloques de aviso.
objeto indicado.
CellCut (Página 1611) P P Define si el contenido de las celdas se abreviará en caso
de que las celdas sean demasiado estrechas.
de la tabla.
CellSpaceLeft (Página 1612) P P Establece la sangría izquierda que se utilizará en las cel‐
das de la tabla.
de la tabla.
CellSpaceTop (Página 1613) P P Establece la distancia superior que se utilizará en las cel‐
das de la tabla.
ColumnAlign (Página 1619) * P P Determina cómo se alineará la columna seleccionada.
ColumnAutoPrecisions * P P Determina que
se adapte automáticamente el número de decimales mos‐
trados de un eje.
ColumnCaption * P P Define el título.
ColumnCount * P - Indica el número de columnas.
ColumnDateFormat (Página 1619) * - P Determina el formato de visualización de los datos de fe‐
cha.
ColumnExponentialFormat * P P Determina que se utilice la notación exponencial en una
columna.
ColumnHideText * P P Determina si se muestra el texto.
ColumnHideTitleText * P P Determina si se muestra el texto.
ColumnIndex P P El índice especifica a qué columna se refieren otras pro‐
piedades, como p. ej., el valor inicial.
ColumnLeadingZeros * P P Determina que se muestren ceros a la izquierda.
ColumnLength * P P Determina el número de caracteres mostrados.
ColumnName * P - Muestra el nombre de la columna seleccionada.
ColumnPrecisions * P P Determina el número de decimales.
ColumnReadonly * P P Determina que los valores de la columna solo puedan
leerse.
ColumnRepos * P P Determina que la columna se posicione de nuevo.
ColumnResize (Página 1620) P P Determina si se puede modificar el ancho de las colum‐
nas.


ColumnShowDate * P P Determina que se muestre la fecha.
ColumnShowIcon * P P Determina que se muestre un símbolo.
ColumnShowTitleIcon * P P Determina que se muestre un símbolo.
ColumnSort * P P Establece el tipo de clasificación.
ColumnSortIndex * P P Determina el orden en la clasificación.
ColumnTimeFormat * - P Determina el formato de visualización de los datos de ho‐
ra.
ColumnVisible * P P Determina la visibilidad de una columna.
ControlDesignMode (Página 1831) - P Determina el diseño.
DataSource - - Determina la fuente de datos.
Enabled (Página 1644) P P Determina si el objeto indicado se puede manejar en run‐
time.
EnableDelete P P Determina que puedan borrarse datos.
EnableEdit (Página 1645) P P Determina si se pueden modificar los datos mostrados en
runtime.
EnableInsert P P Determina que puedan insertarse datos.
runtime.
ExportFileExtension (Página 1651) P P Establece la extensión del archivo de exportación. Hasta
datos de runtime.
ExportFilenameChangeable (Pági‐ P P Determina si el nombre del archivo de exportación se pue‐
na 1652) de modificar en runtime.
ExportFormatName (Página 1653) P P Determina el formato de archivo para la exportación. Ac‐
tualmente sólo está disponible el formato de archivo "csv"
para la exportación.
ExportParameters (Página 1654) - - Establece los parámetros del formato seleccionado me‐
diante el cuadro de diálogo "Propiedades".
ExportSelection (Página 1654) P P Determina qué datos de runtime del Control se exportarán.
Filters - - Establece criterios en sintaxis SQL para la base de datos.
FilterSQL P - Define un Statement SQL para el criterio de filtro.
Height (Página 1679) P P Define la altura en los objetos indicados "Ellipse", "Circle"
y "Rectangle".


IconSpace (Página 1697) P P Establece la distancia entre símbolo y texto en las celdas
de la tabla.
Layer (Página 1706) - - Dentro de la imagen, devuelve como LONG el nivel en el
ObjectName (Página 2035) P - Devuelve el nombre de objeto como STRING.
PrintJobName (Página 2043) P P Determina un trabajo de impresión.
RowScrollbar (Página 1788) P P Determina si las barras de desplazamiento de filas se de‐
ben visualizar.
RTPersistence (Página 1789) P P Establece cómo se conservarán las configuraciones onli‐
ne de WinCC.
RTPersistencePasswordLevel (Pági‐ P P Determina la autorización que es necesaria en runtime
na 2045) para la configuración online.
RTPersistenceType (Página 1790) - - Establece cómo se conservarán las configuraciones onli‐
ne de WinCC.
SelectArchiveName * P P Determina que el fichero se defina mediante el nombre.
o filas.
SelectionRect (Página 1809) P P Determina si se utilizará un borde de selección para las
celdas o filas seleccionadas.
SelectionRectColor (Página 1810) P P Define el color del rectángulo de selección en la ventana
de avisos cuando SelectionType sea "1".
ShowSortButton (Página 1824) P P Determina si se mostrará la tecla de clasificación en la
barra de desplazamiento vertical.
ShowSortIndex (Página 1825) P P Determina si se mostrará un índice de clasificación.
Sizeable P P Determina si puede modificarse el tamaño del objeto en
runtime.
SortSequence P P Determina cómo se puede modificar la secuencia de cla‐
sificación haciendo clic con el ratón.


StatusbarElementAdd (Página 1836) * - P Crea un nuevo elemento de la barra de estado definido
por el usuario.
StatusbarElementAutoSize (Pági‐ P P Establece si el ancho del elemento seleccionado de la ba‐
na 1836) * rra de estado se ajustará automáticamente.
StatusbarElementCount (Página 1837) * P - Indica el número de elementos configurables de la barra
de estado.
StatusbarElementId (Página 1838) * P - Devuelve la clave ID para el elemento seleccionado de la
barra de estado.
propiedad permite asignar los valores de otras propieda‐
des a un elemento determinado de la barra de estado.
StatusbarElementName (Página 1840) * P P Muestra el nombre de objeto para el elemento selecciona‐
do de la barra de estado.
na 1840) *
StatusbarElementRename (Pági‐ P P Modifica el nombre del elemento de la barra de estado
na 1841) * definido por el usuario que está referenciado mediante la
propiedad "StatusbarElementIndex".
estado.
StatusbarElementText * P P Define el texto del elemento de la barra de estado selec‐
cionado actualmente.
StatusbarElementTooltipText (Pági‐ P P Determina el texto para el tooltip del elemento de la barra
na 1842) * de estado definido por el usuario.
StatusbarElementUserDefined (Pági‐ P - Indica si el elemento de la barra de estado ha sido añadido
na 1842) * por el ingeniero como nuevo elemento definido por el
usuario.
StatusbarElementWidth (Página 1844) * P P Indica el ancho del elemento seleccionado de la barra de
estado en píxeles.
StatusbarFontColor (Página 1844) P P Indica el color de fuente de los textos de la barra de esta‐
do.
StatusbarShowTooltips (Página 1845) P P Determina si en runtime se mostrarán los tooltips de los
elementos de la barra de estado.
StatusbarText (Página 1846) P - Devuelve el texto estándar de la barra de estado.
StatusbarUseBackColor (Página 1846) P P Determina si se debe visualizar el color de fondo de la
barra de estado.
StatusbarVisible (Página 1847) P P Determina si se debe visualizar la barra de estado del
control.


TitleCut (Página 1883) P P Determina si los contenidos de los campos de una barra
de título deben acortarse cuando el ancho de columna sea
insuficiente.
seleccionado.
TitleGridLineColor (Página 1885) P P Indica el color de las líneas de separación en el título de
la tabla.
TitleSort (Página 1887) P P Determina cómo se inicia la clasificación por título de co‐
lumna.
TitleStyle (Página 1888) P P Determina qué color de sombreado se usa para el título
de tabla.
ToolbarAlignment (Página 1894) P P Define la posición de la barra de herramientas, o la de‐
vuelve.
en runtime.
ToolbarButtonAdd (Página 1896) * P P Establece una nueva función de teclas definida por el
usuario.
ToolbarButtonBeginGroup (Pági‐ P P Determina si se añadirá un separador antes de la función
na 1897) * de teclas seleccionada.
ToolbarButtonCount (Página 1898) * P - Devuelve el número de botones que contiene la barra de
herramientas.
ToolbarButtonEnabled (Página 1898) * P P Determina si se puede utilizar la tecla definida por el usua‐
rio de la barra de herramientas.
seleccionada.
ToolbarButtonLocked (Página 1901) * P P Determina si para una tecla de la barra de herramientas
definida por el usuario, se mostrará el estado pulsado (en‐
cajado) de la tecla.
ToolbarButtonName (Página 1901) * P - Muestra el nombre del botón de la barra de herramientas
seleccionado.
na 1902) *
ToolbarButtonRemove (Página 1902) * - P Elimina la función de tecla seleccionada de la lista.
ToolbarButtonRename (Página 1903) * - P Modifica el nombre del elemento de la barra de herramien‐
tas definido por el usuario que está referenciado mediante
la propiedad "ToolbarButtonIndex".


de herramientas.
na 1904) *
ToolbarButtonUserDefined (Pági‐ P - Muestra si la tecla de la barra de herramientas ha sido
na 1905) * añadida por el ingeniero como tecla nueva definida por el
usuario.
ToolbarShowTooltips (Página 1905) P P Determina si en runtime se mostrarán los tooltips de las
funciones de tecla.
ToolbarUseBackColor (Página 1906) P P Determina si se debe visualizar el color de fondo de la
barra de herramientas.
ToolbarUseHotKeys (Página 1907) P P Determina si las teclas de acceso directo están activas
para las funciones de tecla en runtime.
ToolbarVisible (Página 1907) P P Determina si se debe visualizar la barra de herramientas
del control.
UseSelectedTitleColor (Página 1958) P P Determina si se utilizará un color de selección para los
títulos de tabla de celdas seleccionadas.
UseTableColor2 (Página 1959) P P Determina si se utilizará un segundo color de fila en la
representación de la tabla.
Visibility P P Determina si el objeto indicado es visible.
Width (Página 1983) P P Define el ancho en los objetos indicados "Ellipse", "Circle"
y "Rectangle".

ActivateDynamic (Pági‐ P Activa dinámicamente un disparador y el ciclo fijado para una propiedad con
na 2158) VB Script durante el runtime.
CutRows (Página 2165) P Ejecuta la función del botón "Cortar líneas" del visor de recetas.
DeleteRows (Página 2167) P Ejecuta la función del botón "Borrar líneas" del visor de recetas.
GetColumn (Página 2169) P Devuelve el objeto de columna designado por nombre o índice del visor de
recetas como tipo "ICCAxUAColumn".
GetColumnCollection (Pági‐ P Devuelve el listado de todos los objetos de columna del visor de recetas como
na 2170) tipo "ICCAxCollection".
GetRow (Página 2180) P Devuelve el objeto de filas designado mediante el número de fila de los con‐
troles basados en tablas como tipo "ICCAxDataRow".
GetRowCollection (Pági‐ P Devuelve el listado de todos los objetos de filas de los controles basados en
na 2182) tablas como tipo "ICCAxDataRowCollection".


GetSelectedRow (Pági‐ P Devuelve como tipo "ICCAxDataRow" el objeto de filas seleccionado de un
na 2188) control basado en tablas.
GetSelectedRows (Pági‐ P Con selección múltiple, devuelve como tipo "ICCAxDataRow" los objetos de
na 2189) filas seleccionados de un control basado en tablas.
GetStatusbarElementCollec‐ P, A Devuelve el listado de todos los elementos de la barra de estado del control
tion (Página 2196) como tipo "ICCAxCollection".
GetToolbarButton (Pági‐ P, A Devuelve la función de tecla designada por nombre o índice de la barra de
GetToolbarButtonCollection P, A Devuelve el listado de todas las funciones de tecla de la barra de herramientas
(Página 2205) del control como tipo "ICCAxCollection".
MoveToPrevious (Pági‐ P Ejecuta la función del botón "Registro anterior" del control.
na 2229)
PasteRows (Página 2232) P Ejecuta la función del botón "Insertar líneas" del visor de recetas.
ReadTags (Página 2236) P Ejecuta la función del botón "Leer variables" del visor de recetas.
ServerExport (Página 2250) P Ejecuta la función del botón "Exportar fichero" del visor de recetas.
ServerImport (Página 2251) P Ejecuta la función del botón "Importar fichero" del visor de recetas.
na 2258)
ShowSelectArchive (Pági‐ P Ejecuta la función del botón "Seleccionar conexión de datos" del visor de re‐
na 2258) cetas.
ShowSelection (Página 2259) P Ejecuta la función del botón "Diálogo de selección" del visor de recetas.
ShowSelectTimeBase (Pági‐ P Ejecuta la función del botón "Diálogo de base de tiempo" del visor de recetas.
na 2260)
ShowSort (Página 2261) P Ejecuta la función del botón "Diálogo de ordenación" del visor de recetas.
WriteTags (Página 2271) P Ejecuta la función del botón "Escribir variables" del visor de recetas.

UserView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Visor de usuarios". El objeto UserView forma parte de la lista

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

HMIUserView
Abreviatura Validez
Pa Panels
A Runtime Advanced


Appearance (Página 1320) - - Define la apariencia para este programa de pieza CN.
Authorization (Página 1566) * - - Determina los derechos de manejo del objeto indicado en runtime.
Columns - - Determina qué columnas se muestran.
CountVisibleItems (Pági‐ - - Determina cuántas líneas contiene la lista de selección.
na 1630)
FitToSize - - Determina que el tamaño del objeto se adapte automáticamente al
contenido.
tangle".
na 1807)
na 1809)
ShowTableGridlines (Pági‐ - - Determina si se muestran líneas de retícula en la tabla del objeto
na 1826) indicado.
TableBackColor (Pági‐ A A Determina el color de fondo de las celdas de la tabla del objeto
na 1849) indicado.
TableForeColor A A
TableGridlineColor (Pági‐ A A Establece el color de las líneas de cuadrícula.
na 1853)
TableHeaderBackColor (Pá‐ A A Define el color de fondo del encabezado de la tabla del objeto indi‐
gina 1854) cado.
TableHeaderForeColor (Pági‐ A A Define el color de texto del encabezado de la tabla del objeto indi‐
na 1854) cado.
tangle".
* No visible en ES.


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
Abreviatura Validez
Pa Panels
A Runtime Advanced


AskOperationMotive (Página 1564) P P Determina si también se registrará la razón para la utilización de
este objeto.
me.
BackColorBottom (Página 1574) P P Determina el color de la parte inferior/derecha del deslizador.
BackColorTop (Página 1574) P P Determina el color de la parte superior/izquierda del deslizador.
BackFlashingColorOff (Página 1576) P P Define el color de fondo para el estado de parpadeo "Off".
BackFlashingColorOn (Página 1577) P P Define el color de fondo para el estado de parpadeo "On".
BackFlashingEnabled (Página 1578) P P Determina si el fondo del objeto indicado parpadea en runtime.
BackFlashingRate (Página 1579) P P Determina la frecuencia de parpadeo del fondo del objeto indica‐
do.
indicado.
na 1594) runtime.
objeto indicado.
tangle".
HighLimitColor (Página 1685) P P Determina el color del botón superior o derecho para desplazarse
por una barra de desplazamiento.
JumpToLimitsAfterMouseClick (Pági‐ P P Define la longitud de las marcas largas de una escala.
na 1701)


LineEndShapeStyle (Página 1721) - - Determina la forma del final de línea.
LogOperation (Página 1725) P P Determina si se emite un aviso al sistema de avisos tras utilizarse
este objeto.
LowLimitColor (Página 1727) P P Determina el color del botón inferior o izquierdo para desplazarse
por una barra de desplazamiento.
MarginToBorder (Página 1728) P P Define en píxeles el ancho del borde 3D.
MaximumValue (Página 1728) P P Define el valor máximo de la escala en el objeto indicado.
MinimumValue (Página 1745) P P Define el valor mínimo de la escala en el objeto indicado.
OperationSteps (Página 1758) P P Establece cuántos pasos se desplaza el deslizador de la barra
de desplazamiento con un clic de ratón.
trarse.
ShowBadTagState (Página 1817) P P Determina si el objeto se muestra en gris cuando la variable vin‐
culada presenta un mal QualityCode o estado.
ThumbBackColor (Página 1861) P P Determina el color de fondo del deslizador en el objeto "Slider".
ve.
na 1953)
tangle".
WindowsStyle (Página 1988) P P Determina si el objeto se mostrará en el estilo general de Win‐
dows.


WLanQualityView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "WLAN Recepción". El objeto WLanQualityView es un elemento de la
lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced

tangle".
tangle".

????

ZoneLabelView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Zona Nombre". El objeto ZoneLabelView es un elemento de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced

tangle".
tangle".

???

ZoneQualityView (Panels, Comfort Panels, RT Advanced)
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Zona Señal". El objeto ZoneQualityView es un elemento de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced

tangle".
tangle".

?????

3.5.5 Propiedades (Panels, Comfort Panels, RT Advanced, RT Professional)
3.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 del objeto indicado para el caso "Rebase por exceso del límite superior".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.AboveUpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
Con la siguiente apariencia no se tiene acceso en runtime:
● GraphicIOField
● Switch
● SymbolLibrary
● SymbolicIOField
Color
Opcional. Valor o constante que determina el color del objeto especificado para el caso "Límite
superior rebasado".
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). El color "rojo", por ejemplo, se
representa así: RGB(255, 0, 0). Además, también es posible utilizar las constantes de color
VBScript, tales como vbRed o vbGreen.

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
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el campo de entrada se confirma automáticamente al salir de él.
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.
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".
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 1320)
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 1313)
Project (Página 1319)

ActiveScreen (Panels, Comfort Panels, RT Advanced)
Descripción
Devuelve un objeto del tipo "Screen" que representa la imagen resaltada 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.
Sintaxis
Object.ActiveScreen
Object
Obligatorio. Objeto del tipo "HMIRuntime".
Observaciones
La imagen retornada dependerá de si está resaltada la imagen básica o la ventana
permanente.
La propiedad ActiveScreen retornará NOTHING si no hay ninguna imagen resaltada. Éste es
el caso, por ejemplo, cuando está resaltada 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

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
Object
Obligatorio. Un objeto del tipo "HMIRuntime".
Observaciones
La imagen que se devuelve depende de si está enfocada la imagen raíz o la ventana
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
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.
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 del objeto indicado.
Sintaxis
Object.ActualPointIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Polygon
● Polyline
● Tubepolyline
● Line

Int32
Opcional. Valor o constante que determina el número del vértice actual del objeto indicado.
ActualPointLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la coordenada X 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. Cada vértice se identifica
mediante un índice que se obtiene a partir del número ("PointCount") de vértices existentes.
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).
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.

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).
AdaptBorder (RT Professional)
Descripción
Determina si el borde del objeto indicado se adapta de manera dinámica al tamaño del texto.
Sintaxis
Object.AdaptBorder[=BOOLEAN]
Object
● Button
● IOField
● OptionGroup
● SymbolicIOField
● TextField
● Checkbox

BOOLEAN
Opcional. TRUE si el borde del objeto indicado se adapta de manera dinámica al tamaño del
texto.
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 adapta o no en runtime al
tamaño de la ventana de imagen.
Sintaxis
Object.AdaptScreenToWindow[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
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.
AdaptWindowtoScreen (RT Professional)
Descripción
Indica si la ventana de imagen se adapta a la imagen representada en ella en runtime.
Acceso en runtime: leer
Sintaxis
Object.AdaptWindowtoScreen[=BOOLEAN]

Object
● Screenwindow
BOOLEAN
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.
Address (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la dirección web que se abre en el navegador HTML.
Sintaxis
Object.Address[=STRING]
Object
● HTML-Browser
STRING
Opcional. Un valor o una constante que contiene la dirección web.
AddressEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AdressPreview (RT Advanced)
Descripción

Alarm (RT Professional)
Descripción
Define el límite de visualización de espacio de memoria a partir del cual se emite un aviso.
Sintaxis
Object.Alarm[=Int32]
Object
● DiscSpaceView
Int32
Opcional. Valor o constante que define el límite de visualización de espacio de memoria a
partir del cual se emite un aviso.
AlarmClasses (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AlarmColor (RT Professional)
Descripción
Determina el color que se muestra en las barras en cuanto la memoria ocupada haya
alcanzado el rango de alarma.
Sintaxis
Object.AlarmColor[=Color]
Object
● DiscSpaceView
Color
Opcional. Un valor o una constante que determina el color que se muestra en las barras en
cuanto la memoria ocupada haya alcanzado el rango de alarma.

Observaciones
Es posible utilizar la función "RGB" para determinar el color en formato RGB (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 pueden utilizarse las constantes de color VBS como vbRed
o vbGreen.
AlarmID (RT Professional)
Descripción
Devuelve la AlarmID del objeto Alarm. La AlarmID es unívoca y la otorga el sistema.
AlarmID (readonly)
Consulte también
Alarms (lista) (Página 1305)
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
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.
AlarmLowerLimitColor (RT Professional)
Descripción
Determina el color de barra para el valor límite "AlarmLowerLimit".
La propiedad "AlarmLowerLimitEnable" debe tener el valor TRUE cuando debe modificarse
el color de barra al alcanzar el valor límite.
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".
Observaciones
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 VBScript, tales como vbRed o vbGreen.
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
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.
AlarmSource (Panels, Comfort Panels, RT Advanced, 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.
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.
AlarmUpperLimitColor (RT Professional)
Descripción
Determina el color de barra para el valor límite "AlarmUpperLimit".
La propiedad "AlarmUpperLimitEnable" debe tener el valor TRUE cuando debe modificarse
Sintaxis
Object.AlarmUpperLimitColor[=Color]
Object
● Bar
● Slider
Color
Opcional. Un valor o una constante que determina el color de barra para valor el límite
"AlarmUpperLimit".
Observaciones
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
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.
AllFilters (RT Professional)
Descripción

AllFiltersForHitlist (RT Professional)
Descripción
AllowEdit (RT Advanced)
Descripción
AllowMenu (RT Advanced)
Descripción
Ningún acceso en runtime
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.
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".
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.
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.

Appearance (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ApplyProjectSettings (RT Professional)
Descripción
Define si se aplica la configuración del proyecto desde el editor "Avisos HMI".
Sintaxis
Object.ApplyProjectSettings[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: 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: no se aplican las propiedades.
ApplyProjectSettingsForDesignMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AskOperationMotive (RT Professional)
Descripción
Determina si el motivo para la operación de este objeto se registra en un informe. Al operar
el objeto indicado en runtime se abre un cuadro de diálogo en el cual el operador introduce
como texto el motivo de la operación.

Sintaxis
Object.AskOperationMotive[=BOOLEAN]
Object
● ComboBox
● IOField
● ListBox
● SymbolicIOField
● WindowsSlider
BOOLEAN
Opcional. TRUE si el motivo para la operación de este objeto se registra en un informe.
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
STRING
Opcional. Establece un listado que contiene las asignaciones entre el valor de salida y el texto
de salida que realmente será mostrado.
AssociatedS7GraphDBTag (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

Authorization (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina los derechos de manejo del objeto indicado en runtime.
Sintaxis
Object.Authorization[=HMIRTAuthorization]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● Slider
● StatusForce

● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserView
● WindowsSlider
● AlarmView
● PLCCodeViewer
● ProtectedAreaNameView
● RangeLabelView
● S7GraphOverview
HMIRTAuthorization
Opcional. Valor o constante que determina los derechos de manejo del objeto indicado en
runtime.
AutoCompleteColumns (RT Professional)
Descripción
Determina si se mostrarán las columnas vacías si Control es más ancho que las columnas
configuradas.
Sintaxis
Object.AutoCompleteColumns[=BOOLEAN]
Object
● AlarmControl
● OnlineTableControl

● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestran las columnas vacías.
FALSE: no se muestran las columnas vacías.
AutoCompleteRows (RT Professional)
Descripción
Determina si se mostrarán las filas vacías si Control es más largo que el número de filas
configuradas.
Sintaxis
Object.AutoCompleteRows[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se muestran las filas vacías.
FALSE: no se muestran las filas vacías.
AutoScroll (RT Professional)
Descripción
Determina cómo se comporta la ventana de avisos al aparecer nuevos avisos.
La selección específica de líneas de avisos solo es posible cuando "AutoScroll" no está
activado.
La propiedad "AutoScroll" se desactiva cuando se fija el atributo "MsgCtrlFlag" = "-1". El aviso
más actual se muestra arriba en la ventana de avisos.

Sintaxis
Object.AutoScroll[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE: un nuevo aviso se añade a la lista mostrada en la ventana de avisos y se selecciona.
El área visible de la ventana de avisos se desplaza en caso necesario.
FALSE: no se selecciona un nuevo aviso. El área visible de la ventana de avisos no se modifica.
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.
Sintaxis
Object.AutoSelectionColors[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se utiliza el color de sistema.
FALSE: se utiliza el color definido por el usuario.
AutoSelectionRectColor (RT Professional)
Descripción
Define si el borde de selección se coloreará con el color definido por el sistema.

Sintaxis
Object.AutoSelectionRectColors[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se utiliza el color de sistema.
FALSE: se utiliza el color definido por el usuario.
AutoSizing (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
AverageLast15Values (RT Professional)
Descripción
Define si se obtendrá el valor medio de los 15 últimos valores.
Sintaxis
Object.AverageLast15Values[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la apariencia "Bar".
BOOLEAN
Opcional. TRUE si se obtiene el valor medio de los 15 últimos valores.

AxisXBunchCount (RT Advanced)
Descripción
AxisXMarkCount (RT Advanced)
Descripción
AxisXShowBunchValues (RT Advanced)
Descripción
AxisY1BunchCount (RT Advanced)
Descripción
AxisY1MarkCount (RT Advanced)
Descripción
AxisY1ShowBunchValues (RT Advanced)
Descripción
AxisY2BunchCount (RT Advanced)
Descripción

AxisY2MarkCount (RT Advanced)
Descripción
AxisY2ShowBunchValues (RT Advanced)
Descripción
3.5.5.2 Propiedades B (Panels, Comfort Panels, RT Advanced, RT Professional)
BackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de fondo del objeto indicado.
Sintaxis
Object.BackColor[=Color]
Object
● AlarmControl
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc

● FunctionTrendControl
● Gauge
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OnlineTrendControl
● OptionGroup
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● Slider
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● TextField
● TrendView
● TubeArcObject
● UserView
● WindowsSlider
● GraphicIOField
Color
Opcional. Valor o constante que determina el color de fondo.

Observaciones
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los tres valores RGB el valor
decimal correspondiente (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.
El color de fondo no es visible si la propiedad "BorderStyle" tiene el valor "0".
BackColorBottom (RT Professional)
Descripción
Determina el color de la parte inferior/derecha del objeto Slider.
Sintaxis
Object.BackColorBottom[=Color]
Object
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color de la parte inferior/derecha del
objeto Slider.
Observaciones
constantes de color VBS, tales como vbRed o vbGreen.
BackColorTop (RT Professional)
Descripción
Determina el color de la parte superior/izquierda del objeto Slider.
Sintaxis
Object.BackColorTop[=Color]

Object
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color de la parte superior/izquierda del
objeto Slider.
Observaciones
BackFillStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el patrón de relleno del objeto indicado.
Sintaxis
Object.BackFillStyle[=FillStyle]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Clock
● ComboBox
● Ellipse
● EllipseSegment
● Gauge
● GraphicView
● IOField

● ListBox
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● Slider
● SymbolLibrary
● SymbolicIOField
● TextField
● WindowsSlider
● DateTimeField
● GraphicIOField
● Switch
FillStyle
Opcional. Valor o constante que determina el patrón de relleno.
hmiFillStyleTransparent (65536): relleno transparente
hmiFillStyleSolid (0): el objeto se rellena con el color indicado
Ajuste estándar: hmiFillStyleSolid
BackFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color del fondo para el estado de parpadeo "Off".
Acceso en runtime:
Sintaxis
Object.BackFlashingColorOff[=Color]
Object
● Bar
● Button
● GraphicView

● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch
Color
Opcional. Un valor o una constante que determina el color del fondo para el estado de
parpadeo "Off".
Observaciones
BackFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color del fondo para el estado de parpadeo "On".
Acceso en runtime:
Sintaxis
Object.BackFlashingColorOn[=Color]
Object
● Bar
● Button
● GraphicView
● IOField

● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch
Color
Opcional. Un valor o una constante que determina el color del fondo para el estado de
parpadeo "On".
Observaciones
BackFlashingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el fondo del objeto indicado parpadea en runtime.
Acceso en runtime:
Sintaxis
Object.BackFlashingEnabled[=BOOLEAN]
Object
● Bar
● Button
● GraphicView
● IOField
● OptionGroup

● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch
BOOLEAN
Opcional. TRUE si el fondo del objeto indicado parpadea en runtime.
BackFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la frecuencia de parpadeo del fondo del objeto indicado.
Acceso en runtime:
Sintaxis
Object.BackFlashingRate[=FlashingRate]
Object
● Bar
● Button
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch

FlashingRate
hmiFlashingRateSlow (0): la longitud del intervalo de parpadeo es de 250 ms.
hmiFlashingRateMedium (1): la longitud del intervalo de parpadeo es de 500 ms.
hmiFlashingRateFast (2): la longitud del intervalo de parpadeo es de 1000 ms.
BackgroundColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
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
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
BarBackFillStyle (RT Professional)
Descripción
Determina el patrón de relleno de la barra.

Sintaxis
Object.BarBackFillStyle[=FillStyle]
Object
● Bar
FillStyle
hmiFillStyleTransparent ( 65536): patrón de relleno transparente
hmiFillStyleSolid ( 0): patrón de relleno sólido
hmiFillStyleBackwardDiagonal ( 131075): patrón de relleno a rayas diagonales hacia arriba a
la derecha
hmiFillStyleCross ( 131076): patrón de relleno a cuadros
hmiFillStyleDiagonalCross ( 131077): patrón de relleno a cuadros diagonal
hmiFillStyleForwardDiagonal ( 131074): patrón de relleno a rayas diagonales hacia arriba a
la izquierda
hmiFillStyleHorizontal ( 131072): patrón de relleno a rayas horizontales
hmiFillStyleVertical ( 131073): patrón de relleno a rayas verticales
hmiFillStylePattern1 ( 196608): patrón de relleno predefinido


BarBackFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BarBackFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BarBackFlashingEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

BarBackFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BarColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la barra en el objeto "Slider".
Sintaxis
Object.BarColor[=Color]
Object
● Slider
Color
Opcional. Valor o constante que determina el color del regulador.
Observaciones
El rango va desde "RangeMin" hasta la posición del regulador.
BarEdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

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
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.
BelowLowerLimitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BitNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el bit cuyo estado debe modificarse para desencadenar un cambio de valor.
Acceso en runtime:
Sintaxis
Object.BitNumber[=Int32]
Object
● SymbolicIOField


● 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.
BlinkColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color con el que parpadea el objeto "SymbolLibrary".
Sintaxis
Object.BlinkColor[=Color]
Object
● SymbolLibrary
Color
Opcional. Valor o constante que determina el color de parpadeo.
Observaciones
BlinkMode (RT Professional)
Descripción
Determina el tipo de gráfico intermitente para el objeto indicado.

Sintaxis
Object.BlinkMode[=SymbolLibraryBlinkMode]
Object
● SymbolLibrary
SymbolLibraryBlinkMode
hmiSymbolLibraryFlashingNone ( 0): el parpadeo está desactivado.
hmiSymbolLibraryFlashingInvisible ( 1): el gráfico intermitente es invisible.
hmiSymbolLibraryFlashingShaded ( 2): el gráfico intermitente recibe una superficie a color,
sombreada. El color de la superficie se corresponde con el ajuste de la propiedad "BlinkColor".
hmiSymbolLibraryFlashingSolid ( 3): el gráfico intermitente recibe una superficie a color, no
sombreada. El color de la superficie se corresponde con el ajuste de la propiedad "BlinkColor".
BlinkSpeed (RT Professional)
Descripción
Determina la frecuencia de parpadeo.
Fast - 250: la longitud del intervalo de parpadeo es de 250 ms. Medium - 500: la longitud del
intervalo de parpadeo es de 500 ms.
Slow - 1000: la longitud del intervalo de parpadeo es de 1000 ms. El valor estándar es Medium
- 500.
Sintaxis
Object.BlinkSpeed[=FlashingRate]
Object
● SymbolLibrary
FlashingRate
hmiFlashingRateSlow ( 0): la longitud del intervalo de parpadeo es de 250 ms.
hmiFlashingRateMedium ( 1): la longitud del intervalo de parpadeo es de 500 ms.
hmiFlashingRateFast ( 2): la longitud del intervalo de parpadeo es de 1000 ms.

Blocks (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
BorderBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de fondo de la línea de borde quebrada del objeto indicado.
Acceso en runtime:
Sintaxis
Object.BorderBackColor[=Color]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField

● TextField
● WindowsSlider
● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de fondo de la línea de borde quebrada
Observaciones
BorderBrightColor3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de las siguientes partes del borde para la representación en 3D del objeto
indicado:
● Partes externas superiores e inferiores del borde
● Partes internas inferiores y derechas del borde
Sintaxis
Object.BorderBrightColor3D[=Color]

Object
● Button
● RoundButton
● Slider
● Switch
Color
Opcional. Un valor o una constante que determina el color del borde. La configuración estándar
es blanco.
Observaciones
(rango de valores de 0 a 255). El color "rojo", por ejemplo, se representa así: RGB(255, 0, 0).
Además, también pueden utilizarse las constantes de color VBS como vbRed o vbGreen.
BorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de línea del objeto indicado.
Sintaxis
Object.BorderColor[=Color]
Object
● AlarmControl
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● DateTimeField

● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● Clock
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de línea.

Observaciones
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los tres valores RGB el valor
decimal correspondiente (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.
BorderEnabled (RT Professional)
Descripción
Devuelve si la ventana se representa con borde en runtime.
Sintaxis
Object.BorderEnabled[=BOOLEAN]
Object
● ApplicationWindow
● Screenwindow
BOOLEAN
Opcional. TRUE si la ventana se muestra con borde en runtime.
BorderEndStyle (RT Professional)
Descripción
Determina el tipo de finales de línea del objeto indicado.
Sintaxis
Object.BorderEndStyle[=Int32]
Object
● Line
● Polyline

Int32
Opcional. Un valor o una constante que determina el tipo de finales de línea del objeto indicado.
BorderFlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "Off".
Acceso en runtime:
Sintaxis
Object.BorderFlashingColorOff[=Color]
Object
● Bar
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch

Color
Opcional. Un valor o una constante que determina el color de la línea de borde del objeto
indicado para el estado de parpadeo "Off".
Observaciones
BorderFlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "On".
Acceso en runtime:
Sintaxis
Object.BorderFlashingColorOn[=Color]
Object
● Bar
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField

● TextField
● WindowsSlider
● CheckBox
● Switch
Color
indicado para el estado de parpadeo "On".
Observaciones
BorderFlashingEnabled (RT Professional)
Descripción
Determina si la línea de borde del objeto indicado parpadea en runtime.
Sintaxis
Object.BorderFlashingEnabled[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con las especificaciones "Ellipse", "Circle",
"EllipseSegment", "CircleSegment", "Rectangle", "Polygon", "TextField", "IOField",
"SymbolicIOField", "Button", "Roundbutton", "Switch", "GraphicView", "GraphicIOField", "Bar",
"Checkbox", "OptionGroup" o "WindowSlider".
BOOLEAN
Opcional. TRUE si la línea de borde del objeto parpadea.
Consulte también
Ellipse (Página 1385)
Circle (Página 1369)
EllipseSegment (Página 1388)
CircleSegment (Página 1372)

Rectangle (Página 1471)

Polygon (Página 1456)
TextField (Página 1505)
IOField (Página 1418)
SymbolicIOField (Página 1491)
Button (Página 1360)
Switch (Página 1488)
GraphicView (Página 1411)
GraphicIOField (Página 1408)
Bar (Página 1353)
CheckBox (Página 1366)
OptionGroup (Página 1453)
WindowSlider (Página 1538)
RoundButton (Página 1473)
BorderFlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la frecuencia de parpadeo de la línea de borde del objeto indicado.
Acceso en runtime:
● RT Professional: lectura/escritura
Sintaxis
Object.BorderFlashingRate[=FlashingRate]
Object
● Bar
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView

● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch
FlashingRate
BorderInnerStyle3D (RT Professional)
Descripción
Determina la representación de la parte interior del borde del objeto.
Sintaxis
Object.BorderInnerStyle3D[=SliderBorder3DStyle]
Object
● Gauge
● Slider
SliderBorder3DStyle
hmiGaugeBorder3DStyleNone (0): no hay ninguna parte interior del borde del objeto.
hmiGaugeBorder3DStyleRecessed (1): el borde del objeto se representa troquelado.
hmiGaugeBorder3DStyleRaised (2): el borde del objeto se representa realzado.
hmiGaugeBorder3DStyleGray (3): el borde del objeto tiene un marco gris uniforme.
hmiGaugeBorder3DStyleColored (4): el borde del objeto tiene un marco de color uniforme. El
color del borde se corresponde con el color del fondo.

BorderInnerWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde interior en una representación tridimensional del objeto indicado.
Sintaxis
Object.BorderInnerWidth3D[=Int32]
Object
● Slider
Int32
Opcional. Valor o constante que determina el ancho (en píxeles) del borde interior.
BorderOuterStyle3D (RT Professional)
Descripción
Determina la representación de la parte exterior del borde del objeto.
Sintaxis
Object.BorderOuterStyle3D[=GaugeBorder3DStyle]
Object
● Gauge
● Slider
GaugeBorder3DStyle
hmiGaugeBorder3DStyleNone (0): no hay ninguna parte interior del borde del objeto.
hmiGaugeBorder3DStyleRecessed (1): el borde del objeto se representa troquelado.
hmiGaugeBorder3DStyleRaised (2): el borde del objeto se representa realzado.
hmiGaugeBorder3DStyleGray (3): el borde del objeto tiene un marco gris uniforme.
hmiGaugeBorder3DStyleColored (4): el borde del objeto tiene un marco de color uniforme. El
color del borde se corresponde con el color del fondo.

BorderOuterWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde exterior en una representación tridimensional del objeto indicado.
Sintaxis
Object.BorderOuterWidth3D[=Int32]
Object
● Slider
Int32
Opcional. Valor o constante que determina el ancho del borde exterior en píxeles.
BorderShadeColor3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de las siguientes partes del borde para la representación en 3D del objeto
indicado:
● Partes internas superiores e inferiores del borde
● Partes externas inferiores y derechas del borde
Sintaxis
Object.BorderShadeColor3D[=Color]
Object
● Button
● RoundButton
● Slider
● Switch
Color
Opcional. Un valor o una constante que determina el color para el sombreado.

Observaciones
BorderStyle (RT Professional)
Descripción
Determina el tipo de líneas de borde del objeto indicado.
Sintaxis
Object.BorderStyle[=Int32]
Object
● Bar
● Button
● CheckBox
● ComboBox
● GraphicIOField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
● WindowsSlider
Int32
Opcional. Un valor o una constante que determina el tipo de líneas de borde del objeto
indicado.
0 = línea continua
1 = línea rayada
2 = línea punteada
3 = línea de rayas y puntos

4 = línea de raya-punto-punto
BorderStyle3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto indicado debe tener un borde sombreado tridimensional.
Acceso en runtime:
● RT Advanced: lectura y escritura
● RT Professional: ningún acceso
Sintaxis
Object.BorderStyle3D[=BOOLEAN]
Object
● DateTimeField
● IOField
● Switch
● TextField
● Bar
● Button
● GraphicIOField
● GraphicView
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el objeto posee un sombreado de borde 3D.
BorderWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el grosor de línea del objeto indicado.

Sintaxis
Object.BorderWidth[=Int32]
Object
● AlarmControl
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● Gauge
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● Slider
● SymbolicIOField
● TextField
● WindowsSlider


● Clock
● DateTimeField
● RecipeView
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Int32
Opcional. Valor o constante que establece el grosor de la línea en píxeles.
BorderWidth3D (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del borde interior en una representación tridimensional del objeto indicado.
Acceso en runtime:
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.

BottomMargin (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
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
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

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

3.5.5.3 Propiedades C (Panels, Comfort Panels, RT Advanced, RT Professional)
Caption (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el texto que se muestra en la barra de título del objeto indicado.
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.
CaptionBackColor (RT Professional)
Descripción
Determina el color de fondo de la barra de título del objeto indicado.
Sintaxis
Object.CaptionBackColor[=Color]
Object
● SymbolicIOField

Color
Opcional. Un valor o una constante que determina el color de fondo de la barra de título del
objeto indicado.
Observaciones
CaptionColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color del texto que se muestra en la barra de título del objeto indicado.
Sintaxis
Object.CaptionColor[=Color]
Object
● Gauge
● Switch
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color del texto.
Observaciones
CaptionText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el texto que se debe visualizar la barra de título del objeto indicado.

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.
CaptionTop (RT Professional)
Descripción
Determina la distancia de la rotulación de instrumentos respecto al borde superior del objeto
indicado. La rotulación de instrumentos solo se puede colocar a lo largo del diámetro vertical
del cuadrante. El valor del atributo hace referencia a la altura del objeto indicado. La altura la
determinan el borde superior del objeto indicado y el borde inferior del texto.
Sintaxis
Object.CaptionTop[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina la distancia de la rotulación de instrumentos
respecto del borde superior del objeto indicado.
Rango de valores de 0 a 1
0: el borde inferior del texto se encuentra sobre la delimitación superior del objeto indicado.
El texto ya no se ve, dado que se encuentra fuera del objeto indicado.
1: el borde inferior del texto se encuentra sobre la delimitación inferior del objeto indicado.

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
TRUE si el contenido se abrevia.
CellSpaceBottom (RT Professional)
Descripción
Establece la distancia inferior que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceBottom[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las apariencias siguientes:
● AlarmControl
● UserArchivControl
Int32
Opcional. Valor o constante que establece la distancia inferior que se utilizará en las celdas
de la tabla.

CellSpaceLeft (RT Professional)
Descripción
Establece el sangrado izquierdo que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceLeft[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o parámetro que determina el sangrado izquierdo dentro de las celdas de la
tabla.
CellSpaceRight (RT Professional)
Descripción
Establece el sangrado derecho que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceRight[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el sangrado derecho que se utilizará en las celdas
de la tabla.

CellSpaceTop (RT Professional)
Descripción
Establece la distancia superior que se utilizará en las celdas de la tabla.
Sintaxis
Object.CellSpaceTop[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece la distancia superior que se utilizará en las celdas
de la tabla.
CenterColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color del punto central del objeto "Gauge".
Sintaxis
Object.CenterColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color del punto central.

Observaciones
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
1: el diámetro se corresponde con el valor inferior de los atributos de geometría "Width" o
"Height".
ChangeMouseCursor (RT Professional)
Descripción
Determina si el aspecto del puntero del ratón debe permanecer invariable en runtime cuando
se encuentra 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.
CheckMarkAlignment (RT Professional)
Descripción
Determina si los campos se disponen justificados a la derecha.
Sintaxis
Object.CheckMarkAlignment[=ContentAlignment]
Object
● OptionGroup
● CheckBox
ContentAlignment
(0): Los campos se disponen justificados a la izquierda.
(1): Los campos se disponen justificados a la derecha.
CheckMarkCount (RT Professional)
Descripción
Determina el número de campos.
Sintaxis
Object.CheckMarkCount[=Int32]
Object
● OptionGroup


● CheckBox
Int32
Opcional. Un valor o una constante que determina el número de campos. Rango de valores
de 0 a 31
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.
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.

Closeable (RT Professional)
Descripción
Determina si la ventana puede cerrarse en runtime.
Sintaxis
Object.Closeable[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
BOOLEAN
Opcional. TRUE si la ventana puede cerrarse en runtime.
Consulte también
AlarmControl (Página 1338)
UserArchiveControl (Página 1528)
SystemDiagnoseWindow (Página 1501)
TrendRulerControl (Página 1508)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
OnlineTrendControl (Página 1443)
Color (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de línea del objeto indicado.
Sintaxis
Object.Color[=Color]
Object
● CircularArc
● EllipticalArc

● Line
● Polyline
● TubeArcObject
● Tubepolyline
● TubeTeeObject
Color
Opcional. Un valor o una constante que determina el color de línea.
Observaciones
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.

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.
ColumnAlignment (RT Professional)
Descripción
Determina cómo se alineará la columna seleccionada.
Son posibles los siguientes ajustes:
Valor Descripción Explicación

0 izquierda La columna seleccionada se alineará a la izquierda.
1 centrado La columna seleccionada se mostrará centrada.
2 derecha La columna seleccionada se alineará a la derecha.
El atributo puede dinamizarse con el nombre ColumnAlignment. El tipo de datos es LONG.
ColumnDateFormat (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el formato de fecha que se utilizará para la visualización. Mediante la propiedad
"ColumnIndex" se referencia la columna de fecha del visor de recetas. El atributo puede
dinamizarse con el nombre ColumnDateFormat.
Acceso en runtime: escritura
Sintaxis
Object.ColumnDateFormat(=String)

Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
String
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.
Consulte también
ColumnResize (RT Professional)
Descripción
Determina si se puede modificar el ancho de las columnas.
Sintaxis
Object.ColumnResize[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: puede modificarse el ancho de las columnas.
FALSE: no puede modificarse el ancho de las columnas.

Columns (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnScrollbar (RT Professional)
Descripción
Determina si las barras de desplazamiento de columnas se deben visualizar.
Sintaxis
Object.ColumnScrollbar[=Scrollbar]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"TrendRulerControl", "OnlineTableControl", "UserArchivControl".
Scrollbar
0 = (no) No se muestran las barras de desplazamiento de columnas.
1 = (en caso necesario) Se mostrarán las barras de desplazamiento de columnas si la
necesidad de espacio del control en el sentido vertical es superior al área de visualización
disponible.
2 = (siempre) Se muestran siempre las barras de desplazamiento de columnas.
Consulte también
ColumnSettings (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

ColumnSettingsBufferView (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnsMoveable (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextAckGroup (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextAlarmState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextAlarmText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextClassName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextDate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

ColumnTextDevice (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextDiagnosable (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextNumber (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTextTime (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ColumnTimeFormat (RT Professional)
Descripción
Determina qué formato de tiempo se utilizará. Mediante la propiedad "ColumnIndex" se
referencia la columna de tiempo del visor de recetas. El atributo puede dinamizarse con el
nombre ColumnTimeFormat.
Sintaxis
Object.ColumnTimeFormat(=String)
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".

String
Formatos de tiempo disponibles:
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.
ColumnTitleAlignment (RT Professional)
Descripción
Determina cómo se alinearán los títulos de columnas.
Sintaxis
Object.ColumnTitleAlignment[=GridColumnHeaderHorizontalAlignment]
Object
Necesario. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"TrendRulerControl", "OnlineTableControl", "UserArchivControl".
GridColumnHeaderHorizontalAlignment
0 = Los títulos de las columnas se justificarán a la izquierda.
1 = Los títulos de las columnas se justificarán centrados.
2 = Los títulos de las columnas se justificarán a la derecha.
3 = Los títulos de columnas se justificarán como el contenido de la columna correspondiente.
Consulte también
ColumnTitles (RT Professional)
Descripción
Determina si se debe mostrar el título de las columnas.
Sintaxis
Object.ColumnTitles[=BOOLEAN]

Object
● AlarmControl
● UserArchivControl
BOOLEAN
TRUE: se mostrará el título de las columnas.
FALSE: no se mostrará el título de las columnas.
ComboboxFont (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Dublette_CompatibilityMode (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)
ConnectionType (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Ningún acceso en Runtime
ConnectOnStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

ConnectTrendWindows (RT Professional)
Descripción
Determina 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.
Sintaxis
Object.ConnectTrendWindows[=BOOLEAN]
Object
BOOLEAN
TRUE: se conectan todos los visores de curvas configurados.
FALSE: los visores de curvas se muestran separados.
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
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.
CornerRadius (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
CornerStyle (RT Professional)
Descripción
Determina el tipo de líneas de borde del objeto indicado.
Acceso en runtime: sólo lectura
Sintaxis
Object.CornerStyle[=Int]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox

● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Tubepolyline
● WindowsSlider
● Ellipse
● EllipticalArc
● Switch
● TubeArcObject
Int
Opcional. Un valor o una constante que determina el tipo de líneas de borde del objeto
indicado.
0 = línea continua
1 = línea rayada
2 = línea punteada
3 = línea de rayas y puntos
4 = línea de raya-punto-punto
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".

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

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
Int32
Opcional. Valor o constante que determina cuántas líneas contiene la lista de selecció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.
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.
Curves (RT Advanced)
Descripción

3.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]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color del rango de peligro.
Observaciones
DangerRangeStart (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina 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.
Observaciones
El rango va desde el valor "Gefahr" hasta el final de la escala.
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".
DataFormat (RT Professional)
Descripción
Devuelve el tipo de datos del objeto IOField.

Sintaxis
Object.DataFormat[=IOFieldDataFormat]
Object
● IOField
IOFieldDataFormat
Opcional. Valor o constante que devuelve el tipo de datos del objeto IOField.
Margen de valores de 0 hasta 3.
● 0: Binaria
● 1: Decimal
● 2: Cadena
● 3: Hexadecimal
DataLogs (RT Professional)
Descripción
Devuelve un objeto del tipo "DataLogs".
Sintaxis
Object.DataLogs
Object
Obligatorio. Un objeto del tipo "Logging".
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".
Consulte también
DialColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la esfera en el objeto indicado.
Sintaxis
Object.DialColor[=Color]
Object
● Clock
● Gauge
Color
Opcional. Valor o constante que determina el color de la esfera.

Observaciones
DialFillStyle (RT Professional)
Descripción
Determina el tipo de fondo del objeto indicado.
Sintaxis
Object.DialFillStyle[=GaugeFillStyle]
Object
● Gauge
GaugeFillStyle
hmiGaugeBackStyleSolid (0): 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.
hmiGaugeBackStyleFrameTransparent (1): el fondo rectangular de Gauge 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.
hmiGaugeBackStyleTransparent (2): el fondo rectangular y el cuadrante son transparentes.
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".
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
DisplayButtonSaveAs (RT Advanced)
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.
Sintaxis
Object.DisplayOptions[=AlarmDisplayOptions]
Object
● AlarmControl
AlarmDisplayOptions
0: Todos los avisos
1: solo avisos visibles
2: solo avisos ocultos
DisplayStatusBar (RT Advanced)
Descripción
DisplayTable (RT Advanced)
Descripción
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

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.
DrawInsideFrame (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde o de forma simétrica respecto al borde.
Acceso en runtime:
Sintaxis
Object.DrawInsideFrame[=BOOLEAN]
Object
● Bar
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView

● OptionGroup
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● CheckBox
● Switch
● TubeArcObject
BOOLEAN
Opcional. TRUE si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde.
Drive (RT Professional)
Descripción
Determina la letra de la unidad de disco que debe vigilarse.
Sintaxis
Object.Drive[=STRING]
Object
● DiscSpaceView
STRING
Opcional. Un valor o una constante que determina la letra de la unidad de disco que debe
vigilarse.
3.5.5.5 Propiedades E-F (Panels, Comfort Panels, RT Advanced, RT Professional)
EdgeStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el estilo de línea del objeto indicado.

Sintaxis
Object.EdgeStyle[=LineStyle]
Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch

● SysDiagControl
● TrendView
● UserView
LineStyle
Opcional. Valor o constante que establece 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:
● hmiLineStyleSolid (0): línea continua
● hmiLineStyleDash (1): línea discontinua
● hmiLineStyleDot (2): línea de puntos
● hmiLineStyleDashDot (3): línea punto raya
● hmiLineStyleDashDotDot (4): línea punto punto raya
Los objetos "TextField"" y "IOField" solo admiten los estilos de línea:
● hmiLineStyleNone (-1): ninguna línea
● hmiLineStyleSolid (0): línea continua
Configuración estándar: hmiLineStyleSolid
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]
Object
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE si pueden introducirse datos inmediatamente cuando el campo de entrada
está seleccionado con la tecla <Tab>.

Enabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto indicado se puede manejar en runtime.
Sintaxis
Object.Enabled[=BOOLEAN]
Object
● AlarmControl
● AlarmView
● Bar
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer

● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolicIOField
● SymbolLibrary
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● Tubepolyline
● TubeTeeObject
● UserView
● WindowsSlider
BOOLEAN
Opcional. TRUE si el objeto indicado se puede manejar.
EnableEdit (RT Professional)
Descripción
Determina si se pueden modificar los datos mostrados en runtime.

Sintaxis
Object.EnableEdit[=BOOLEAN]
Object
BOOLEAN
TRUE: los datos se pueden modificar en runtime.
FALSE: los datos no se pueden modificar.
EnableNavigateKeys (RT Advanced)
Descripción
EndAngle (RT Professional)
Descripción
Determina el ángulo por el cual el punto final del objeto indicado se desvía de la posición cero
(0º).
Sintaxis
Object.EndAngle[=Int32]
Object
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject

Int32
Opcional. Un valor o una constante que determina el ángulo por el cual el punto final del objeto
indicado se desvía de la posición cero (0º).
EndLeft (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EndStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina cómo se representa el final de línea del objeto indicado.
Sintaxis
Object.EndStyle[=LineEndStyle]
Object
● Line
● Polyline
LineEndStyle
Opcional. Un valor o una constante que determina el final de línea. Rango de valores de 0 a
6.
hmiLineEndStyleNone (0): la línea no tiene ningún símbolo de fin.
hmiLineEndStyleArrow (1): la línea termina con una punta de flecha.
hmiLineEndStyleFilledArrow (2): la línea termina con una punta de flecha rellenada.
hmiLineEndStyleFilledArrowReversed (3): la línea termina con una punta de flecha invertida.
hmiLineEndStyleLine (4): la línea termina con una línea vertical.
hmiLineEndStyleCircle (5): la línea termina con un círculo.
hmiLineEndStyleFilledCircle (6): la línea termina con un círculo rellenado.

EndTop (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
EntryNameCaption (RT Advanced)
Descripción
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
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 1332)
TagSet (lista) (Página 1336)
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
Determina si el directorio para la exportación de datos se puede modificar en runtime.
Sintaxis
Object.ExportDirectoryChangeable=[BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el directorio para la exportación de datos se puede modificar en runtime.
FALSE: el directorio para la exportación de datos no se puede modificar en runtime.
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.
ExportFileExtension (RT Professional)
Descripción
Establece 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. Establece la extensión del archivo de exportación.
ExportFilename (RT Professional)
Descripción
Determina el nombre del archivo al cual se exportarán los datos de runtime.
Sintaxis
Object.ExportFilename[=STRING]

Object
● AlarmControl
STRING
Opcional. Determina el nombre del archivo al cual se exportarán los datos de runtime.
ExportFilenameChangeable (RT Professional)
Descripción
Determina si el nombre de archivo del archivo de exportación se puede modificar en runtime.
Sintaxis
Object.ExportFilenameChangeable[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el nombre del archivo de exportación se puede modificar en runtime.
FALSE: el nombre del archivo de exportación no se puede modificar en runtime.
ExportFormatGuid (RT Professional)
Descripción
Define la asignación de número de identidad y Export-Provider.

Sintaxis
Object.ExportFormatGuid[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define la asignación de número de identidad y Export-
Provider.
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.

ExportParameters (RT Professional)
Descripción
Establece los parámetros del formato seleccionado mediante 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.
ExportSelection (RT Professional)
Descripción
Determina qué datos de runtime del Control se exportarán.
Sintaxis
Object.ExportSelection[=ExportRange]
Object
● AlarmControl

ExportRange

0 Todo Todos los datos runtime del Control se exportarán.
1 Selección Los datos runtime seleccionados del Control se exportarán.
ExportShowDialog (RT Professional)
Descripción
Determina si el cuadro de diálogo para la exportación de datos se mostrará en runtime.
Sintaxis
Object.ExportShowDialog[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si el cuadro de diálogo se muestra en runtime.
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
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
FieldLength (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina que el campo "Longitud de campo de la cadena de caracteres" sea de sólo lectura.
Sintaxis
Object.FieldLength[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si el campo "Longitud de campo de la cadena de caracteres" es de sólo
lectura.
Se utiliza en los siguientes tipos de objeto

IOField
Consulte también

FieldLength (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FillColorMode (RT Professional)
Descripción
Determina el tipo de primer plano para el objeto indicado.
Sintaxis
Object.FillColorMode[=SymbolLibraryColorMode]
Object
● SymbolLibrary
SymbolLibraryColorMode
hmiSymbolLibraryAppearanceOriginal (0): la superficie es gris.
hmiSymbolLibraryAppearanceShaded (1): la representación está sombreada.
hmiSymbolLibraryAppearanceSolid (2): la representación es sólida.
hmiSymbolLibraryAppearanceTransparent (3): la representación es gris.
FillPatternColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el color del tipo de relleno del objeto indicado.
Acceso en runtime:
Sintaxis
Object.FillPatternColor[=Color]

Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicView
● IOField
● ListBox
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● AlarmControl
● DateTimeField
Color
Opcional. Valor o constante que establece el color del tipo de relleno del objeto indicado.
Observaciones

FillStyle (RT Advanced)
Descripción
Define el patrón de relleno del objeto indicado.
Sintaxis
Object.FillStyle[=LineFillStyle]
Object
● Line
● Polyline
LineFillStyle
Opcional. Valor o constante que determina el patrón de relleno.
hmiLineFillStyleTransparent (0): relleno transparente
hmiLineFillStyleSolid (1): el objeto se rellena con el color indicado
Ajuste estándar: hmiLineFillStyleSolid
FillstyleAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la alineación dentro del objeto indicado.
Filter (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FilterTag (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

FilterText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FirstConnectedObjectIndex (RT Professional)
Descripción
Determina el número de índice del punto de conector superior.
Sintaxis
Object.FirstConnectedObjectIndex[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Connector".
Int
Int
Consulte también
Connector (Página 1379)
FirstConnectedObjectName (RT Professional)
Descripción
Determina el nombre del objeto que está acoplado al punto de conector superior.
Sintaxis
Object.FirstConnectedObjectName[=String]
Object
String
String

Consulte también
FitToLargest (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FitToSize (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.
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.
FlashingColorOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "Off".
Acceso en runtime:

Sintaxis
Object.FlashingColorOff[=Color]
Object
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Bar
● CheckBox
● Switch
● TubeArcObject
Color
indicado para el estado de parpadeo "Off".
Observaciones

FlashingColorOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "On".
Acceso en runtime:
Sintaxis
Object.FlashingColorOn[=Color]
Object
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Bar
● CheckBox
● Switch
● TubeArcObject

Color
indicado para el estado de parpadeo "On".
Observaciones
FlashingEnabled (RT Professional)
Descripción
Determina si la línea de borde del objeto indicado parpadea en runtime.
Sintaxis
Object.FlashingEnabled[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con las especificaciones "Line", "Polyline",
"Ellipse", "Circle", "EllipseSegment", "CircleSegment", "EllipticalArc", "CircularArc",
"Rectangle", "Polygon", "TextField", "IOField", "SymbolicIOField", "Button", "Switch",
"GraphicIOField", "Bar", "Checkbox", "OptionGroup" o "Connector".
BOOLEAN
Opcional. TRUE si la línea de borde del objeto parpadea.
Consulte también
Line (Página 1422)
Polyline (Página 1459)
EllipticalArc (Página 1390)
CircularArc (Página 1374)


Bar (Página 1353)
FlashingOnLimitViolation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FlashingRate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la frecuencia de parpadeo de la línea de borde del objeto indicado.
Acceso en runtime:
Sintaxis
Object.FlashingRate[=FlashingRate]
Object
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse

● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Bar
● CheckBox
● Switch
● TubeArcObject
FlashingRate
FlashTransparentColor (RT Professional)
Descripción
Determina el color del objeto de mapa de bits de una imagen intermitente que se establece
en "transparente".
Sintaxis
Object.FlashTransparentColor[=Color]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "GraphicIOField".

Color
Opcional. Un valor o una constante que determina el color del objeto de mapa de bits de una
imagen intermitente que se establece en "transparente".
Consulte también
Flip (RT Professional)
Descripción
Voltea el símbolo por el eje central vertical y/u horizontal del mismo.
Sintaxis
Object.Flip[=SymbolLibraryFlip]
Object
● SymbolLibrary
SymbolLibraryFlip
hmiSymbolLibraryFlipNone (0): el símbolo no se voltea.
hmiSymbolLibraryFlipHorizontal (1): el símbolo se voltea horizontalmente.
hmiSymbolLibraryFlipVertical (2): el símbolo se voltea verticalmente.
hmiSymbolLibraryFlipBoth (3): el símbolo se voltea horizontal y verticalmente.
FocusColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color para el borde del foco del objeto indicado cuando el objeto posee el foco.
Sintaxis
Object.FocusColor[=Color]

Object
● AlarmView
● RecipeView
● Slider
● StatusForce
● Switch
● TrendView
● Button
● GraphicIOField
● SymbolicIOField
Color
Opcional. Valor o constante que determina el color para el borde del foco.
Observaciones
FocusWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el ancho del borde del objeto indicado cuando el objeto posee el foco.
Sintaxis
Object.FocusWidth[=Int32]
Object
● AlarmView
● RecipeView
● Slider
● StatusForce

● Switch
● TrendView
● Button
● GraphicIOField
● SymbolicIOField
Int32
Opcional. Un valor o una constante que determina el ancho del borde en píxeles. Rango de
valores de 1 a 10.
Font (RT Professional)
Descripción
Define la fuente, o la devuelve.
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".
Sintaxis
Object.Font[=Font]
Object
AlarmControl
Clock
FunctionTrendControl
OnlineTableControl
OnlineTrendControl
Slider

TrendRulerControl
UserArchiveControl
● Bar
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RangeLabelView
● RecipeView
● RoundButton
● SmartClientView
● Switch
● SymbolicIOField
● TextField
● TrendView
● ZoneLabelView
Font
Fuente
Ejemplo
'VBS74
Dim objControl1
Dim objControl2
Set objControl1 = ScreenItems("Control1")
Set objControl2 = ScreenItems("Control2")
objControl2.Font = objControl1.Font ' take over only the type of font

FontBold (RT Professional)
Descripción
Determina si el texto del objeto indicado se muestra en negrita.
Sintaxis
Object.FontBold[=BOOLEAN]
Object
● TextField
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el texto del objeto indicado se muestra en negrita.
FontItalic (RT Professional)
Descripción
Determina si el texto del objeto indicado se muestra en cursiva.
Sintaxis
Object.FontItalic[=BOOLEAN]

Object
● TextField
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el texto del objeto indicado se muestra en cursiva.
FontName (RT Professional)
Descripción
Establece la fuente del objeto indicado.
Sintaxis
Object.FontName[=STRING]
Object
● TextField
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup

● RoundButton
● SymbolicIOField
STRING
Opcional. Valor o constante que establece la fuente del objeto indicado.
FontSize (RT Professional)
Descripción
Establece el tamaño de fuente del texto del objeto indicado.
Sintaxis
Object.FontSize[=Int32]
Object
● TextField
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
Int32
Opcional. Valor o constante que establece el tamaño de fuente del texto del objeto indicado.
FontUnderline (RT Professional)
Descripción
Determina si el texto del objeto indicado se muestra subrayado.

Sintaxis
Object.FontUnderline[=BOOLEAN]
Object
● TextField
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el texto del objeto indicado se muestra subrayado.
ForeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el color de fuente del texto del objeto indicado.
Sintaxis
Object.ForeColor[=Color]
Object
● Bar
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox

● MultiLineEdit
● OptionGroup
● RecipeView
● RoundButton
● Slider
● Switch
● SymbolLibrary
● SymbolicIOField
● TextField
● AlarmView
Color
Opcional. Valor o constante que establece el color de fuente del texto del objeto indicado.
Observaciones
ForeColorTransparency (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
FormatPattern (RT Professional)
Descripción
Determina el formado del valor de salida.
Acceso en runtime: leer
Sintaxis
Object.FormatPattern[=STRING]

Object
● IOField
STRING
Opcional. Un valor o una constante que determina el formato del valor de salida.
Free (RT Professional)
Descripción
Devuelve el tamaño de la memoria libre.
Sintaxis
Object.Free[=DOUBLE]
Object
● DiscSpaceView
DOUBLE
Opcional. Un valor o una constante que devuelve el tamaño de la memoria libre.
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.

3.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".
Sintaxis
Object.Gradation[=SINGLE]
Object
● Gauge
SINGLE
Opcional. Valor o constante que determina la diferencia de valor.
GraphDirection (RT Professional)
Descripción
Determina el borde de la ventana de curvas en el que se muestran los valores actuales.
Sintaxis
Object.GraphDirection[=GraphDirection]
Object
GraphDirection
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.

GridLineColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece el color de las líneas de cuadrícula.
Sintaxis
Object.GridLineColor[=Color]
Object
● AlarmControl
● AlarmView
● TrendView
Color
Opcional. Valor o constante que establece el color de las líneas de cuadrícula.
Observaciones
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]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el grosor de la línea de separación.
HeaderFont (RT Advanced)
Descripción
Height (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la altura del objeto indicado.
Sintaxis
Object.Height[=Int32]
Object
● AlarmControl
● AlarmView

● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RangeLabelView
● RangeQualityView

● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Con la siguiente apariencia no tiene acceso en runtime:
● S7GraphOverview
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 1422)


Bar (Página 1353)
Clock (Página 1376)
Gauge (Página 1405)
Slider (Página 1481)
SymbolLibrary (Página 1496)
HTMLBrowser (Página 1416)
ScreenWindow (Página 1477)
DiskSpaceView (Página 1383)
ChannelDiagnose (Página 1364)
ScriptDiagnostics (Página 1479)
Group (Página 1414)
ForeignControl (Página 1393)
ProtectedAreaName (Página 1463)
UserView (Página 1536)
TubeTeeObject (Página 1526)
TubePolyline (Página 1524)
TubeDoubleTeeObject (Página 1522)
TubeArcObject (Página 1520)
MultiLineEdit (Página 1429)
MediaPlayer (Página 1427)
Listbox (Página 1424)
DateTimeField (Página 1381)
ProjectName (Página 1461)
AlarmView (Página 1350)

BatteryView (Página 1359)

RangeLabelView (Página 1464)
ZoneQualityView (Página 1543)
ZoneLabelView (Página 1542)
WLanQualityView (Página 1541)
TrendView (Página 1516)
SystemDiagnoseView (Página 1498)
StatusForce (Página 1486)
SmartClientView (Página 1484)
RecipeView (Página 1467)
RangeQualityView (Página 1466)
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
● 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.

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 *.
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]
Object
● WindowsSlider
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
constantes de color VBS, tales como vbRed y vbGreen.
Hitlist (RT Professional)
Descripción
HitlistColumnAdd (RT Professional)
Descripción
Aplica el bloque de aviso seleccionado de la lista de bloques de aviso existentes y lo introduce
en la lista de bloques de aviso seleccionados.
Sintaxis
Object.HitlistColumnAdd[=STRING]
Object
● AlarmControl
STRING
Opcional. Aplica el bloque de aviso seleccionado en la lista de bloques de aviso existentes y
lo introduce en la lista de bloques de aviso seleccionados.
HitlistColumnCount (RT Professional)
Descripción
Especifica el número de bloques de aviso seleccionados que aparecerán en la lista de aciertos
en runtime.
Sintaxis
Object.HitlistColumnCount[=Int32]

Object
● AlarmControl
Int32
Opcional. Especifica el número de bloques de aviso seleccionados que aparecerán en la lista
de aciertos en runtime.
HitlistColumnIndex (RT Professional)
Descripción
Hace referencia a uno de los bloques de aviso seleccionados para la lista de aciertos. Mediante
la utilización de este atributo podrá asignar a un bloque de aviso determinado de la lista de
aciertos los valores de otros atributos.
Los valores válidos para "HitlistColumnIndex" se encuentran entre 0 y "HitlistColumnCount"
menos 1. El atributo "HitlistColumnCount" indica el número de bloques de aviso seleccionados
para la lista de aciertos. El atributo "HitlistColumnIndex" se puede dinamizar con el atributo
HitlistColumnRepos.
Sintaxis
Object.HitlistColumnIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Hace referencia a uno de los bloques de aviso seleccionados para la lista de aciertos.
HitlistColumnName (RT Professional)
Descripción
Define el nombre del bloque de aviso de la lista de aciertos que ha sido referenciado con el
atributo "HitlistColumnIndex". No se puede modificar el nombre.
Sintaxis
Object.HitlistColumnName[=STRING]

Object
● AlarmControl
STRING
Opcional. Define el nombre del bloque de aviso de la lista de aciertos que ha sido referenciado
con el atributo "HitlistColumnIndex".
HitlistColumnRemove (RT Professional)
Descripción
Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo introduce
en la lista de bloques de aviso existentes.
Sintaxis
Object.HitlistColumnRemove[=STRING]
Object
● AlarmControl
STRING
Opcional. Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo
introduce en la lista de bloques de aviso existentes.
HitlistColumnRepos (RT Professional)
Descripción
Modifica la secuencia de los bloques de aviso. "Arriba" y "Abajo" desplazan el bloque de aviso
seleccionado en la lista. De esta forma en el runtime se desplazará hacia arriba o abajo el
bloque de aviso en Control.
Sintaxis
Object.HitlistColumnRepos[=Int32]
Object
● AlarmControl

Int32
Opcional. Modifica la secuencia de los bloques de aviso.
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
0: ninguna clasificación.
1: clasificación ascendente desde el valor menor hasta el mayor.
2: clasificación descendente desde el valor mayor hasta el menor.
HitlistColumnSortIndex (RT Professional)
Descripción
Define la secuencia de clasificación del bloque de aviso de la lista de aciertos referenciado
en "HitlistColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se eliminará de
"HitlistColumnSort".
Sintaxis
Object.HitlistColumnSortIndex[=Int32]
Object
● AlarmControl

Int32
Opcional. Define la secuencia de clasificación del bloque de aviso de la lista de aciertos
referenciado en "HitlistColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se
eliminará de "HitlistColumnSort".
HitlistColumnVisible (RT Professional)
Descripción
Establece una lista con los bloques de aviso seleccionados de la lista de aciertos que se
utilizarán en el control en runtime.
Sintaxis
Object.HitlistColumnVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. Establece una lista con los bloques de aviso seleccionados de la lista de aciertos
que se utilizarán en el control en runtime.
HitlistDefaultSort (RT Professional)
Descripción
Define la clasificación determinada en las columnas de la tabla de la lista de aciertos.
Sintaxis
Object.HitlistDefaultSort[=SortMode]
Object
● AlarmControl
SortMode
0: la lista se clasificará de forma ascendente según la frecuencia.
1: la lista se clasificará de forma descendente según la frecuencia.

HitlistMaxSourceItems (RT Professional)
Descripción
Establece el número máximo de registros que se utilizan del fichero de avisos para la creación
de la lista de aciertos. El valor puede elegirse libremente entre "0 - 10000".
Sintaxis
Object.HitlistMaxSourceItems[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el número máximo de registros que se utilizan del
fichero de avisos para la creación de la lista de aciertos.
HitlistMaxSourceItemsWarn (RT Professional)
Descripción
Determina si se muestra una advertencia cuando se alcanza el número máximo de registros
especificado en "HitlistMaxSourceItems".
Sintaxis
Object.HitlistMaxSourceItemsWarn[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "AlarmControl".
BOOLEAN
Opcional. TRUE si se muestra una advertencia cuando se alcanza el número máximo de
registros especificado en "HitlistMaxSourceItems".
Consulte también

HitListRelTimeFactor (RT Professional)
Descripción
Establece el factor de tiempo que, con el tipo de tiempo "HitlistRelTimeFactorType", determina
el período para el que se crea la estadística de la lista de aciertos.
Si no desea especificar un período, ajuste el factor de tiempo a "0".
Sintaxis
Object.HitlistRelTimeFactor[=Long]
Object
Long
Opcional. Valor o constante que establece el factor de tiempo.
Consulte también
HitlistRelTimeFactorType (RT Professional)
Descripción
Establece el tipo de tiempo que, con el factor de tiempo "HitlistRelTimeFactor", determina el
período para el que se crea la estadística de la lista de aciertos.
Sintaxis
Object.HitlistRelTimeFactorType[=AlarmViewAdvancedTimeFactorUnit]
Object
AlarmViewAdvancedTimeFactorUnit
hmiAlarmViewAdvancedTimeFactorUnitMinute ( 0): el intervalo de tiempo para la estadística
se mide en minutos.
hmiAlarmViewAdvancedTimeFactorUnitHour ( 1): el intervalo de tiempo para la estadística se
mide en horas.
hmiAlarmViewAdvancedFactorUnitDay ( 2): el intervalo de tiempo para la estadística se mide
en días.

hmiAlarmViewAdvancedTimeFactorUnitWeek ( 3): el intervalo de tiempo para la estadística

se mide en semanas.
hmiAlarmViewAdvancedTimeFactorUnitMonth ( 4): el intervalo de tiempo para la estadística
se mide en meses.
Consulte también
HitListRelTime (RT Professional)
Descripción
Determina si se utilizará el intervalo de tiempo para la estadística.
Si no desea especificar un período, ajuste el factor de tiempo a "0".
Sintaxis
Object.HitListRelTime [=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: si no hay ningún intervalo de tiempo en la selección, se utilizará el intervalo de tiempo
indicado para la estadística.
FALSE: no se utilizará el intervalo de tiempo indicado.
HorizontalAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la orientación horizontal del texto dentro del objeto indicado.
Sintaxis
Object.HorizontalAlignment[=HorizontalAlignment]

Object
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● Switch
● SymbolicIOField
● TextField
HorizontalAlignment
Opcional. Un valor o una constante que determina la orientación horizontal del texto.
hmiAlignmentLeft (0):el texto se justifica a la izquierda en el objeto.
hmiAlignmentCentered (1): el texto se centra horizontalmente en el objeto.
hmiAlignmentRight (2): el texto se justifica a la derecha en el objeto.
HorizontalGridLines (RT Professional)
Descripción
Determina si se deben visualizar líneas horizontales.
Sintaxis
Object.HorizontalGridLines[=BOOLEAN]
Object
● AlarmControl

BOOLEAN
TRUE: se muestran las líneas horizontales.
FALSE: no se muestran las líneas horizontales.
HorizontalScrollBarPosition (RT Professional)
Descripción
Define el desplazamiento horizontal de la barra de desplazamiento en una ventana de imagen
con barras de desplazamiento.
La imagen se representa en la ventana de imagen con el desplazamiento horizontal o vertical
de las barras de desplazamiento. Si desea representar la imagen recortada en la que las
barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en el borde
superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen de esta
área.
Sintaxis
Object.HorizontalScrollBarPosition[=Int32]
Object
● ScreenWindow
Int32
Opcional. Valor o constante que define el desplazamiento horizontal de la barra de
desplazamiento en una ventana de imagen con barras de desplazamiento.
Hotkey (RT Professional)
Descripción
En el objeto Botón retorna la tecla de funciones para el manejo del ratón.
Sólo acceso de lectura.
Consulte también

HourNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la longitud de la aguja horaria en el objeto "Clock".
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.
HourNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho de la aguja horaria en el objeto "Clock".
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.

3.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.
Index (RT Professional)
Descripción
Determina el índice del campo de texto seleccionado.
Sintaxis
Object.Index[=Int32]
Object
● CheckBox
● ComboBox
● ListBox
● OptionGroup

Int32
Opcional. Un valor o una constante que determina el índice del campo de texto seleccionado.
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.
Observaciones
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
InputValue (RT Professional)
Descripción
Define el valor introducido por el usuario en el campo E/S. El valor no se muestra en el campo
E/S al activar la propiedad.
Si quiere que el valor introducido aparezca en el campo E/S tras confirmar con la tecla
<Return>, configure una conexión directa entre las propiedades "Valor de entrada" y "Valor
de salida". La conexión directa solo resulta conveniente cuando no se ha configurado ninguna
conexión con una variable en el valor de salida, pero el usuario desea consultar de todos
modos el valor introducido, p. ej., mediante un script.
Sintaxis
Object.InputValue[=Object]
Object
● IOField
● SymbolicIOField
Object
Opcional. Valor o constante que establece el valor de entrada.
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]
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).
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.
ItemBorderStyle (RT Professional)
Descripción
Establece el tipo de las líneas de separación en la lista de selección del objeto indicado.

Sintaxis
Object.ItemBorderStyle[=Int32]
Object
● SymbolicIOField
Int32
hmiLineStyleNone (-1): la lista de selección no tiene líneas de separación.
hmiLineStyleSolid ( 0): la lista de selección tiene líneas de separación continuas.
hmiLineStyleDash ( 1): la lista de selección tiene líneas de separación discontinuas.
hmiLineStyleDot ( 2): la lista de selección tiene líneas de separación de puntos.
hmiLineStyleDashDot ( 3): la lista de selección tiene líneas de separación punto raya.
hmiLineStyleDashDotDot ( 4): la lista de selección tiene líneas de separación punto punto raya.
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
● WindowsSlider
BOOLEAN
Opcional. TRUE si el deslizador se coloca en el valor final correspondiente.

3.5.5.8 Propiedades K-L (Panels, Comfort Panels, RT Advanced, RT Professional)
LabelColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de rotulación de la escala en el objeto "Slider".
Sintaxis
Object.LabelColor[=Color]
Object
● Slider
Color
Opcional. Valor o constante que determina el color de rotulación de la escala.
Observaciones
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
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.
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.
LastConnectedObjectIndex (RT Professional)
Descripción
Determina el número de índice del punto de conexión con el último objeto asociado.
Sintaxis
Object.LastConnectedObjectIndex[=Int]
Object
Int
Int
Consulte también
LastConnectedObjectName (RT Professional)
Descripción
Determina el nombre del objeto que está acoplado en el punto de conector inferior.
Sintaxis
Object.LastConnectedObjectName[=String]
Object
String
String
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
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 1332)
TagSet (lista) (Página 1336)
Layer (RT Advanced, RT Professional)
Descripción
Dentro de la imagen, devuelve como LONG 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
Object
Obligatorio. Un objeto del tipo "ScreenItem".
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
ZoneQualityView (Página 1543)
ZoneLabelView (Página 1542)
WLanQualityView (Página 1541)
ProtectedAreaName (Página 1463)
RangeLabelView (Página 1464)
RangeQualityView (Página 1466)
BatteryView (Página 1359)


Bar (Página 1353)
Line (Página 1422)
RecipeView (Página 1467)


SystemDiagnoseView (Página 1498)
ProjectName (Página 1461)
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.
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 del objeto indicado.
Sintaxis
Object.Left[=DOUBLE]
Object
Obligatorio. Un objeto del tipo "ScreenItem". Ésta es una propiedad estándar del objeto
ScreenItem-Objekts, por lo que está disponible en todas las apariencias.
DOUBLE
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.
Se utiliza en los siguientes tipos de objeto

AUTOHOTSPOT

AUTOHOTSPOT
AUTOHOTSPOT
LeftOffset (RT Professional)
Descripción
Determina la distancia de la imagen desde el borde izquierdo de la ventana de imagen.
La imagen se visualizará como corte de la ventana de imagen. 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" y "VerticalScrollBarPosition".
Sintaxis
Object.LeftOffset[=Int32]
Object
● Screenwindow
Int32
Opcional. Valor o constante que determina la distancia de la imagen desde el borde izquierdo
de la ventana de imagen.
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.
Limit4LowerLimitColor (RT Professional)
Descripción
Determina el color para el valor límite inferior "Reserve4".
La propiedad "Limit4LowerLimitEnabled" debe tener el valor TRUE cuando debe modificarse
Sintaxis
Object.Limit4LowerLimitColor[=Color]
Object
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite inferior
"Reserve4".
Observaciones
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".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit4LowerLimit",
"Limit4LowerLimitColor" y "Limit4LowerLimitRelative":
● Valor límite
Limit4LowerLimitRelative (RT Professional)
Descripción
Determina si el valor límite inferior "Reserve4" se evalúa en porcentaje o de forma absoluta.
Sintaxis
Object.Limit4LowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "Reserve4" se evalúa en porcentaje.
FALSE: el valor límite inferior "Reserve4" se evalúa de forma absoluta.

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
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.
Limit4UpperLimitColor (RT Professional)
Descripción
Determina el color para el valor límite superior "Reserve4".
La propiedad "Limit4UpperLimitEnabled"" debe tener el valor TRUE si debe modificarse el
color de barra al alcanzar el valor límite.
Sintaxis
Object.Limit4UpperLimitColor[=Color]
Object
● Bar

Color
Opcional. Un valor o una constante que determina el color para el valor límite superior
"Reserve4".
Observaciones
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
Limit4UpperLimitRelative (RT Professional)
Descripción
Determina si el valor límite superior "Reserve4" se evalúa en porcentaje o de forma absoluta.

Sintaxis
Object.Limit4UpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
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".
Observaciones
La propiedad "Limit5LowerLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Limit5LowerLimitColor (RT Professional)
Descripción
Determina el color para el valor límite inferior "Reserve5".

La propiedad "Limit5LowerLimitEnabled" debe tener el valor TRUE cuando debe modificarse

Sintaxis
Object.Limit5LowerLimitColor[=Color]
Object
● Bar
Color
"Reserve5".
Observaciones
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
Limit5LowerLimitRelative (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
BOOLEAN
Opcional.
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.
Limit5UpperLimitColor (RT Professional)
Descripción
Determina el color para el valor límite superior "Reserve5".
La propiedad "Limit5UpperLimitEnabled" debe tener el valor TRUE cuando debe modificarse
Sintaxis
Object.Limit5UpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite superior
"Reserve5".
Observaciones

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
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior "Reserve5".
Limit5UpperLimitRelative (RT Professional)
Descripción
Determina si el valor límite superior "Reserve5" se evalúa en porcentaje o de forma absoluta.
Sintaxis
Object.Limit5UpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite superior "Reserve5" se evalúa en porcentaje.
FALSE: el valor límite superior "Reserve5" se evalúa de forma absoluta.

LineColor (RT Professional)
Descripción
Define el color de las líneas de separación de la ventana. Mediante el botón abra el cuadro
de diálogo "Selección de color" para seleccionar el color.
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
LineEndShapeStyle (RT Professional)
Descripción
Determina la apariencia de los finales de línea.
Sintaxis
Object.LineEndShapeStyle[=LineEndShapeStyle]

Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● Switch
Con las siguientes apariencias no se tiene acceso en runtime:
● Switch
● TubeArcObect
LineEndShapeStyle
Opcional. Valor o constante que determina la apariencia de los finales de línea.

LineWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el grosor de línea del objeto indicado.
Sintaxis
Object.LineWidth[=Int32]
Object
● AlarmControl
● CircularArc
● EllipticalArc
● Line
● Polyline
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● Polygon
Int32
Opcional. Un valor o una constante que determina el grosor de línea en píxeles.
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.

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.
LocalCursor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
LockSquaredExtent (RT Professional)
Descripción
Determina si el tamaño del reloj puede ajustarse con el ratón.
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.

Logging (RT Professional)
Descripción
Devuelve un objeto del tipo "Logging".
Sintaxis
Object.Logging
Object
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.
Sintaxis
Object.LogOperation[=BOOLEAN]
Object
● CheckBox
● ComboBox
● IOField
● ListBox
● OptionGroup
● SymbolicIOField
● WindowsSlider
BOOLEAN
Opcional. TRUE, si después de una operación con este objeto se visualiza un aviso en el
sistema de avisos.

LongTermArchiveConsistency (RT Professional)
Descripción
Determina cómo se mostrarán los avisos en la lista de ficheros históricos.
Sintaxis
Object.LongTermArchiveConsistency[= BOOLEAN]
Object
● AlarmControl
BOOLEAN
Valor Explicación
TRUE Se muestran los últimos 1000 avisos en el cliente de todos los servidores o par de servi‐
dores redundantes en la lista de ficheros históricos.
FALSE Se muestran 1000 avisos en la lista de ficheros históricos en el monopuesto, en el servidor
o en el cliente por cada servidor o par de servidores redundantes.
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.

LowLimitColor (RT Professional)
Descripción
Determina el color del botón inferior o izquierdo para desplazarse por una barra de
desplazamiento.
Sintaxis
Object.LowLimitColor[=Color]
Object
● WindowsSlider
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
3.5.5.9 Propiedades M-N (Panels, Comfort Panels, RT Advanced, RT Professional)
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.
Sintaxis
Object.MachineName[=STRING]

Object
● SmartClientView
STRING
Opcional. Valor o constante que contiene la ID de red.
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
● WindowsSlider
Int32
Opcional. Un valor o una constante que determina el ancho del borde 3D en píxeles.
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]
Object
● Bar
● Gauge
● Slider
● WindowsSlider

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
MenuToolBarConfig (RT Professional)
Descripción
Carga el archivo de configuración indicado con los menús y barras de herramientas definidos
por el usuario o reproduce el nombre del archivo de configuración.
Sintaxis
Object.MenuToolBarConfig[=HmiObjectHandle]
Object
● Screenwindow
HmiObjectHandle
Opcional. El archivo de configuración con menú personalizado y barras de herramientas.
MessageBlockAlignment (RT Professional)
Descripción
Determina cómo se van a alinear los contenidos del bloque de aviso seleccionado en la tabla.
Sintaxis
Object.MessageBlockAlignment [=HorizontalAlignment]
Object
Necesario. Objeto del tipo "ScreenItem" con las apariencias "AlarmContro",
"TrendRulerControl", "OnlineTableControl", "UserArchiveControl".

HorizontalAlignment

0 izquierda Los contenidos del bloque de aviso seleccionado se mostrarán justificados
a la izquierda.
1 centrado Los contenidos del bloque de aviso seleccionado se mostrarán centrados.
2 derecha Los contenidos del bloque de aviso seleccionado se mostrarán justificados
a la derecha.
Consulte también
MessageBlockAutoPrecisions (RT Professional)
Descripción
Determina si la cantidad de dígitos de coma se debe determinar automáticamente.
Sintaxis
Object.MessageBlockAutoPrecisions[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el número de decimales se determinará automáticamente.
FALSE: el valor del campo "Decimales" tiene efecto.
MessageBlockCaption (RT Professional)
Descripción
Establece el título de la columna en el visor de avisos para el bloque de aviso seleccionado.
La opción "Aplicar configuración del proyecto" debe estar desactivada para poder modificar
las designaciones. El nombre introducido es efectivo en todos los idiomas de runtime.
Sintaxis
Object.MessageBlockCaption[=STRING]

Object
● AlarmControl
STRING
Opcional. Establece el título de la columna en el visor de avisos para el bloque de aviso
seleccionado.
MessageBlockCount (RT Professional)
Descripción
Especifica el número de bloques de aviso existentes que están disponibles para la lista de
avisos y la lista de aciertos.
Sintaxis
Object.MessageBlockCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Especifica el número de bloques de aviso existentes que están disponibles para la
lista de avisos y la lista de aciertos.
MessageBlockDateFormat (RT Professional)
Descripción
Determina qué formato de fecha se debe utilizar para los avisos.
Sintaxis
Object.MessageBlockDateFormat[=STRING]
Object
● AlarmControl

STRING
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.
MessageBlockExponentialFormat (RT Professional)
Descripción
Determina si los valores del bloque de aviso seleccionado se mostrarán en representación
exponencial.
Sintaxis
Object.MessageBlockExponentialFormat[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: los valores se muestran en representación exponencial.
FALSE: los valores se muestran en representación decimal.
MessageBlockFlashOn (RT Professional)
Descripción
Establece si contenido del bloque de aviso parpadeé en runtime si aparece un aviso.
Sintaxis
Object.MessageBlockFlashOn[=BOOLEAN]
Object
● AlarmControl

BOOLEAN
TRUE: el contenido del bloque de aviso parpadea.
FALSE: el contenido del bloque de aviso no parpadea.
MessageBlockHideText (RT Professional)
Descripción
Determina si el contenido del bloque de aviso el texto se mostrará en forma de texto.
Sintaxis
Object.MessageBlockHideText[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el contenido no se muestra en forma de texto. La opción no está activada.
FALSE: el contenido se muestra en forma de texto. La opción está activada.
MessageBlockHideTitleText (RT Professional)
Descripción
Determina si el título del bloque de aviso seleccionado se mostrará en forma de texto.
Sintaxis
Object.MessageBlockHideTitleText[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el título no se mostrará en forma de texto. La opción no está activada.
FALSE: el título se mostrará en forma de texto. La opción está activada.

MessageBlockId (RT Professional)
Descripción
Define la asignación de clave ID y bloque de aviso en el visor de avisos.
Sintaxis
Object.MessageBlockId[=Int32]
Object
● AlarmControl
Int32
Opcional. Define la asignación de clave ID y bloque de aviso en el visor de avisos.
MessageBlockIndex (RT Professional)
Descripción
Hace referencia a un bloque de aviso ya existente. Mediante la utilización de este atributo
podrá asignar a un bloque de aviso determinado los valores de otros atributos. Los valores
válidos para "MessageBlockIndex" se encuentran entre 0 y "MessageBlockCount" menos 1.
El atributo "MessageBlockIndex" se puede dinamizar con el atributo MessageBlockRepos.
Sintaxis
Object.MessageBlockIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Hace referencia a un bloque de aviso ya existente. Los valores válidos para
"MessageBlockIndex" se encuentran entre 0 y "MessageBlockCount" menos 1.

MessageBlockLeadingZeros (RT Professional)
Descripción
Determina si el formato del bloque de aviso seleccionado se mostrará con ceros a la
izquierda.
Sintaxis
Object.MessageBlockLeadingZeros[=Int32]
Object
● AlarmControl
Int32
TRUE: se mostrarán ceros a la izquierda. El número de los ceros a la izquierda se establece
en las propiedades.
FALSE: no se mostrarán ceros a la izquierda.
MessageBlockLength (RT Professional)
Descripción
Establece la "Longitud en caracteres" para el contenido del bloque de aviso seleccionado.
Solamente se podrá introducir un valor si el campo "Aplicar preferencias de proyecto" no está
activo.
Sintaxis
Object.MessageBlockLength[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor que establece la longitud del bloque de aviso.

MessageBlockName (RT Professional)
Descripción
Define el nombre para el bloque de aviso seleccionado.
Sintaxis
Object.MessageBlockName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
STRING
Opcional. Define el nombre para el bloque de aviso seleccionado.
MessageBlockPrecisions (RT Professional)
Descripción
Define el número de posiciones decimales de los valores del bloque de aviso seleccionado.
Solamente se puede indicar el valor si la opción "Automático" está desactivada.
Sintaxis
Object.MessageBlockPrecisions[=Int16]
Object
● AlarmControl
Int16
Opcional. Determina el número de decimales.
MessageBlockSelected (RT Professional)
Descripción
Los bloques de aviso existentes son bloques que están disponibles para la lista de avisos o
la lista de aciertos en el control en runtime.

En la ficha "Bloques de aviso" active los bloques que necesite en Control de los bloques de
aviso existentes. En las fichas "Lista de aciertos" y "Lista de avisos" configure las listas de
aciertos y avisos de los bloques existentes.
Sintaxis
Object.MessageBlockSelected[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. En la ficha "Bloques de aviso" active los bloques que necesite en Control de los
bloques de aviso existentes. En las fichas "Lista de aciertos" y "Lista de avisos" configure las
listas de aciertos y avisos de los bloques existentes.
MessageBlockShowDate (RT Professional)
Descripción
Establece si en el bloque de aviso "Hora" se mostrará la fecha junto con la hora.
Sintaxis
Object.MessageBlockShowDate[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se muestran la fecha y la hora.
FALSE: se muestra la hora.
MessageBlockShowIcon (RT Professional)
Descripción
Determina si el contenido del bloque de aviso se mostrará en forma de símbolo.

Sintaxis
Object.MessageBlockShowIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el contenido se muestra en forma de símbolo.
FALSE: el contenido no se muestra en forma de símbolo.
MessageBlockShowTitleIcon (RT Professional)
Descripción
Determina si el título del bloque de aviso seleccionado se mostrará en forma de texto.
Sintaxis
Object.MessageBlockShowTitleIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el título se mostrará en forma de símbolo.
FALSE: el título no se mostrará en forma de símbolo.
MessageBlockTextId (RT Professional)
Descripción
Define la denominación para el bloque de aviso seleccionado con ayuda de un ID de texto
obtenido en Text-Library. Si se cambia el idioma runtime la denominación se ajustará
automáticamente.
Para indicar un ID de texto, desactive la opción "Aplicar la configuración del proyecto".

Sintaxis
Object.MessageBlockTextId[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Int32
Opcional. Define el nombre del bloque de aviso seleccionado con ayuda de un ID de texto.
MessageBlockTimeFormat (RT Professional)
Descripción
Determina qué formato de tiempo o de duración se debe utilizar para visualizar los avisos.
Sintaxis
Object.MessageBlockTimeFormat[=STRING]
Object
● AlarmControl
STRING
Los siguientes formatos de tiempo están a disposición:
Valor Explicación
Automático El formato de tiempo se generará automáticamente.
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.

MessageBlockType (RT Professional)
Descripción
Indica el número de bloques de aviso existentes que están disponibles para la lista de avisos
y la lista de aciertos.
Sintaxis
Object.MessageBlockType[=AlarmBlockType]
Object
● AlarmControl
AlarmBlockType

0 Bloque de sistema El bloque de aviso pertenece a los bloques de sistema
1 Bloque de texto El bloque de aviso pertenece a los bloques de texto de usuario
2 Bloque de valor de El bloque de aviso pertenece a los bloques de valor de proceso
proceso
3 Bloque de lista de El bloque de aviso pertenece a los bloques de aviso de la lista de aciertos.
aciertos
MessageColumnAdd (RT Professional)
Descripción
Aplica el bloque de aviso marcado de la lista de bloques de aviso existentes y lo introduce en
la lista de bloques de aviso seleccionados.
Sintaxis
Object.MessageColumnAdd[=STRING]
Object
● AlarmControl
STRING
Opcional. Aplica el bloque de aviso marcado de la lista de bloques de aviso existentes y lo
introduce en la lista de bloques de aviso seleccionados.

MessageColumnCount (RT Professional)
Descripción
Especifica el número de bloques de aviso seleccionados que aparecerán en la lista de avisos
en runtime.
Sintaxis
Object.MessageColumnCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Especifica el número de bloques de aviso seleccionados que aparecerán en la lista
de avisos en runtime.
MessageColumnIndex (RT Professional)
Descripción
Hace referencia a uno de los bloques de aviso seleccionados para la lista de avisos. Mediante
la utilización de este atributo podrá asignar a un bloque de aviso determinado de la lista de
avisos los valores de otros atributos.
Los valores válidos para "MessageColumnIndex" se encuentran entre 0 y
"MessageColumnCount" menos 1. El atributo "MessageColumnIndex" puede dinamizarse con
el atributo MessageColumnRepos.
Sintaxis
Object.MessageColumnIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Hace referencia a uno de los bloques de aviso seleccionados para la lista de avisos.
Los valores válidos para "MessageColumnIndex" se encuentran entre 0 y
"MessageColumnCount" menos 1.

MessageColumnName (RT Professional)
Descripción
Define el nombre del bloque de aviso de la lista de avisos referenciado con la propiedad
"MessageColumnIndex".
Sintaxis
Object.MessageColumnName[=STRING]
Object
● AlarmControl
STRING
Opcional. Define el nombre del bloque de aviso de la lista de avisos referenciado con la
propiedad "MessageColumnIndex".
MessageColumnRemove (RT Professional)
Descripción
Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo introduce
en la lista de bloques de aviso existentes.
Sintaxis
Object.MessageColumnRemove[=STRING]
Object
● AlarmControl
STRING
Opcional. Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo
introduce en la lista de bloques de aviso existentes.

MessageColumnRepos (RT Professional)
Descripción
Define la secuencia de los bloques de aviso. "Arriba" y "Abajo" desplazan el bloque de aviso
seleccionado en la lista. De esta forma, el bloque de aviso se desplaza hacia arriba o abajo
en el visor de avisos en runtime.
Sintaxis
Object.MessageColumnRepos[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor que establece la secuencia de los bloques de aviso en la lista.
MessageColumnSort (RT Professional)
Descripción
Establece cómo se clasificará en la lista de avisos el bloque de aviso referenciado en
Sintaxis
Object.MessageColumnSort[=SortMode]
Object
● AlarmControl
SortMode
0: ninguna clasificación.
1: clasificación ascendente desde el valor menor hasta el mayor.
2: clasificación descendente desde el valor mayor hasta el menor.

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
MessageColumnVisible (RT Professional)
Descripción
Determina si los bloques de aviso se mostrarán en el visor de avisos.
Sintaxis
Object.MessageColumnVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional.
TRUE: los bloques de aviso se muestran en el visor de avisos.
FALSE: los bloques de aviso no se muestran en el visor de avisos.

MessageListType (RT Professional)
Descripción
Determina de qué lista de avisos se muestran contenidos al abrir una imagen.
Sintaxis
Object.MessageListType[=AlarmListType]
Object
● AlarmControl
AlarmListType

0 Lista de avisos Al abrir una imagen solo se representan los avisos pendientes ac‐
tuales.
1 Lista de ficheros a corto Con una apertura de imagen debe mostrarse una lista de ficheros
plazo a corto plazo con los avisos archivados. Cuando entran nuevos
avisos se actualiza inmediatamente la visualización.
2 Lista de ficheros a largo Con una apertura de imagen debe mostrarse una lista de ficheros
plazo a largo plazo con los avisos archivados.
3 Lista de bloqueo Al abrir una imagen solo se representan solamente los avisos blo‐
queados actuales.
4 Lista de aciertos Al abrir una imagen solo se representan informaciones estadísticas
proyectadas.
5 Lista de los avisos a Al abrir una imagen solo se representan los avisos a ocultar.
ocultar
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
● WindowsSlider

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
MinuteNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la longitud del minutero en el objeto "Clock".
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.
MinuteNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del minutero en el objeto "Clock".

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.
Mode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el tipo de campo del objeto indicado.
Acceso en runtime:
Sintaxis
Object.Mode[=IOFieldType]
Object
● Button
● IOField
● RoundButton
● SymbolicIOField
● DateTimeField
● GraphicIOField
● Switch
IOFieldType
hmiIOFieldInput (1): campo de entrada
hmiIOFieldOutput (0): campo de salida
hmiIOFieldInOutput (2): campo de entrada y salida

Moveable (RT Professional)
Descripción
Determina si la ventana puede moverse en runtime.
Sintaxis
Object.Moveable[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
BOOLEAN
Opcional. TRUE si la ventana puede moverse 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".
Sintaxis
Object.MsgFilterSQL[=STRING]
Object
● AlarmControl

STRING
Opcional. Valor o constante que establece las instrucciones SQL para la selección
personalizada de los avisos.
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
● BatteryView
● Clock
● Ellipse
● Gauge
● Slider
● AlarmControl
● AlarmView
● Bar
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● DateTimeField
● DiscSpaceView
● EllipseSegment
● EllipticalArc

● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● Screenwindow
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject

● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Observaciones
En función del objeto indicado se devuelven los siguientes nombres de objeto:
● Tag: nombre de la variable sin prefijo de servidor y variable.
● Project: nombre del proyecto de runtime actual.
● DataItem: nombre del objeto DataItem.
● Layer: nombre del nivel.
● FunctionTrendControl: nombre de la curva referenciada por 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:
'VBS160
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
NeedleBorderColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de línea de las agujas en el objeto "Clock".

Sintaxis
Object.NeedleBorderColor[=Color]
Object
● Clock
Color
Opcional. Valor o constante que determina el color de línea de la aguja.
Observaciones
constantes de color VBS, tales como vbRed o vbGreen .
NeedleColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de las agujas en el objeto "Clock".
La propiedad "NeedleFillStyle" debe haberse configurado como "Transparent" para que el
color de las agujas se vea.
Sintaxis
Object.NeedleColor[=Color]
Object
● Clock
Color
Opcional. Valor o constante que determina el color de las agujas.
Observaciones

NeedleFillStyle (RT Professional)
Descripción
Determina si los punteros deben mostrarse opacos o transparentes.
Sintaxis
Object.NeedleFillStyle[=THmiFillStyle]
Object
● Clock
THmiFillStyle
hmiFillStyleTransparent (65536): los punteros se rellenan en el color de relleno del puntero y
con el borde en el color del primer plano.
hmiFillStyleSolid (0): los punteros aparecen transparentes y se muestran con un borde en el
color del primer plano.
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
NormalRangeVisible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse el rango normal en la escala del objeto "Gauge".
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".
3.5.5.10 Propiedades O-P (Panels, Comfort Panels, RT Advanced, RT Professional)
Object (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Si se utiliza un Control no provisto por WinCC puede suceder que las propiedades aportadas
por el Control tengan el mismo nombre que las propiedades ScreenItem generales. En estos
casos, las propiedades ScreenItem tienen prioridad. Es posible acceder a las propiedades
"ocultas" de un Controls de terceros mediante la propiedad adicional "object".
Acceso en runtime:

Sintaxis
Object.Object
Object
● AlarmControl
● AlarmView
● RecipeView
● SmartClientView
● StatusForce
● SymbolLibrary
Acceda a las propiedades de un control de terceros de la siguiente forma:
Control.object.type
Si sólo se emplea la forma Control.type se utilizan las propiedades del objeto ScreenItem en
caso de equivalencia de nombres.
ObjectSizeDeclutteringEnable (RT Professional)
Descripción
Indica si sólo se muestran objetos dentro de un rango de tamaño definido.
Sintaxis
Object.ObjectSizeDeclutteringEnable
Object

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

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
OCXState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Online (RT Professional)
Descripción
Determina el inicio y la detención de la actualización.

Sintaxis
Object.Online[=BOOLEAN]
Object
BOOLEAN
Opcional.
TRUE: se detiene la representación actualizada. Los valores se guardan en la memoria
intermedia y se añaden en cuanto vuelve a activarse el botón.
FALSE: se reanuda la representación actualizada.
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
● 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.
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
Int32

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

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
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".
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]
Object
● AlarmControl
Int32
Opcional. Determina un número para el aviso de operador del evento de aviso seleccionado.

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. Activa los eventos de aviso en la lista en la que se habilitarán los avisos de operador.
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í.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. 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" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
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í.

Descripción
Sintaxis
Object
● AlarmControl
STRING
Descripción
Sintaxis
Object
● AlarmControl

STRING
Descripción
Sintaxis
Object
● AlarmControl
STRING
Descripción
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 5" del aviso de operador. Para ello seleccione en Valor
de proceso "5" como bloque de aviso del aviso manejado el "Bloque de textos de usuario 1".
Sintaxis

Object
● AlarmControl
STRING
Descripción
de proceso "6" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Sintaxis
Object
● AlarmControl
STRING
Descripción

Sintaxis
Object
● AlarmControl
STRING
Descripción
Sintaxis
Object
● AlarmControl
STRING
Descripción

Sintaxis
Object
● AlarmControl
STRING
Descripción
Sintaxis
Object
● AlarmControl
STRING

OperatorMessageSourceType1 (RT Professional)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType1[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type

0 texto Se visualizará el contenido del origen en forma de texto.
1 Valor Se visualizará el contenido del origen como valor.
Consulte también
Descripción
Sintaxis
Object
Type

0 Texto Se visualizará el contenido del origen en forma de texto.
Consulte también

Descripción
Sintaxis
Object
Type

Consulte también
Descripción
Sintaxis
Object
Type

Consulte también

Descripción
Sintaxis
Object
Type

Consulte también
Descripción
Sintaxis
Object
Type

Consulte también

Descripción
Sintaxis
Object
Type

Consulte también
Descripción
Sintaxis
Object
Type

Consulte también

Descripción
Sintaxis
Object
Type

Consulte también
Descripción
Sintaxis
Object
Type

Consulte también

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
TRUE: es posible pasar página en la lista de ficheros a largo plazo.
FALSE: no es posible pasar página en la lista de ficheros a largo plazo.
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
Int32
Opcional. Valor o constante que establece el número de avisos por página.

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

PicAlignment (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la alineación dentro del objeto indicado.
Picture (RT Professional)
Descripción
Determina la imagen que se muestra en el objeto gráfico en runtime.
Sintaxis
Object.Picture[=Image]
Object
● GraphicView
● Clock
Image
Opcional. Un valor o una constante que determina la imagen que se muestra en el objeto
gráfico en runtime.
Observaciones
La imagen (*.BMP o *.DIB) debe encontrarse en la carpeta "GraCS" del proyecto actual, para
que pueda ser insertada.
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.
PictureDeactivated (RT Professional)
Descripción
Determina el gráfico que se muestra en el estado "Desactivado".
Sintaxis
Object.PictureDeactivated[=Image]
Object
● Roundbutton
Image
Opcional. Un valor o una constante que determina el gráfico que se mostrará en el estado
"Desactivado".
Observaciones
El gráfico debe encontrarse en la carpeta "GraCS" del proyecto actual para insertarlo.
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".
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.
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 la aguja.
Observaciones
PointsCount (RT Professional)
Descripción
Determina el número de vértices de la polilínea o del polígono.
Sintaxis
Object.PointsCount[=Int32]

Object
● Polygon
● Polyline
● Tubepolyline
● Line
Int32
Opcional. Un valor o una constante que determina el número de vértices de la polilínea.
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).
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.
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.
Sintaxis
Object.ProcessValue[=DOUBLE | Int32 | Object | SINGLE]
Object
● Bar
● Gauge
● GraphicIOField
● IOField
● OptionGroup
● Slider
● SymbolicIOField
● WindowsSlider
● Button
● CheckBox
● DateTimeField
● Switch
● SymbolLibrary


Opcional. Un valor o una constante que contiene el valor predeterminado. El tipo de datos
depende de la apariencia:
● DOUBLE: Bar
● Int32: 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.
Consulte también
3.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 1332)
Radius (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el radio del objeto "Circle" indicado.
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
Determina el eje menor del objeto indicado.
Sintaxis
Object.RadiusHeight[=Int32]
Object
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject
● Circle
Int32
Opcional. Valor o constante que determina el eje menor (en píxeles).
RadiusWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el eje mayor del objeto indicado.
Sintaxis
Object.RadiusWidth[=Int32]
Object
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject


● Circle
Int32
Opcional. Valor o constante que determina el eje mayor (en píxeles).
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.
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.

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
STRING
Opcional. Valor o constante que devuelve el nombre del registro de receta.
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.
RelativeFillLevel (RT Professional)
Descripción
Determina el porcentaje con el que se rellena el objeto.

Sintaxis
Object.RelativeFillLevel[=Int32]
Object
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowsSlider
● CheckBox
Int32
Opcional. Un valor o una constante que determina el porcentaje con el que se rellena el objeto.
Rotation (RT Professional)
Descripción
Determina el ángulo de giro del objeto indicado en grados. El ángulo de giro se mide en sentido
contrario a las agujas del reloj.
Sintaxis
Object.Rotation[=SymbolLibraryRotation]
Object
● SymbolLibrary

SymbolLibraryRotation
hmiSymbolLibraryRotationNone (0): el objeto gira 0 grados.
hmiSymbolLibraryRotation90Degree (90): el objeto gira 90 grados.
RotationAngle (RT Professional)
Descripción
Determina el ángulo de rotación en grados.
Sintaxis
Object.RotationAngle[=Int32]
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.
RotationCenterLeft (RT Professional)
Descripción
Determina la coordenada X del punto de giro alrededor del cual gira el objeto en runtime.
Sintaxis
Object.RotationCenterLeft[=Int32]

Object
● Line
● Polygon
● Polyline
● TextField
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
Determina la coordenada Y del punto de giro alrededor del cual 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.
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
determina si las barras de desplazamiento de filas se deben visualizar.

Sintaxis
Object.RowScrollbar[=ScrollbarVisibility]
Object
● AlarmControl
ScrollbarVisibility

0 no No se visualizan las barras de desplazamiento de filas.
1 en caso necesa‐ Se mostrarán las barras de desplazamiento de filas si la necesidad de
rio espacio del control en el sentido horizontal es superior al área de visuali‐
zación disponible.
2 siempre Se visualizan siempre las barras de desplazamiento de filas.
RowTitleAlignment (RT Professional)
Descripción
Determina cómo se alinearán los títulos de fila.
Los siguientes ajustes son seleccionables:

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.
El atributo puede dinamizarse con el nombre RowTitleAlignment .
Consulte también
RTPersistence (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece cómo se conservarán las configuraciones online de WinCC.

Sintaxis
Object.RTPersistence[=RTPersistence]
Object
● AlarmControl
● SysDiagControl
● UserView
RTPersistence

0 rechazar Las configuraciones online actuales se rechazarán en el próximo cambio
de imagen.
1 mantener Las configuraciones online actuales se conservarán en el próximo cambio
de imagen.
2 restablecer Se perderán todas las modificaciones que hayan sido configuradas online
hasta el momento. La imagen es asignada al contenido existente en el
sistema de configuración.
RTPersistenceType (RT Professional)
Descripción
Establece cómo se conservarán las configuraciones online de WinCC.
Sintaxis
Object.RTPersistenceType[=RTPersistenceType]
Object
● AlarmControl

● SysDiagControl
● UserView
RTPersistenceType

0 no conservar No se conservarán las configuraciones online. Se perde‐
rán después del siguiente cambio de imagen.
1 conservar durante el runtime Las configuraciones online se conservarán durante el run‐
time. Se perderán al finalizar.
2 conservar permanentemente Las configuraciones online se conservarán permanente‐
mente. Estarán disponibles también después del reinicio.
RulerColor (RT Advanced)
Descripción
Define el color de la gradación de la escala (línea auxiliar) en la rotulación del eje del objeto
"OnlineTrendControl".
Sintaxis
Object.RulerColor[=Color]
Object
● TrendView
Color
Opcional. Valor o constante que determina el color de la gradación de la escala.
Observaciones

3.5.5.12 Propiedades S (Panels, Comfort Panels, RT Advanced, RT Professional)
ScaleColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la escala del objeto indicado.
Sintaxis
Object.ScaleColor[=Color]
Object
● TrendView
● Bar
Color
Opcional. Valor o constante que determina el color de la escala.
Observaciones
Objeto "ScreenItem" con la apariencia "Bar": para que se muestre el color, la propiedad
"ShowScale" debe estar configurada con TRUE.
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.
ScaleLabelColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de la 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.
Observaciones
ScaleNumerator (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

ScalePosition (RT Professional)
Descripción
Determina la posición de la escala del objeto indicado. La propiedad "ShowScale" debe estar
fijada en TRUE para que se muestre la escala.
Sintaxis
Object.ScalePosition[=ScalePosition]
Object
● Bar
● Slider
ScalePosition
hmiScalePositionLeftUp (0): para una barra vertical la escala se muestra arriba. Para una
barra horizontal la escala se muestra a la izquierda.
hmiScalePositionRightDown (1): para una barra vertical la escala se muestra abajo. Para una
barra horizontal la escala se muestra a la derecha.
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
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
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.
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.
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.
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.
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".
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
Scaling (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ScalingType (RT Professional)
Descripción
Establece el tipo de escala de barras.
Sintaxis
Object.ScalingType[=BarScalingType]
Object
● Bar
BarScalingType
Opcional. Valor o constante que establece el tipo de escala de barras.
● hmiBarScalingLinear (0): lineal
Las marcas grandes están distribuidas uniformemente por la escala. La distancia entre las
marcas grandes corresponde al valor del atributo "Sección del eje".
● hmiBarScalingLogarithmic (1): 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.

● hmiBarScalingNegativeLogarithmic (2): logarítmico negativo

La distribución de las marcas grandes en la escala responde a una función logarítmica
negativa. Se acentúa considerablemente la representación de los valores altos.
● hmiBarScalingAutomatic (3): automático
Las marcas grandes están distribuidas uniformemente por la escala. La distancia entre las
marcas grandes se establece automáticamente.
● hmiBarScalingTangent (4): tangente
La distribución de las marcas grandes en la escala acentúa la representación de los valores
bajos y altos.
● hmiBarScalingQuadratic (5): 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 valores altos.
● hmiBarScalingCubic (6): 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.
Observaciones
Para que se muestre el color, la propiedad "ShowScale" debe tener el valor TRUE.
Consulte también
Bar (Página 1353)
ScreenItems (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la lista de ScreenItems.
Sintaxis
Object.ScreenItems
Object
Obligatorio. Objeto del tipo "ScreenItems"..
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.
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 la ventana 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 la ventana 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.
Sintaxis
Object.Screens
Object
Obligatorio. Objeto del tipo "Screens".
SecondNeedleHeight (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define la longitud del segundero en el objeto "Clock".
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.
SecondNeedleWidth (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el ancho del segundero en el objeto "Clock".
Sintaxis
Object.SecondNeedleWidth[=Int32]
Object
● Clock
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.
SegmentColoring (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el tipo de cambio de color con el que se visualiza el rebase por exceso de valores límite
en el objeto "Bar".
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.
hmiBarColorEntire (0): el color se cambia en la barra entera.
hmiBarColorSegmented (1): el color se cambia por segmentos.
SelectedText (RT Professional)
Descripción
Muestra el texto que, fijado con el atributo "Campo seleccionado" (SelIndex), aparecerá
resaltado en el Campo de combinación o en el Campo de lista.
Consulte también
SelectBackColor (RT Professional)
Descripción
Determina el color de fondo de la entrada de texto seleccionada del objeto indicado.
Sintaxis
Object.SelectBackColor[=Color]
Object
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de fondo de la entrada de texto
seleccionada del objeto indicado.
Observaciones

SelectedCellColor (RT Professional)
Descripción
Determina el color de fondo de la celda seleccionada. Con el botón se abre el cuadro de
diálogo para la selección de color.
Sintaxis
Object.SelectedCellColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color de fondo.
Observaciones
SelectedCellForeColor (RT Professional)
Descripción
Determina el color de fuente de la celda seleccionada. Con el botón se abre el cuadro de
diálogo para la selección de color.
Sintaxis
Object.SelectedCellForeColor[=Color]

Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color de fuente.
Observaciones
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.
Sintaxis
Object.SelectedIndex[=Int32]
Object
● ComboBox
● ListBox
Int32
Opcional. Valor o constante que determina el índice del texto resaltado.

SelectedRowColor (RT Professional)
Descripción
Determina el color de fondo de la fila seleccionada. Con el botón se abre el cuadro de diálogo
para la selección de color.
Sintaxis
Object.SelectedRowColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color de fondo.
Observaciones
SelectedRowForeColor (RT Professional)
Descripción
Determina el color de fuente de la fila seleccionada. Con el botón se abre el cuadro de diálogo
para la selección de color.
Sintaxis
Object.SelectedRowForeColor[=Color]

Object
● AlarmControl
Color
Observaciones
SelectedTitleColor (RT Professional)
Descripción
Determina el color de fondo del título de tabla seleccionado. Con el botón se abre el cuadro
de diálogo para la selección de color.
La configuración solamente será efectiva en runtime si la opción "Color de selección" está
activa.
Sintaxis
Object.SelectedTitleColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el fondo.

Observaciones
SelectedTitleForeColor (RT Professional)
Descripción
Determina el color de fuente del título de tabla seleccionado. Con el botón se abre el cuadro
de diálogo para la selección de color.
La configuración solamente será efectiva en runtime si la opción "Color de selección" está
activa.
Sintaxis
Object.SelectedTitleForeColor[=Color]
Object
● AlarmControl
Color
Observaciones
Consulte también


SelectForeColor (RT Professional)
Descripción
Determina el color de la entrada de texto seleccionada del objeto indicado.
Sintaxis
Object.SelectForeColor[=Color]
Object
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de la entrada de texto seleccionada
Observaciones
SelectionBackColor (RT Advanced)
Descripción
Determina el color de fondo de las celdas seleccionadas.
Sintaxis
Object.SelectionBackColor[=Color]

Object
● AlarmView
● RecipeView
● StatusForce
● UserView
● TrendView
Color
Opcional. Valor o constante que determina el color de fondo de la fila seleccionada.
Observaciones
SelectionColoring (RT Professional)
Descripción
Determina si el color de selección se utilizarán para celdas o filas.
Sintaxis
Object.SelectionColoring[=GridSelectionColoring]
Object
● AlarmControl
GridSelectionColoring

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.
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
SelectionRect (RT Professional)
Descripción
Determina si se utilizará un borde selección para las celdas o filas seleccionadas.

Sintaxis
Object.SelectionRect[=GridSelectionBorder]
Object
● AlarmControl
GridSelectionBorder

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.
SelectionRectColor (RT Professional)
Descripción
Define el color del rectángulo de selección en la ventana de avisos cuando SelectionType es
"1".
Sintaxis
Object.SelectionRectColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que establece el color.

Observaciones
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]
Object
● AlarmControl
Int32
Opcional. Valor o constante que establece el grosor de la línea.
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.
Están disponibles los siguientes ajustes:

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.
SeparatorBackColor (RT Professional)
Descripción
Determina el color de fondo de las líneas de separación quebradas en la lista de selección
Sintaxis
Object.SeparatorBackColor[=Color]
Object
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de fondo de las líneas de separación
quebradas en la lista de selección del objeto indicado.
Observaciones

SeparatorColor (RT Professional)
Descripción
Determina el color de las líneas de separación en la lista de selección del objeto indicado.
Sintaxis
Object.SeparatorColor[=Color]
Object
● SymbolicIOField
● S7GraphOverview
Color
Opcional. Un valor o una constante que determina el color de las líneas de separación en la
lista de selección del objeto indicado.
Observaciones
SeparatorCornerStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
SeparatorStyle (RT Professional)
Descripción
Establece el tipo de las líneas de separación en la lista de selección del objeto indicado.

Sintaxis
Object.SeparatorStyle[=LineStyle]
Object
● SymbolicIOField
LineStyle
hmiLineStyleNone (-1): la lista de selección no tiene líneas de separación.
hmiLineStyleSolid (0): la lista de selección tiene líneas de separación continuas.
hmiLineStyleDash (1): la lista de selección tiene líneas de separación discontinuas.
hmiLineStyleDot (2): la lista de selección tiene líneas de separación de puntos.
hmiLineStyleDashDot (3): la lista de selección tiene líneas de separación punto raya.
hmiLineStyleDashDotDot (4): la lista de selección tiene líneas de separación punto punto raya.
SeparatorWidth (RT Professional)
Descripción
Determina el ancho de las líneas de separación en la lista de selección del objeto indicado.
Sintaxis
Object.SeparatorWidth[=Int32]
Object
● SymbolicIOField
Int32
Opcional. Un valor o una constante que determina el ancho de las líneas de separación en la
lista de selección del objeto indicado.
SeparatorLineEndShapeStyle (RT Professional)
Descripción
Define la forma de los finales de línea para el objeto del tipo "ScreenItem" con la especificación
"SymbolicIOField".

Consulte también
ServerScale (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
ServerNames (RT Professional)
Descripción
Establece los servidores de un sistema distribuido de los que recibe datos el visor de avisos.
Se indica de esta forma: NameServer1;NameServer2;NameServer3.
Sintaxis
Object.ServerNames[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que establece los servidores de un sistema distribuido de los que
recibe datos la ventana de avisos.
ServerPrefix (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Shared (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

ShiftDecimalPoint (RT Professional)
Descripción
Determina que el campo "Desplazar punto decimal" sea de sólo lectura.
Sintaxis
Object.ShiftDecimalPoint[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si el campo "Desplazar punto decimal" es de sólo lectura.
Consulte también
ShowAlarmsFromDate (RT Advanced)
Descripción
Establece que solo se muestren los eventos de aviso que estén guardados en esa variable.
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.

ShowBadTagState (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto debe mostrarse atenuado cuando el QualityCode o el estado de la
variable no sea bueno.
Sintaxis
Object.ShowBadTagState[=BOOLEAN]
Object
● Bar
● IOField
● OptionGroup
● SymbolicIOField
● WindowsSlider
● CheckBox
BOOLEAN
TRUE Con un QualityCode o un estado de variable malo, el objeto se mostrará ate‐

nuado o bien se utilizarán los ajustes correspondientes al color de cuadrícula.
FALSE Con un QualityCode o un estado de variable malo, el objeto no se mostrará
atenuado o bien no se utilizarán los ajustes correspondientes al color de cuadrí‐
cula.
ShowBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el valor de proceso visualizado en el objeto "Slider" se muestra adicionalmente
con una barra llena.
Sintaxis
Object.ShowBar[=BOOLEAN]

Object
● Slider
BOOLEAN
Opcional. TRUE si el valor de proceso debe mostrarse adicionalmente con una barra llena.
ShowCaption (RT Professional)
Descripción
Determina si la barra de título se muestra u oculta.
Sintaxis
Object.ShowCaption[=BOOLEAN]
Object
● Screenwindow
● Switch
BOOLEAN
Opcional. TRUE si la barra de título se muestra.
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.
ShowFillLevel (RT Professional)
Descripción
Determina si el objeto indicado se rellena.
Sintaxis
Object.ShowFillLevel[=BOOLEAN]
Object
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowsSlider
● CheckBox
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]
Object
● Clock
BOOLEAN
Opcional. TRUE si en runtime el botón recibe un borde de selección cuando se activa.
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
BOOLEAN
Opcional. TRUE si se representan solo las marcas grandes de la escala.
ShowLimitMarkers (RT Professional)
Descripción
Determina si los valores límite se muestran como valor de escala.
Sintaxis
Object.ShowLimitMarkers[=BOOLEAN]
Object
● Bar


● Slider
BOOLEAN
Opcional. TRUE si los valores límite se muestran como valor de escala.
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.
Sintaxis
Object.ShowPeakValuePointer[=BOOLEAN]
Object
● Gauge
BOOLEAN
Opcional. TRUE si se utiliza la aguja de máximo/mínimo.
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.
RowTitles (RT Professional)
Descripción
Determina si el visor de avisos contiene una columna con una numeración correlativa de los
avisos pendientes.
Sintaxis
Object.RowTitles[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el visor de avisos contiene una columna con una numeración correlativa
de los avisos pendientes.
Consulte tambié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 "OnlineTrendControl".
Sintaxis
Object.ShowRuler[=BOOLEAN]
Object
● TrendView

BOOLEAN
Opcional. TRUE si se muestra la escala graduada.
ShowRulerInAxis (RT Professional)
Descripción
Determina si la regla se mostrará también en el eje de tiempos.
Sintaxis
Object.ShowRulerInAxis[=BOOLEAN]
Object
BOOLEAN
TRUE: las reglas se mostrarán también en los ejes de tiempo.
FALSE: las reglas no se mostrarán en los ejes de tiempo.
ShowScale (RT Professional)
Descripción
Determina si los valores se muestran adicionalmente en una escala.
Sintaxis
Object.ShowScale[=BOOLEAN]
Object
● Bar
● Slider
BOOLEAN
Opcional. TRUE si los valores se muestran adicionalmente en una escala.

ShowScrollbars (RT Professional)
Descripción
Determina si se deben visualizar las barras de desplazamiento.
Sintaxis
Object.ShowScrollbars[=BOOLEAN]
Object
● Screenwindow
ShowScrollbars
Opcional. TRUE si se muestran barras de desplazamiento.
ShowSortButton (RT Professional)
Descripción
Determina 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.
Sintaxis
Object.ShowSortButton[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: la tecla de clasificación se muestra. Puede clasificar la columna seleccionada.

FALSE: la tecla de clasificación no se muestra.
ShowSortIcon (RT Professional)
Descripción
Determina si se debe mostrar el símbolo de clasificación.
Sintaxis
Object.ShowSortIcon[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el símbolo de clasificación se muestra.
FALSE: el símbolo de clasificación no se muestra.
ShowSortIndex (RT Professional)
Descripción
Determina si se mostrará un índice de clasificación.
Sintaxis
Object.ShowSortIndex[=BOOLEAN]
Object
● AlarmControl

BOOLEAN
TRUE: se mostrará un índice de clasificación.
FALSE: no se mostrará un índice de clasificación.
ShowStatusBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se muestra la barra de estado.
Sintaxis
Object.ShowStatusBar[=BOOLEAN]
Object
● HTML-Browser
● MediaPlayer
BOOLEAN
Opcional. TRUE si se muestra la barra de estado.
ShowTableGridlines (RT Advanced)
Descripción
Determina si en la tabla del objeto indicado se deben mostrar líneas de retícula.
Sintaxis
Object.ShowTableGridlines[=BOOLEAN]
Object
● StatusForce
● TrendView
● UserView

BOOLEAN
Opcional. 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".
Sintaxis
Object.ShowThumb[=BOOLEAN]
Object
● Slider
BOOLEAN
Opcional. TRUE si debe mostrarse el deslizador.
ShowTickLabels (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si debe mostrarse la rotulación en la escala.
Sintaxis
Object.ShowTickLabels[= BOOLEAN]
Object
● Slider
● Bar
BOOLEAN
Opcional. TRUE si debe mostrarse 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.
ShowTicks (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si deben mostrarse las marcas en la escala del objeto indicado.
Sintaxis
Object.ShowTicks[=BOOLEAN]
Object
● Clock
● Slider
BOOLEAN
Opcional. TRUE si deben mostrarse las marcas.
ShowTitle (RT Professional)
Descripción
Determina el título de la ventana del control.
Sintaxis
Object.ShowTitle[=WindowHeaderStyle]
Object
● AlarmControl

WindowHeaderStyle
Valor Designación Explicación

0 no Sin título de ventana.
1 normal El título de ventana está compuesto de un icono WinCC y texto. El texto se
introduce en el campo "Texto".
2 Diseño estre‐ Los títulos de ventana está compuesto solo de texto. El texto se introduce en
cho el campo "Texto".
ShowToolBar (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se muestra una barra de herramientas.
Sintaxis
Object.ShowToolBar[=BOOLEAN]
Object
● HTMLBrowser
BOOLEAN
Opcional. TRUE si se muestra una barra de herramientas.
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]
Object

BOOLEAN
TRUE: el símbolo se muestra.
FALSE: el símbolo no se muestra.
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.
Sizeable (RT Professional)
Descripción
TRUE si en Runtime se puede modificar el tamaño del objeto. Acceso de escritura y lectura
BOOLEAN.
En una ventana de aplicación y en una ventana de imagen: Sólo acceso de lectura.
Consulte también

ControlDesignMode (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
En este campo de selección se define el estilo del control.
Sintaxis
Object.ControlDesignMode[=RTControlModes]
Object
Necesario. Objeto del tipo "ScreenItem" con las apariencias "MessageView",
"OnlineTableControl", "OnlineTrendControl", "FunctionTrendControl", "RecipeView",
"RulerControl".
RTControlModes
Los siguientes ajustes están a disposición:
Valor Designación Explicación

Configuración del proyecto El estilo se corresponde a la configuración de proyecto de
WinCC Explorer.
0 Sencilla Estilo WinCC "Clásico"
1 Predeterminada Nuevo estilo WinCC V7
SmartTags (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve la lista de SmartTags.
Sintaxis
Object.SmartTags
Object
SortByTimeDirection (RT Advanced)
Descripción
Determina si el último aviso entrante se muestra arriba en el objeto "AlarmControl" (orden de
clasificación ascendente).

Sintaxis
Object.SortByTimeDirection[=SortByTimeDirection]
Object
Obligatorio. Objeto del tipo "ScreenItems" con la apariencia siguiente:
● AlarmView
SortByTimeDirection
Opcional. TRUE si el último aviso entrante se muestra arriba.
SortByTimeEnabled (RT Advanced)
Descripción
Determina si puede modificarse la clasificación de los avisos por hora en el objeto
"AlarmView".
Sintaxis
Object.SortByTimeEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItems" con la apariencia siguiente:
● AlarmView
BOOLEAN
Opcional. TRUE si el operador puede modificar la clasificación en el equipo.
SortSequence (RT Professional)
Descripción
Determina cómo se deben puede modificar la secuencia de clasificación mediante haciendo
clic con el ratón.
Sintaxis
Object.SortSequence[=GridSortSequence]

Object
● AlarmControl
● UserArchiveConrol
GridSortSequence

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.
StartAngle (RT Professional)
Descripción
Determina el ángulo por el cual el punto inicial del objeto indicado se desvía de la posición
cero (0º).
Sintaxis
Object.StartAngle[=Int32]
Object
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Opcional. Un valor o una constante que determina el ángulo por el cual el punto inicial del
objeto indicado se desvía de la posición cero (0º).

StartStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina cómo se debe representar el comienzo de línea del objeto indicado.
Sintaxis
Object.StartStyle[=LineEndStyle]
Object
● Line
● Polyline
LineEndStyle
Opcional. Valor o constante que determina el comienzo de línea. Rango de valores de 0 a 6.
hmiLineEndStyleNone (0): la línea no tiene ningún símbolo inicial.
hmiLineEndStyleArrow (1): la línea comienza con una punta de flecha.
hmiLineEndStyleFilledArrow (2): la línea comienza con una punta de flecha rellena.
hmiLineEndStyleFilledArrowReversed (3): la línea comienza con una punta de flecha invertida.
hmiLineEndStyleLine (4): la línea comienza con una línea vertical.
hmiLineEndStyleCircle (5): la línea comienza con un círculo.
hmiLineEndStyleFilledCircle (6): la línea comienza con un círculo rellenado.
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.
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
StatusbarBackColor (RT Professional)
Descripción
Determina el color de fondo de la barra de estado. Con el botón se abre el cuadro de diálogo
para la selección de color. Para que el ajuste tenga efecto debe activar la opción "Visualizar".
Sintaxis
Object.StatusbarBackColor[=Color]
Object
● AlarmControl

Color
Opcional. Valor o constante que determina el color de fondo de la barra de estado.
Observaciones
StatusbarElementAdd (RT Professional)
Descripción
Crea un nuevo elemento de la barra de estado definida por el usuario. El nombre asignado
por WinCC se puede modificar en el campo "Nombre de objeto".
Sintaxis
Object.StatusbarElementAdd[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que determina un nuevo elemento definido por el usuario de la
barra de estado.
StatusbarElementAutoSize (RT Professional)
Descripción
Establece si el ancho de los elementos seleccionados de la barra se ajustará
automáticamente.

Sintaxis
Object.StatusbarElementAutoSize[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: el ancho del elemento seleccionado se ajustará automáticamente.
FALSE: el ancho del elemento seleccionado no se ajustará automáticamente.
Consulte también
StatusbarElementCount (RT Professional)
Descripción
Determina el número de elementos configurables de la barra de estado.
Sintaxis
Object.StatusbarElementCount[=Int32]
Object
● AlarmControl

Int32
Opcional. Valor o constante que determina el número de elementos configurables de la barra
de estado.
StatusbarElementIconId (RT Professional)
Descripción
Define la asignación del número de identidad y del símbolo de un elemento de la barra de
estado.
Sintaxis
Object.StatusbarElementIconId[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define la asignación del número de identidad y del símbolo
de un elemento de la barra de estado.
StatusbarElementID (RT Professional)
Descripción
Define el número de identidad para el elemento seleccionado de la barra de estado.

Sintaxis
Object.StatusbarElementID[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de identidad del elemento seleccionado de
la barra de estado.
StatusbarElementIndex (RT Professional)
Descripción
Define la referencia de un elemento de la barra de estado.
Los valores válidos para "StatusbarElementIndex" se encuentran entre 0 y
"StatusbarElementCount" menos 1.
Sintaxis
Object.StatusbarElementIndex[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define la referencia de un elemento de la barra de estado.

StatusbarElementName (RT Professional)
Descripción
Define el nombre de objeto para el elemento seleccionado de la barra de estado.
Se puede modificar el nombre de objeto para elementos definidos por el usuario de la barra
de estado. La propiedad "StatusbarElementName" para elementos definidos por el usuario
se puede dinamizar con la propiedad "StatusbarElementRename".
Sintaxis
Object.StatusbarElementName[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre de objeto del elemento seleccionado de la
barra de estado.
StatusbarElementRemove (RT Professional)
Descripción
Elimina el elemento definido por el usuario seleccionado en la barra de estado.
Sintaxis
Object.StatusbarElementRemove[=STRING]
Object
● AlarmControl

STRING
Opcional. Valor o constante que define el nombre del elemento definido por el usuario que se
eliminará de la barra de estado.
StatusbarElementRename (RT Professional)
Descripción
Modifica el nombre del elemento definido por el usuario de la barra de estado que está
referenciado mediante la propiedad "StatusbarElementIndex".
Para elementos definidos por el usuario, la propiedad se puede dinamizar con el nombre
"StatusbarElementRename". Con "StatusbarElementRename" podrá dinamizar también la
propiedad "StatusbarElementName".
Sintaxis
Object.StatusbarElementRename[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nuevo nombre de objeto del elemento seleccionado
StatusbarElements (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina los elementos que deben representarse en la barra de estado.

StatusbarElementTooltipText (RT Professional)
Descripción
Determina el texto para el tooltip del elemento definido por el usuario seleccionado en la barra
de estado.
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.
StatusbarElementUserDefined (RT Professional)
Descripción
Determina si el elemento de la barra de estado ha sido agregado por el ingeniero como nuevo
elemento definido por el usuario.
Sintaxis
Object.StatusbarElementUserDefined[=BOOLEAN]

Object
● AlarmControl
BOOLEAN
TRUE: el elemento de la barra de estado ha sido definido por el usuario.
FALSE: el elemento de la barra de estado está predefinido por el sistema.
StatusbarElementVisible (RT Professional)
Descripción
Determina si el elemento definido por el usuario seleccionado en la barra de estado se
mostrará en runtime.
En la lista, active los elementos de la barra de estado que desee mostrar en runtime.
Haga clic sobre una entrada de la lista para adaptar las propiedades o para modificar la
posición en la fila de estado de Control con las teclas "Arriba" y "Abajo".
Sintaxis
Object.StatusbarElementVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se muestra el elemento definido por el usuario seleccionado en la barra de estado.
FALSE: no se muestra el elemento definido por el usuario seleccionado en la barra de estado.

StatusbarElementWidth (RT Professional)
Descripción
Indica el ancho en píxeles del elemento definido por el usuario seleccionado en la barra de
estado.
Si la opción "Automático" no está activada, podrá ajustar el ancho.
Sintaxis
Object.StatusbarElementWidth[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina el ancho en píxeles del elemento definido por el
usuario seleccionado en la barra de estado.
StatusbarFontColor (RT Professional)
Descripción
Define el color de fuente de los textos de la barra de estado.
Sintaxis
Object.StatusbarFontColor[=Color]
Object
● AlarmControl

Color
Opcional. Valor o constante que define el color de los textos de la barra de estado.
Observaciones
StatusbarShowTooltips (RT Professional)
Descripción
Determina si en runtime se mostrarán los tooltips de los elementos de la barra de estado.
Sintaxis
Object.StatusbarShowTooltips[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se mostrarán los tooltips.
FALSE: no se mostrarán los tooltips.

StatusbarText (RT Professional)
Descripción
Define el texto estándar de la barra de estado.
Sintaxis
Object.StatusbarText[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el texto estándar de la barra de estado.
StatusbarUseBackColor (RT Professional)
Descripción
Determina si se debe visualizar el color de fondo de la barra de estado.
Sintaxis
Object.StatusbarUseBackColor[=BOOLEAN]
Object
● AlarmControl

BOOLEAN
TRUE: se mostrará el color de fondo de la barra de estado.
FALSE: no se mostrará el color de fondo de la barra de estado.
StatusbarVisible (RT Professional)
Descripción
Determina si se debe visualizar la barra de estado del control.
Sintaxis
Object.StatusbarVisible[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se mostrará la barra de estado.
FALSE: no se mostrará la barra de estado.
Style (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el estilo de línea del objeto indicado.
Sintaxis
Object.Style[=LineStyle]

Object
● CircularArc
● EllipticalArc
● Line
● Polyline
LineStyle
Opcional. Un valor o una constante que determina el estilo de línea. Rango de valores de 0
a 4.
hmiLineStyleSolid (0): línea continua
hmiLineStyleDash (1): línea rayada
hmiLineStyleDot (2): línea punteada
hmiLineStyleDashDot (3): línea punto raya
hmiLineStyleDashDotDot (4): línea punto punto raya
Ajuste estándar: hmiLineStyleSolid
StyleSettings (RT Professional)
Descripción
Determina el estilo con el que se representa el objeto.
Sintaxis
Object.StyleSettings[=WinCCStyle]
Object
● Button
● RoundButton
● WindowsSlider
WinCCStyle
Opcional. Valor o constante que determina el estilo con el que se representa el objeto.
Personalizado Representa el objeto según los ajustes propios.

Global Representa el objeto en el diseño ajustado globalmente.
Estilo Windows Presenta el objeto en estilo Windows.

SwapFirstWithLastConnection (RT Professional)
Descripción
Determina si el texto del objeto se representa en posición horizontal.
Sintaxis
Object.SwapFirstWithLastConnection[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "Connector".
BOOLEAN
Opcional. TRUE si el texto del objeto se representa en posición horizontal.
Consulte también
3.5.5.13 Propiedades T (Panels, Comfort Panels, RT Advanced, RT Professional)
TableBackColor (RT Advanced)
Descripción
Determina el color de fondo de las celdas de la tabla del objeto indicado.
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
TableColor (RT Professional)
Descripción
Determina el color de fondo de las filas.
Con el botón se abre el cuadro de diálogo para la selección de color.
Sintaxis
Object.TableColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de fondo de las filas de la tabla.
Observaciones

TableColor2 (RT Professional)
Descripción
Determina el segundo color de fondo de las filas.
La configuración solamente será efectiva en runtime, si la opción "Color de fila 2" está activa.
Para el fondo de las filas se utilizarán alternativamente el "Color de fila 1" y el "Color de fila
2".
Sintaxis
Object.TableColor2[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el segundo color de fondo de las filas de la tabla.
Observaciones
TableForeColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color del texto en las celdas de tabla del objeto indicado.
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
TableForeColor2 (RT Professional)
Descripción
Determina el segundo color de fuente.
La configuración solamente será efectiva en runtime, si la opción "Color de fila 2" está activa.
Como color de fuente se utilizarán alternativamente el "Color de fila 1" y el "Color de fila 2".
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
TableGridLineColor (RT Advanced)
Descripción
Determina el color de las líneas de retícula en la tabla del objeto indicado.
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

TableHeaderBackColor (RT Advanced)
Descripción
Define el color de fondo del encabezado de la tabla del objeto indicado.
Sintaxis
Object.TableHeaderBackColor[=Color]
Object
● AlarmView
● RecipeView
● StatusForce
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de fondo del encabezado.
Observaciones
TableHeaderForeColor (RT Advanced)
Descripción
Define el color de texto del encabezado de la tabla del objeto indicado.
Sintaxis
Object.TableHeaderForeColor[=Color]

Object
● AlarmView
● RecipeView
● StatusForce
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de texto del encabezado.
Observaciones
TagPrefix (RT Professional)
Descripción
Define un prefijo que se antepondrá a todas las variables que se utilicen en la imagen.
Para cada ventana de imagen puede asignarse un prefijo de variable que se antepondrá a
todas las variables que se utilicen en la 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 un cambio de imagen esto sucede automáticamente; en los demás casos,
cuando se asigne nuevamente el nombre de imagen.
El prefijo se puede definir libremente, pero debe coincidir con el nombre de las variables de
estructura.
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.
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 estructura seguido de punto. Si se
introduce, p. ej., "Struct2." como prefijo de variable (el punto es necesario para acceder con
la sintaxis correcta a los elementos de las variables de estructura como elementos de
estructura), los campos E/S de la imagen "EntradaSalida" se vinculan con los elementos de
las variables de estructura 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
Por tanto, el enlace de variables actual en la ventana de imagen es
● 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
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
Consulte también
Template (RT Professional)
Descripción
Define la plantilla para la visualización del contenido de la ventana del objeto "Ventana de la
aplicación".
Sintaxis
Object.Template[=TemplateType]
Object
TemplateType
Opcional. Valor o constante que define la plantilla.
De acuerdo al valor de la propiedad se pueden usar los siguientes modelos:
Contenido de ventana = Global Script

● "Diagnóstico de GSC"
La ventana de aplicación se abastece de las aplicaciones del Global Script. Se representan
los resultados del sistema de diagnóstico.
● "Runtime de GSC"
La ventana de aplicación se abastece de las aplicaciones del Global Script. Se representan
los resultados de análisis del comportamiento en Runtime.

Contenido de ventana = Print Jobs

● "All Jobs":
La ventana de aplicación es abastecida por el sistema de informes. Los informes
disponibles se representan como lista.
● "All Jobs - Context Menu":
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":
disponibles se representan en un menú de selección. Para el informe seleccionado se
visualizan informaciones más detalladas.
● "Selected Jobs - Context Menu":
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.
Text (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina la rotulación del campo de texto.
Sintaxis
Object.Text[=STRING]
Object
● TextField
● CheckBox
● ComboBox
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
STRING
Opcional. Un valor o una constante que determina la rotulación.

TextList (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve un listado que contiene las asignaciones entre el valor de salida y el texto de salida
que realmente se mostrará.
Las asignaciones dependen del tipo de lista ajustado. El tipo de lista se define con la propiedad
"ListType".
Acceso en runtime:
● RT Professional: lectura
Sintaxis
Object.TextList[=HmiObjectHandle]
Object
● SymbolicIOField
● Button
HmiObjectHandle
Listado que contiene las asignaciones entre el valor de salida y el texto de salida que realmente
será mostrado.
TextOff (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el texto que se muestra en el estado "Off" del objeto indicado.
Sintaxis
Object.TextOff[=STRING]
Object
● Button
● Switch


● SymbolicIOField
STRING
Opcional. Un valor o una constante que determina la rotulación del estado "Off".
Observaciones
La propiedad solo está disponible cuando el objeto referenciado "SymbolicIOField", "Button"
o "Switch" es del tipo "Text".
TextOn (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el texto que se muestra en el estado "On" del objeto indicado.
Sintaxis
Object.TextOn[=STRING]
Object
● Switch
● Button
● SymbolicIOField
STRING
Opcional. Un valor o una constante que determina la rotulación para el estado "On".
Observaciones
La propiedad solo está disponible cuando el objeto referenciado "SymbolicIOField", "Button"
o "Switch" es del tipo "Text".
TextOrientation (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece la dirección del texto del objeto indicado.

Acceso en runtime:
Sintaxis
Object.TextOrientation[=TextOrientation]
Object
● Button
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
● CheckBox
● DateTimeField
● Switch
TextOrientation
hmiTextHorizontal (0): el texto se muestra horizontalmente.
hmiTextRotated90Degree (-1): el texto se muestra verticalmente y alineado a la izquierda.
hmiTextRotated270Degree (1): el texto se muestra verticalmente y alineado a la derecha.
ThumbBackColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el color de fondo del regulador en el objeto "Slider".
Sintaxis
Object.ThumbBackColor[=Color]

Object
● Slider
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color de fondo del regulador.
Observaciones
TicksColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de las marcas horarias en la esfera del objeto "Clock".
Sintaxis
Object.TicksColor[=Color]
Object
● Clock
Color
Opcional. Valor o constante que determina el color de las marcas horarias.
Observaciones

TickStyle (RT Professional)
Descripción
Determina la representación de la escala.
Sintaxis
Object.TickStyle[=SliderTickStyle]
Object
● Slider
● Clock
SliderTickStyle
hmiSliderTickStyleNone (0): el objeto no tiene escala.
hmiSliderTickStyleEffect1 (1): la escala está formada únicamente por graduaciones
principales. La escala es negra sobre fondo blanco.
hmiSliderTickStyleEffect2 (2): la escala está formada únicamente por graduaciones
principales. La escala es blanca sobre fondo negro.
hmiSliderTickStyleNormal (3): la escala está formada por graduaciones sencillas.
Observaciones
Debido a la escala automática es posible que en algunos puntos haya dos marcas de la escala
que se encuentren directamente una junto a la otra (parece una marca más ancha). Este
efecto se corrige alargando o acortando ligeramente el objeto deslizante.
Además también es posible suprimir completamente la representación de la escala
("WithAxes").
TimeAxisBeginTime(i) (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el punto de inicio de la representación de la curva indicada. El dato se evaluará o no
dependiendo de las propiedades "UseTimeRange(i)" y "ShareTimeAxis".
Sintaxis
Object.TimeAxisBeginTime(i)[=DateTime]

Object
● TrendView
DateTime
Opcional. Valor o constante que determina el punto de inicio de la representación de la curva
indicada
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.
TimeAxisLabel(i) (RT Professional)
Descripción
Determina la denominación del eje de tiempo. El dato se evaluará o no dependiendo de la
propiedad "ConfigureTimeAxis(i)".
Sintaxis
Object.TimeAxisLabel(i)[=STRING]

Object
STRING
Opcional. Un valor o una constante que determina la denominación del eje de tiempo.
Observaciones
El parámetro i indica el número de la curva.
TimeAxisRange (RT Advanced)
Descripción
TimeAxisTimeFormat(i) (RT Professional)
Descripción
Define el formato de datos a lo largo del eje de tiempos de la curva especificada.
Sintaxis
Object.TimeAxisTimeFormat(i)[=STRING]
Object
STRING
Opcional. Valor o constante que establece el formato del eje de tiempo.
Observaciones

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
hmiTimeBaseLocalTimezone (0): hora local
hmiTimeBaseServerTimezone (1): zona horaria del servidor
hmiTimeBaseUTC (2): UTC (Universal Time Coordinated)
hmiTimeBaseProjectSetting (3): configuración del proyecto
Observaciones
El modo horario puede definirse específicamente para cada ordenador mediante WinCC
Explorer en la página de propiedades del equipo.
TimeColumnActualize (RT Professional)
Descripción
Determina si se actualizarán los valores de la columna seleccionada.
Sintaxis
Object.TimeColumnActualize[=BOOLEAN]

Object
BOOLEAN
TRUE: se actualiza la columna de tiempo.
FALSE: no se actualiza la columna de tiempo. Este ajuste procede si se compara una tabla
con otra.
TimeColumnAdd (RT Professional)
Descripción
Crea una nueva columna de tiempo.
Sintaxis
Object.TimeColumnAdd[=STRING]
Object
STRING
Opcional. Valor o constante que define una columna de tiempo nueva.
TimeColumnAlignment (RT Professional)
Descripción
Determina cómo se alineará la columna de tiempo seleccionada.
Sintaxis
Object.TimeColumnAlignment [=HorizontalAlignment]
Object

HorizontalAlignment

0 izquierda La columna de tiempos seleccionada se mostrará a la izquierda.
1 centrado La columna de tiempos se mostrará centrada.
2 derecha La columna de tiempos se mostrará a la derecha.
Consulte también
TimeColumnAlignment(i) (RT Professional)
Descripción
Define la alineación de la columna de tiempo de un par de columnas i. El parámetro i indica
el número del par de columnas.
Sintaxis
Object.TimeColumnAlignment(i)[=AlignmentHorizontal]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "TableView".
AlignmentHorizontal
hmiAlignmentLeft ( 0): el texto se alinea a la izquierda.
hmiAlignmentCentered ( 1): el texto se centra.
hmiAlignmentRight ( 2): el texto se alinea a la derecha.
Consulte también
TimeColumnBackColor (RT Professional)
Descripción
Determina el color de fondo de la columna de tiempo seleccionada.

El ajuste es efectivo:
● Si la opción "en los colores de la columna de valores" no está activada.
● Si está activada la opción "Color de fuente" en la ficha "General" en el área de "Utilizar
color de columna".
Sintaxis
Object.TimeColumnBackColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de fondo de la columna de tiempo
seleccionada.
Observaciones
TimeColumnBeginTime (RT Professional)
Descripción
Establece el instante de inicio del intervalo de tiempo para la columna de tiempo seleccionada.
Sintaxis
Object.TimeColumnBeginTime[=DateTime]
Object
DateTime
Opcional. Valor o constante que establece el punto de inicio para la columna de tiempo
seleccionada.

TimeColumnCaption (RT Professional)
Descripción
Define la denominación de la columna de tiempos seleccionada.
Sintaxis
Object.TimeColumnCaption[=STRING]
Object
STRING
Opcional. Valor o constante que determina la denominación de la columna de tiempo.
TimeColumnCount (RT Professional)
Descripción
Determina el número de columnas de tiempo configuradas.
Sintaxis
Object.TimeColumnCount[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de columnas de tiempo configuradas.
TimeColumnDateFormat (RT Professional)
Descripción
Determina qué formato de fecha se utilizará para la visualización de la columna de tiempo
seleccionada.

Sintaxis
Object.TimeColumnDateFormat[=STRING]
Object
STRING
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
Establece el instante final del intervalo de tiempo para la columna de tiempo seleccionada.
Sintaxis
Object.TimeColumnBeginTime[=DateTime]
Object
DateTime
Opcional. Valor o constante que determina el instante final.
TimeColumnForeColor (RT Professional)
Descripción
Determina el color de fuente de la columna de tiempo seleccionada.
El ajuste es efectivo:
● Si la opción "en colores de la columna de valores" no está activada.
● Si está activada la opción "Color de fuente" en la ficha "General" en el área de "Utilizar
color de columna".

Sintaxis
Object.TimeColumnForeColor[=Color]
Object
OnlineTableControl
Color
Opcional. Valor o constante que determina el color de fuente de la columna de tiempo
seleccionada.
Observaciones
TimeColumnHideText (RT Professional)
Descripción
Determina si el contenido de la columna de tiempo se mostrará en forma de texto.
Sintaxis
Object.TimeColumnHideText[=BOOLEAN]
Object
BOOLEAN
TRUE: el contenido no se muestra en forma de texto.
FALSE: el contenido se muestra en forma de texto.

TimeColumnHideTitleText (RT Professional)
Descripción
Determina si el título de la columna de tiempo se mostrará en forma de texto.
Sintaxis
Object.TimeColumnHideTitleText[=BOOLEAN]
Object
BOOLEAN
TRUE: el título no se mostrará en forma de texto.
FALSE: el título se mostrará en forma de texto.
TimeColumnIndex (RT Professional)
Descripción
Hace referencia a una columna de tiempo configurada. Esta propiedad permite asignar los
valores de otras propiedades a una determinada columna de tiempo.
Los valores válidos para "TimeColumnIndex" se encuentran entre 0 y "TimeColumnCount"
menos 1. La propiedad "TimeColumnCount" indica el número de columnas de tiempos
configuradas.
Sintaxis
Object.TimeColumnIndex[=Int32]
Object
Int32
Opcional. Valor o constante que referencia un intervalo de tiempo configurado.

TimeColumnLength (RT Professional)
Descripción
Define el ancho para la columna de tiempos seleccionada:
Sintaxis
Object.TimeColumnLength[=Int32]
Object
Int32
Opcional. Valor o constante que define el ancho para la columna de tiempo seleccionada.
TimeColumnMeasurePoints (RT Professional)
Descripción
Determina el número de puntos de medida que se mostrarán en la columna de tiempo
seleccionada.
Sintaxis
Object.TimeColumnMeasurePoints[=Int32]
Object
Int32
Opcional. Valor o constante que determina el número de puntos de medida.
TimeColumnName (RT Professional)
Descripción
Especifica el nombre de la columna de tiempo seleccionada.

Sintaxis
Object.TimeColumnName[=STRING]
Object
STRING
Opcional. Valor o constante que especifica el nombre de la columna de tiempo seleccionada.
TimeColumnRangeType (RT Professional)
Descripción
Determina el intervalo de tiempo para la columna de tiempo seleccionada.
Sintaxis
Object.TimeColumnRangeType[=TimeRangeMode]
Object
TimeRangeMode

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 establecerá el número de puntos
da de medida.
TimeColumnRemove (RT Professional)
Descripción
Elimina la columna de tiempo seleccionada de la lista.

Sintaxis
Object.TimeColumnRemove[=STRING]
Object
STRING
Opcional. Elimina la columna de tiempo seleccionada de la lista.
TimeColumnRename (RT Professional)
Descripción
Modifica el nombre de la columna de tiempo que será referenciada mediante la propiedad
"TimeColumnIndex". Con "TimeColumnRename" podrá dinamizar también la propiedad
"TimeColumnName".
Sintaxis
Object.TimeColumnRename[=STRING]
Object
STRING
Opcional. Modifica el nombre de la columna de tiempo que será referenciada mediante la
propiedad "TimeColumnIndex".
TimeColumnRepos (RT Professional)
Descripción
Modifica la secuencia de las columnas de tiempos con las correspondientes columnas de
valor. "Arriba" y "Abajo" desplazan la columna de tiempo seleccionada en la lista. De esta
forma se desplazará hacia delante o hacia atrás la columna de tiempos con las
correspondientes columnas de valores en la tabla.
Sintaxis
Object.TimeColumnRepos[=Int32]

Object
Int32
Opcional. Valor o constante que modifica la secuencia de las columnas de tiempos con las
correspondientes columnas de valor.
TimeColumnShowDate (RT Professional)
Descripción
Determina si se debe mostrar la columna de tiempo seleccionada en la Ventana de curvas.
Sintaxis
Object.TimeColumnShowDate[=BOOLEAN]
Object
BOOLEAN
TRUE: se mostrarán la fecha y la hora. El formato de fecha se establece en el campo "Formato
de fecha".
FALSE: no se mostrará la fecha. Solamente se visualiza la hora.
TimeColumnShowIcon (RT Professional)
Descripción
Determina si el contenido de la columna de tiempo se mostrará como símbolo.
Sintaxis
Object.TimeColumnActualize[=BOOLEAN]
Object

BOOLEAN
TRUE: el contenido se muestra en forma de símbolo.
FALSE: el contenido no se muestra en forma de símbolo.
TimeColumnShowTitleIcon (RT Professional)
Descripción
Determina si se debe mostrar el título en forma de símbolo.
Sintaxis
Object.TimeColumnShowTitleIcon[=BOOLEAN]
Object
BOOLEAN
TRUE: el título se mostrará en forma de símbolo.
FALSE: el título no se mostrará en forma de símbolo.
TimeColumnSort (RT Professional)
Descripción
Establece cómo se clasificará la columna de tiempo referenciada en "TimeColumnIndex".
Sintaxis
Object.TimeColumnSort[=SortMode]
Object

SortMode

0 no Ninguna 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.
TimeColumnSortIndex (RT Professional)
Descripción
Define la secuencia de clasificación de la columna de tiempo referenciada en
"TimeColumnIndex". Si establece en valor en "0", el criterio de clasificación se eliminará de
"TimeColumnSort".
Sintaxis
Object.TimeColumnSortIndex[=Int32]
Object
Int32
Opcional. Valor o constante que indica la secuencia de clasificación de la columna de tiempo
referenciada en "TimeColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se
eliminará de "TimeColumnSort".
TimeColumnTimeFormat (RT Professional)
Descripción
Determina qué formato de hora se utilizará para la visualización de la columna tiempo
seleccionada.
Sintaxis
Object.TimeColumnTimeFormat[=STRING]
Object

STRING
Valor Explicación
Automático El formato de tiempo se generará automáticamente.
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.
TimeColumnTimeRangeBase (RT Professional)
Descripción
Define la unidad de tiempo para la determinación del intervalo de tiempo.
Sintaxis
Object.TimeColumnTimeRangeBase[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
Valor Descripción
500 500 ms
1000 1 segundo
60000 1 minuto
3600000 1 hora
86400000 1 día
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.
TimeColumnUseValueColumnColors (RT Professional)
Descripción
Determina si se debe mostrar la columna de tiempo seleccionada en el En el color de la
columna de valores.
Sintaxis
Object.TimeColumnUseValueColumnColors[=BOOLEAN]
Object
BOOLEAN
TRUE: la columna de tiempo seleccionada se mostrará en el color de la columna de valores.
Los ajustes de los campos "Color de fuente" y "Color de fondo" no serán efectivos.
FALSE: la columna de tiempo seleccionada se mostrará en los colores definidos en los
campos "Color de fuente" y "Color de fondo".
TimeColumnVisible (RT Professional)
Descripción
En esta lista se mostrarán los ejes de tiempos que haya creado. Active en la lista las columnas
de tiempos que quiera mostrar en la tabla.
Haga clic sobre una columna de tiempos de la lista para ajustar las propiedades y para
establecer el intervalo de tiempo de la columna de tiempos.
Sintaxis
Object.TimeColumnVisible[=BOOLEAN]

Object
BOOLEAN
Opcional. TRUE si se muestra la columna de tiempo en la tabla.
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.

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 1332)
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
TitleDarkShadowColor (RT Professional)
Descripción
Define el color para la parte oscura del sombreado.
Con el botón se abre la selección de color. El ajuste solamente será efectivo si la opción "Color
de sombreado" está activa.
Sintaxis
Object.TitleDarkShadowColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que define el color para la parte oscura del sombreado.

Observaciones
TitleForeColor (RT Professional)
Descripción
Determina el color de fuente del título de la tabla para el estado seleccionado.
Sintaxis
Object.TitleForeColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de fuente de la barra de título de la tabla.
Observaciones
TitleGridLineColor (RT Professional)
Descripción
Determina el color de las líneas de separación en la barra de título de la tabla.

Sintaxis
Object.TitleGridLineColor[=Color]
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
TitleLightShadowColor (RT Professional)
Descripción
Define el color para la parte clara del sombreado.
Con el botón se abre el cuadro de diálogo para la selección de color. El ajuste solamente será
efectivo si la opción "Color de sombreado" está activa.
Sintaxis
Object.TitleLightShadowColor[=Color]
Object
● AlarmControl

Color
Opcional. Valor o constante que define el color para la parte clara del sombreado.
Observaciones
TitleSort (RT Professional)
Descripción
Determina cómo se activa la clasificación por título de columna. La opción "Desplazamiento
automático" debe estar desactivada para clasificar por título de columna.
Sintaxis
Object.TitleSort[=GridSortTrigger]
Object
● AlarmControl
GridSortTrigger

0 No No es posible clasificar por título de columna.
1 con Clic La clasificación se activará haciendo clic sobre el título de la columna.
2 con doble clic La clasificación se activará haciendo un doble clic sobre el título de
columna.

TitleStyle (RT Professional)
Descripción
Determina qué color de sombreado se usa para el título de tabla.
Sintaxis
Object.TitleStyle[=GridHeaderStyle]
Object
● AlarmControl
GridHeaderStyle

0 Plano No se utilizará un color de sombreado. Representación de aspecto plano
del título.
1 Botón Se utilizará un color de sombreado. Representación de aspecto tridimen‐
sional del título.
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
Determina el valor límite para el visor de memoria a partir del cual se notifica una desviación.
Sintaxis
Object.Tolerance[=Int32]
Object
● DiscSpaceView
Int32
Opcional. Un valor o una constante que determina el valor límite para el visor de memoria a
partir del cual se comunica una desviación.
ToleranceColor (RT Professional)
Descripción
Determina los colores en los que se representa la barra del visor de memoria en cuanto se
rebasa 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
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
ToleranceLowerLimitColor (RT Professional)
Descripción
Determina el color para el valor límite inferior "ToleranceLowerLimit".
Sintaxis
Object.ToleranceLowerLimitColor[=Color]

Object
● Bar
Color
"ToleranceLowerLimit" .
Observaciones
La propiedad "ToleranceLowerLimitEnabled" debe tener el valor TRUE cuando debe
modificarse el color de barra al alcanzar el valor límite.
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".
ToleranceLowerLimitRelative (RT Professional)
Descripción
Determina si el valor límite inferior "ToleranceLowerLimit" se evalúa en porcentaje o de forma
absoluta.

Sintaxis
Object.ToleranceLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "ToleranceLowerLimit" se evalúa en porcentaje.
FALSE: el valor límite inferior "ToleranceLowerLimit" se evalúa de forma absoluta.
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.
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceUpperLimit",
"ToleranceUpperLimitColor" y "ToleranceUpperLimitRelative":
● Valor límite

ToleranceUpperLimitColor (RT Professional)
Descripción
Determina el color para el valor límite superior "ToleranceUpperLimit".
Sintaxis
Object.ToleranceUpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Un valor o una constante que determina el color para el límite superior
"ToleranceUpperLimit".
Observaciones
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
ToleranceUpperLimitRelative (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]
Object
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite superior "ToleranceUpperLimit" se evalúa en porcentaje.
FALSE: el valor límite superior "ToleranceUpperLimit" se evalúa de forma absoluta.
ToolbarAlignment (RT Professional)
Descripción
Determina la posición de la barra de herramientas.
Sintaxis
Object.ToolbarAlignment[=ToolbarPosition]

Object
● AlarmControl
● SysDiagControl
ToolbarPosition
Opcional. Valor o constante que determina la posición de la barra de herramientas.
ToolbarBackColor (RT Professional)
Descripción
Color de fondo - ToolbarBackColor
Determina el color de fondo de la barra de herramientas. Mediante el botón abra el cuadro de
diálogo "Selección de color" para seleccionar el color.
El color de fondo configurado solamente se mostrará cuando la opción "Visualizar" está
activada.
Sintaxis
Object.ToolbarBackColor[=Color]
Object
● AlarmControl
Color
Opcional. Valor o constante que determina el color de fondo de la barra de herramientas.

Observaciones
ToolbarButtonActive (RT Professional)
Descripción
Establece si la función enlazada a la tecla se puede activar en runtime. Haga clic en la tecla
en runtime para activar la función correspondiente.
Sintaxis
Object.ToolbarButtonActive[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: la función enlazada a la tecla está activa.
FALSE: la función enlazada a la tecla no está activa. Mediante scripts locales pueden
enlazarse funciones propias con la tecla.
ToolbarButtonAdd (RT Professional)
Descripción
Establece una nueva función de teclas definida por el usuario.
El nombre asignado por WinCC se puede modificar en el campo "Nombre de objeto".

Sintaxis
Object.ToolbarButtonAdd[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que establece el nombre de la nueva función de tecla.
ToolbarButtonBeginGroup (RT Professional)
Descripción
Determina 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
TRUE: antes de la función de teclas seleccionada se añadirá el separador.
FALSE: antes de la función de teclas seleccionada no se añadirá ningún separador.

ToolbarButtonCount (RT Professional)
Descripción
Define el número de botones que contiene la barra de herramientas.
Sintaxis
Object.ToolbarButtonCount[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de botones de la barra de herramientas.
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

BOOLEAN
Opcional. TRUE si puede utilizarse la tecla definida por el usuario seleccionada en la barra
de herramientas.
ToolbarButtonHotKey (RT Professional)
Descripción
Define la tecla de acceso directo para la función de tecla seleccionada.
Para crear o modificar una tecla de acceso directo, haga clic en el campo "Tecla de acceso
directo" y pulse la tecla o combinación de teclas deseada.
Sintaxis
Object.ToolbarButtonHotKey[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define la tecla de acceso directo para la función de tecla
seleccionada.
ToolbarButtonID (RT Professional)
Descripción
Define un número de identidad unívoco para la función de tecla seleccionada.
WinCC asigna el ID y no se puede modificar.

Sintaxis
Object.ToolbarButtonID[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que define el número de identidad de la función de tecla
seleccionada.
ToolbarButtonIndex (RT Professional)
Descripción
Hace referencia a una función de tecla.
Mediante la utilización de este atributo podrá asignar a una función de tecla determinada los
atributos de otro.
Los valores válidos para "ToolbarButtonIndex" se encuentran entre 0 y "ToolbarButtonCount"
menos 1. El atributo "ToolbarButtonCount" indica el número de funciones de teclas que
pueden configurarse.
Sintaxis
Object.ToolbarButtonIndex[=Int32]
Object
● AlarmControl

Int32
Opcional. Valor o constante que define el número de la función de tecla seleccionada.
ToolbarButtonLocked (RT Professional)
Descripción
Determina si se mostrará el estado pulsado (encajado) de un botón definido por el usuario en
la barra de herramientas.
Sintaxis
Object.ToolbarButtonLocked[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
Opcional. TRUE si se muestra el estado pulsado del botón definido por el usuario seleccionado
en la barra de herramientas.
ToolbarButtonName (RT Professional)
Descripción
Define el nombre del botón definido por el usuario seleccionado.
El nombre de un botón definido por el usuario puede modificarse. La propiedad
"ToolbarButtonName" para botones definidos por el usuario se puede dinamizar con la
propiedad "ToolbarButtonRename".
Sintaxis
Object.ToolbarButtonName[=STRING]

Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del botón definido por el usuario
seleccionado.
ToolbarButtonAuthorization (RT Professional)
Descripción
Muestra el permiso para la función de teclas seleccionada. A través del botón de selección
puede modificar el permiso. Los permisos se configuran en la administración de usuarios.
Consulte también
ToolbarButtonRemove (RT Professional)
Descripción
Elimina el botón definido por el usuario seleccionado.
Sintaxis
Object.ToolbarButtonRemove[=STRING]

Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nombre del botón definido por el usuario que se va
a eliminar.
ToolbarButtonRename (RT Professional)
Descripción
Devuelve el nombre del botón de la barra de herramientas definido por el usuario que está
referenciado mediante la propiedad "ToolbarButtonID".
Con "ToolbarButtonRename" podrá dinamizar también la propiedad "ToolbarButtonName".
Sintaxis
Object.ToolbarButtonRename[=STRING]
Object
● AlarmControl
STRING
Opcional. Valor o constante que define el nuevo nombre del botón definido por el usuario
seleccionado.

ToolbarButtonRepos (RT Professional)
Descripción
Modifica el orden de las funciones de tecla definidas por el usuario en la barra de
herramientas.
"Arriba" y "Abajo" desplazan la función de tecla seleccionada en la lista. De esta forma en el
runtime se desplazará hacia arriba o abajo la barra de herramientas en Control.
Sintaxis
Object.ToolbarButtonRepos[=Int32]
Object
● AlarmControl
Int32
Opcional. Valor o constante que determina la posición del botón definido por el usuario
seleccionado en la barra de herramientas.
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.
ToolbarButtonUserDefined (RT Professional)
Descripción
Determina 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
TRUE: la tecla de la barra de herramientas está definida por el usuario.
FALSE: la tecla de la barra de herramientas está predefinida en el sistema.
ToolbarShowTooltips (RT Professional)
Descripción
Determina 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
TRUE: se mostrarán los tooltips.
FALSE: no se mostrarán los tooltips.
ToolbarUseBackColor (RT Professional)
Descripción
Determina si se debe visualizar el color de fondo de la barra de herramientas.
Sintaxis
Object.ToolbarUseBackColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se muestra el color de fondo de la barra de herramientas.
FALSE: no se muestra el color de fondo de la barra de herramientas.

ToolbarUseHotKeys (RT Professional)
Descripción
Determina si las teclas de acceso directo están activas para las funciones de teclas en runtime.
Las teclas de acceso directo para la función de teclas se insertan en el campo "tecla de acceso
directo".
Sintaxis
Object.ToolbarUseHotKeys[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: las teclas de acceso directo están activas.
FALSE: las teclas de acceso directo no están activas.
ToolbarVisible (RT Professional)
Descripción
Determina si se debe visualizar la barra de herramientas del control.
Sintaxis
Object.ToolbarVisible[=BOOLEAN]
Object
● AlarmControl

BOOLEAN
TRUE: se muestra la barra de herramientas.
FALSE: no se muestra la barra de herramientas.
ToolTipText (RT Advanced, RT Professional)
Descripción
Determina el texto del tooltip.
Sintaxis
Object.ToolTipText[=STRING]
ToolTipText
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon

● Polyline
● Rectangle
● RoundButton
● StatusForce
● Switch
● SymbolicIOField
● TextField
● TubeArcObject
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 del objeto indicado.
Sintaxis
Object.Top[=Int32]
Object
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField

● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField

● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
● S7GraphOverview
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.
TopOffset (RT Professional)
Descripción
Determina la distancia de la imagen desde el borde superior de la ventana de imagen.
La imagen se visualizará como corte de la ventana de imagen. Las barras de desplazamiento
están ubicadas en los bordes izquierdo y 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" y "VerticalScrollBarPosition".
Sintaxis
Object.TopOffset[=Int32]

Object
● Screenwindow
Int32
Opcional. Valor o constante que determina la distancia de la imagen desde el borde superior
de la ventana de imagen.
Total (RT Professional)
Descripción
Define la capacidad de memoria.
Sintaxis
Object.Total[=DOUBLE]
Object
● DiskSpaceView
DOUBLE
Opcional. Valor o constante que define la capacidad de memoria.
Transparency (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.
Sintaxis
Object.Transparency[=Int32]

Object
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowsSlider
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
Determina qué color del gráfico asignado (*.bmp, *.dib) del objeto indicado se pondrá en
"transparente".
La propiedad "UseTransparentColor" debe tener el valor TRUE para que el color se vea
transparente.
Sintaxis
Object.TransparentColor[=Color]
Object
● GraphicView
● GraphicIOField
Color
Opcional. Valor o constante que determina el color que se verá transparente.
Observaciones
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 propiedad "PicDeactUseTransColor" debe tener el valor TRUE para que el color se ponga
en "transparent".
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]
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

TransparentColorPictureOn (RT Professional)
Descripción
Determina qué color del objeto de mapa de bits asignado para el estado "On" se pone 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".
Observaciones
La propiedad "PicDownUseTransColor" debe tener el valor TRUE para que el color se ponga
en "transparent".
TrendActualize (RT Professional)
Descripción
Determina si se actualizará la curva seleccionada.
Sintaxis
Object.TrendActualize[=BOOLEAN]
Object

BOOLEAN
TRUE: la curva seleccionada se actualizará siempre.
FALSE: no se actualizará la curva seleccionada. Este ajuste es útil si se compara una curva
archivada con una curva actual.
TrendAdd (RT Professional)
Descripción
Crea una curva nueva.
Sintaxis
Object.TrendAdd[=STRING]
Object
STRING
Opcional. Nombre de la nueva curva.
TrendBeginTime (RT Professional)
Descripción
Establece el instante de inicio del intervalo de tiempo para el suministro de datos para la curva
seleccionada.
Sintaxis
Object.TrendBeginTime[=DateTime]
Object
DateTime
Opcional. Define el instante de inicio para el suministro de datos de la curva seleccionada.

TrendColor (RT Professional)
Descripción
Define o devuelve el color del objeto.
El visor de tendencias representa con una pequeña flecha la tendencia (ascendente o
descendente) del valor medido que debe vigilarse. Para activar la visualización de tendencia,
la propiedad "Trend" debe estar puesta en "TRUE".
Sintaxis
Object.TrendColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color del objeto.
Observaciones
TrendCount (RT Professional)
Descripción
Determina el número de curvas configuradas.
Sintaxis
Object.TrendCount[=Int32]

Object
Int32
Opcional. Valor o constante que determina el número de curvas del objeto indicado.
TrendEndTime (RT Professional)
Descripción
Establece el instante final del intervalo de tiempo para conexión de datos para la curva
seleccionada.
Sintaxis
Object.TrendEndTime[=DateTime]
Object
DateTime
Opcional. Define el instante final para el suministro de datos de la curva seleccionada.
TrendExtendedColorSet (RT Professional)
Descripción
Determina si se puede configurar el color de punto y el color de relleno y si se mostrarán los
colores en runtime.
Sintaxis
Object.TrendExtendedColorSet[=BOOLEAN]
Object

BOOLEAN
TRUE: los ajustes de los campos "Punto Color" y "Color de relleno" se pueden configurar y
serán efectivos en runtime.
FALSE: los ajustes de los campos "Punto Color" y "Color de relleno" no se pueden configurar
ni serán efectivos en runtime.
Consulte también
TrendFill (RT Professional)
Descripción
Determina si se debe mostrar rellena la superficie debajo de la curva.
Sintaxis
Object.TrendFill[=BOOLEAN]
Object
BOOLEAN
TRUE: la superficie debajo de la curva se mostrará rellenada. Si la opción "Avanzado" no está
activada, se utilizará el color de la curva como color de relleno.
FALSE: la curva no se mostrará rellenada.
TrendFillColor (RT Professional)
Descripción
Define el color de relleno de la curva.
Se utilizará color de relleno si la opción "Relleno" está activada. Mediante el botón abra el
cuadro de diálogo "Selección de color" para seleccionar el color.
La configuración solamente será efectiva si la opción "Ampliado" está activa.

Sintaxis
Object.TrendFillColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de relleno de la curva seleccionada.
Observaciones
TrendIndex (RT Professional)
Descripción
Hace referencia a una curva configurada. Esta propiedad permite asignar los valores de otras
propiedades a una determinada curva. El índice debe fijarse siempre antes de modificar las
propiedades de una curva en runtime.
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 determina el número de la curva seleccionada.

TrendIndicatorColor (RT Professional)
Descripción
Determina 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
Color
Opcional. Un valor o una constante que determina el color del visor de tendencias.
Observaciones
TrendLabel (RT Professional)
Descripción
Define la denominación de la curva seleccionada. La designación se muestra en runtime si el
atributo "UseTrendNameAsLabel" tiene el valor "FALSE".
Sintaxis
Object.TrendLabel[=STRING]
Object

STRING
Opcional. Valor o constante que define la denominación de la curva seleccionada.
TrendLineStyle (RT Professional)
Ejemplo
Determina qué tipo de línea se utilizará para la representación de la curva.
Sintaxis
Object.TrendLineStyle[=LineStyle]
Object
LineStyle

0 sólida La curva se representa seguida.
1 discontinua La curva se representa discontinua.
2 Puntos La curva se mostrará con una línea de puntos.
3 punto raya La curva se mostrará con una línea punto-raya.
4 Punto punto raya La curva se mostrará con una línea punto punto raya.
TrendLineType (RT Professional)
Descripción
Determina cómo se debe mostrar la curva.
Sintaxis
Object.TrendLineType[=TrendLineTypeScada]
Object
FunctionTrendControl
OnlineTrendControl

TrendLineTypeScada

0 Ninguno Solamente se mostrarán los puntos.
1 unir los puntos linealmente Se mostrará una curva con los puntos enlazados linealmente.
2 Curva escalonada Se mostrará una curva escalonada con los puntos enlazados
linealmente.
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.
TrendLowerLimit (RT Professional)
Descripción
Indica el valor límite inferior para una variable. Si la variable rebasa por defecto el valor de
"TrendLowerLimit", se marcarán los valores con el color configurado en
"TrendLowerLimitColor". El valor será efectivo si la propiedad "TrendLowerLimitColoring" tiene
el valor "TRUE".
Sintaxis
Object.TrendLowerLimit[=DOUBLE]

Object
DOUBLE
Opcional. Valor o constante que determina el valor límite inferior de una variable.
TrendLowerLimitColor (RT Professional)
Descripción
Establece el color que marca los valores de variable que se encuentran por debajo del valor
de "TrendLowerLimit". El ajuste será efectivo si el atributo "TrendLowerLimitColoring" tiene el
valor "TRUE"".
Sintaxis
Object.TrendLowerLimitColor[=Color]
Object
Color
Opcional. Valor o constante que establece el color de los valores de variable situados por
debajo del valor de "TrendLowerLimit".
Observaciones
TrendLowerLimitColoring (RT Professional)
Descripción
Establece si se utilizará el atributo "TrendLowerLimitColor" para marcar los valores de variable
que se encuentran por debajo del valor "TrendLowerLimit".

Sintaxis
Object.TrendLowerLimitColoring[=BOOLEAN]
Object
BOOLEAN
TRUE: la propiedad "TrendLowerLimitColor" es efectiva.
FALSE: la propiedad "TrendLowerLimitColor" no es efectiva.
TrendMeasurePoints (RT Professional)
Descripción
Determina el número de puntos de medida que se utilizará para la representación de 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.
TrendName (RT Professional)
Descripción
Muestra el nombre de la curva seleccionada. Puede determinar el nombre en la ficha "Curvas".
La propiedad "TrendName" puede dinamizarse mediante la propiedad "TrendRename".

Sintaxis
Object.TrendName[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre de la curva seleccionada.
TrendPointColor (RT Professional)
Descripción
Indica el color de los puntos de la curva seleccionada.
Mediante el botón abra el cuadro de diálogo "Selección de color" para seleccionar el color.
La configuración solamente será efectiva si la opción "Ampliado" está activa.
Sintaxis
Object.TrendPointColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de los puntos de la curva seleccionada.
Observaciones

TrendPointStyle (RT Professional)
Descripción
Determina cómo se mostrarán los puntos en la curva.
Sintaxis
Object.TrendPointStyle[=PointStyle]
Object
PointStyle

0 Ninguno No se visualizan los puntos.
1 Puntos Los puntos de la curva se mostrarán como puntos de un píxel de
tamaño. La configuración del campo "Ancho de punto" no tendrá
efecto.
2 Cuadrados Los puntos se mostrarán como cuadrados. La configuración del
campo "Ancho de punto" tendrá efecto.
3 Círculos Los puntos se mostrarán como círculos. La configuración del cam‐
po "Ancho de punto" tendrá efecto.
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]
Object

Int32
Opcional. Valor o constante que establece el ancho de punto en píxeles de la curva
seleccionada.
TrendProvider (RT Professional)
Descripción
Define el origen de datos de la curva seleccionada.
Sintaxis
Object.TrendProvider[=Provider]
Object
Provider

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.
TrendRangeType (RT Professional)
Descripción
Establece el intervalo de tiempo en el que se suministrarán datos a la curva seleccionada.
Mediante un suministro de datos mediante archivo de usuario solamente podrá establecer el
número de puntos de medición.
Sintaxis
Object.TrendRangeType[=RangeType]

Object
RangeType

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.
TrendRemove (RT Professional)
Descripción
Elimina las curvas seleccionadas de la lista.
Sintaxis
Object.TrendRemove[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre de la curva que se va a eliminar.
TrendRename (RT Professional)
Descripción
Modifica el nombre de la curva que será referenciada mediante la propiedad "TrendIndex".
Con "TrendRename" podrá dinamizar también la propiedad "TrendName".
Sintaxis
Object.TrendRename[=STRING]

Object
STRING
Opcional. Valor o constante que determina el nuevo nombre de la curva seleccionada.
TrendRepos (RT Professional)
Descripción
Modifica la secuencia de la curva seleccionada en la ventana de curvas.
"Arriba" y "Abajo" desplazan la curva seleccionada en la lista. De esta forma la curva se
mostrará en runtime en el primer plano o en el fondo.
Sintaxis
Object.TrendRepos[=Int32]
Object
Int32
Opcional. Valor o constante que determina la nueva posición de la curva seleccionada.
TrendSelectTagNameX (RT Professional)
Descripción
Abre el dialogo para la selección del nombre de variable para el suministro de datos del eje
X en el visor de curvas f(x). Esta propiedad pueden utilizarla los programadores para que,
por ejemplo, el usuario pueda seleccionar un nombre de variable con un botón.
Sintaxis
Object.TrendSelectTagNameX[=BOOLEAN]

Object
BOOLEAN
TRUE:
FALSE:
TrendSelectTagNameY (RT Professional)
Descripción
Abre el diálogo para la selección del nombre de variable para el suministro de datos del eje
Y en el visor de curvas f(x). Esta propiedad pueden utilizarla los programadores para que,
por ejemplo, el usuario pueda seleccionar un nombre de variable con un botón.
Sintaxis
Object.TrendSelectTagNameY[=BOOLEAN]
Object
BOOLEAN
TRUE:
FALSE:
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.
Sintaxis
Object.TrendTagNameX[=STRING]

Object
STRING
Opcional. Valor o constante que determina el nombre de las variables HMI o la columna del
eje X.
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.
TrendTimeRangeBase (RT Professional)
Descripción
Define la unidad de tiempo para la determinación del intervalo de tiempo.
Sintaxis
Object.TrendTimeRangeBase[=TagLoggingTimeUnit]
Object

TagLoggingTimeUnit
Valor Descripción
500 500 ms
1000 1 segundo
60000 1 minuto
3600000 1 hora
86400000 1 día
TrendTimeRangeFactor (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.TimeRangeFactor[=Int32]
Object
Int32
Opcional. Valor o constante que establece el factor para determinar el rango de tiempo.
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]

Object
STRING
Opcional. Valor o constante que establece el nombre de la ventana de curvas para la curva
seleccionada.
TrendUncertainColor (RT Professional)
Descripción
Los valores tienen un estado inseguro, si el valor inicial después de activar runtime es
desconocido o se utilizará un valor de sustitución.
Con la propiedad "TrendUncertainColor" se define el color que se utilizará para caracterizar
estos valores. El dato se evaluará o no dependiendo de la propiedad
"TrendUncertainColoring".
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

TrendUncertainColoring (RT Professional)
Descripción
Los valores tienen un estado inseguro, si el valor inicial después de activar runtime es
desconocido o se utilizará un valor de sustitución. Mediante "TrendUncertainColoring" puede
definir si dichos valores deben ser marcados con el color definido en "TrendUncertainColor".
Sintaxis
Object.TrendUncertainColoring[=BOOLEAN]
Object
BOOLEAN
TRUE: la configuración de la propiedad "TrendUncertainColor" tiene efecto.
FALSE: la configuración de la propiedad "TrendUncertainColor" no tiene efecto.
TrendUpperLimit (RT Professional)
Descripción
Indica el valor límite superior para una variable.
Si la variable rebasa por defecto el valor de "TrendUpperLimit", se representarán los valores
con el color configurado en "TrendUpperLimitColor". El valor tendrá efecto si el atributo
"TrendUpperLimitColoring" tiene el valor "TRUE".
Sintaxis
Object.TrendUpperLimit[=DOUBLE]
Object

DOUBLE
Opcional. Valor o constante que determina el valor límite superior para los valores de la curva
seleccionada.
TrendUpperLimitColor (RT Professional)
Descripción
Establece el color que marca los valores de variable que se encuentran por debajo del valor
de "TrendLowerLimit". El ajuste será efectivo si el atributo "TrendUpperLimitColoring" tiene el
valor "TRUE".
Sintaxis
Object.TrendUpperLimitColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de los valores inferiores al valor límite de
la curva seleccionada.
Observaciones
TrendUpperLimitColoring (RT Professional)
Descripción
Define si el borde de selección se coloreará con el color definido por el sistema.
Sintaxis
Object.TrendUpperLimitColoring[=BOOLEAN]

Object
BOOLEAN
TRUE: la configuración del atributo "TrendUpperLimitColor" tiene efecto.
FALSE: la configuración del atributo "TrendUpperLimitColor" no tiene efecto.
TrendVisible (RT Professional)
Descripción
Determina si se mostrará la curva seleccionada.
En esta lista se mostrarán las curvas que haya creado.
Active en la lista las curvas que quiera mostrar en la ventana de curvas.
Haga clic sobre una curva de la lista para ajustar las propiedades y para asignar los ejes y la
ventana de curvas de la curva.
Sintaxis
Object.TrendVisible[=BOOLEAN]
Object
BOOLEAN
TRUE: se mostrará la curva seleccionada.
FALSE: no se mostrará la curva seleccionada.
TrendWindowAdd (RT Professional)
Descripción
Crea un nuevo visor de curvas.

Sintaxis
Object.TrendWindowAdd[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del nuevo visor de curvas.
TrendWindowCoarseGrid (RT Professional)
Descripción
Determina si se mostrarán las líneas de retícula y la escala principal.
Sintaxis
Object.TrendWindowCoarseGrid[=BOOLEAN]
Object
BOOLEAN
TRUE: se mostrarán las líneas de retícula para la escala principal.
FALSE: no se mostrarán las líneas de retícula para la escala principal.
TrendWindowCoarseGridColor (RT Professional)
Descripción
Indica el color de las líneas de retícula para la escala principal.

Sintaxis
Object.TrendWindowCoarseGridColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de las líneas de retícula para la escala
principal.
Observaciones
TrendWindowFineGrid (RT Professional)
Descripción
Determina si se mostrarán las líneas de retícula para la escala auxiliar.
Sintaxis
Object.TrendWindowFineGrid[=BOOLEAN]
Object
BOOLEAN
TRUE: se mostrarán las líneas de retícula de la escala auxiliar.
FALSE: no se mostrarán las líneas de retícula de la escala auxiliar.

TrendWindowFineGridColor (RT Professional)
Descripción
Indica el color de las líneas de retícula para la escala auxiliar.
Sintaxis
Object.TrendWindowFineGridColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de las líneas de retícula para la escala
auxiliar.
Observaciones
TrendWindowForegroundTrendGrid (RT Professional)
Descripción
Determina si se mostrarán solamente las líneas de retícula para la curva de primer plano de
la ventana de curvas.
Sintaxis
Object.TrendWindowForegroundTrendGrid[=BOOLEAN]

Object
BOOLEAN
TRUE: en la ventana de curvas se mostrarán las líneas de retícula para la curva de primer
plano.
FALSE: en la ventana de curvas se mostrarán las líneas de retícula para todas las curvas.
TrendWindowGridInTrendColor (RT Professional)
Descripción
Determina si se mostrarán las líneas de retícula para la escala principal en el color de la
curva.
Sintaxis
Object.TrendWindowGridInTrendColor[=BOOLEAN]
Object
BOOLEAN
TRUE: las líneas de retícula se mostrarán en el color de la curva.
FALSE: las líneas de retícula se mostrarán en el color ajustado en el campo "Color".
TrendWindowHorizontalGrid (RT Professional)
Descripción
Determina si se mostrarán las líneas de retí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.
TrendWindowIndex (RT Professional)
Descripción
Hace referencia a una ventana de curvas configurada. Esta propiedad permite asignar los
valores de otras propiedades a una determinada ventana de curvas.
Los valores válidos para "TrendWindowIndex" se encuentran entre 0 y "TrendWindowCount"
menos 1. La propiedad "TrendWindowCount" indica el número de ventanas de curvas
configuradas.
Sintaxis
Object.TrendWindowIndex[=Int32]
Object
Int32
Opcional. Valor o constante que define el número de la ventana de curvas seleccionada.
TrendWindowName (RT Professional)
Descripción
Establece el nombre de la ventana de curvas seleccionada.
Sintaxis
Object.TrendWindowName[=STRING]

Object
STRING
Opcional. Valor o constante que define el nombre de la ventana de curvas seleccionada.
TrendWindowRemove (RT Professional)
Descripción
Elimina el visor de curvas seleccionado de la lista.
Sintaxis
Object.TrendWindowRemove[=STRING]
Object
STRING
Opcional. Valor o constante que determina el nombre de la ventana de curvas que se va a
eliminar.
TrendWindowRename (RT Professional)
Descripción
Modifica el nombre de la ventana de curvas que será referenciado mediante la propiedad
"TrendWindowIndex".
Con "TrendWindowRename" se puede dinamizar también la propiedad "TrendWindowName".
Sintaxis
Object.TrendWindowRename[=STRING]

Object
STRING
Opcional. Valor o constante que determina el nuevo nombre de la ventana de curvas
seleccionada.
TrendWindowRepos (RT Professional)
Descripción
Modifica la secuencia del visor de curvas.
"Arriba" y "Abajo" desplazan la curva seleccionada en la lista. La secuencia en la lista
determina la posición en Control. El primer visor de curvas se muestra en la posición inferior;
el último visor de curvas, en la posición superior.
Sintaxis
Object.TrendWindwRepos[=Int32]
Object
Int32
Opcional. Valor o constante que determina la nueva posición de la ventana de curvas
seleccionada.
TrendWindowRulerColor (RT Professional)
Descripción
Indica el color de la regla.
Mediante el botón abra el cuadro de diálogo "Selección de color" para seleccionar el color. El
color se podrá configurar y mostrar si se ha ajustado la representación "1 - gráfico".

Sintaxis
Object.TrendWindowRulerColor[=Color]
Object
Color
Opcional. Valor o constante que determina el color de la regla.
Observaciones
TrendWindowRulerLayer (RT Professional)
Descripción
Determina el nivel de representación de la regla en el visor de curvas.
Sintaxis
Object.TrendWindowRulerLayer[=RulerLayer]
Object
RulerLayer

0 detrás de retícula La imagen se situará detrás de la retícula.
1 detrás de curvas La imagen se situará detrás de las curvas y delante de la retícula.
2 delante de curvas La regla se situará delante de las curvas.

TrendWindowRulerStyle (RT Professional)
Descripción
Establece la representación de la regla.
Sintaxis
Object.TrendWindowRulerStyle[=RulerStyle]
Object
RulerStyle
TRUE: la regla se mostrará como una sencilla línea negra.
FALSE: la regla se mostrará con el "Color" y "Grosor" configurados.
TrendWindowRulerWidth (RT Professional)
Descripción
Define en píxeles el grosor de la regla.
El grosor se podrá configurar y mostrar si se ha ajustado la representación "1 - gráfico".
Sintaxis
Object.TrendWindowRulerWidth[=Int32]
Object
Int32
Opcional. Valor o constante que determina el grosor en píxeles de la regla.

TrendWindowSpacePortion (RT Professional)
Descripción
Establece el nombre de la ventana de curvas seleccionada en la representación de Control.
Sintaxis
Object.TrendWindowSpacePortion[=Int32]
Object
Int32
Opcional. Valor o constante que define en forma de porcentaje la proporción de la ventana
de curvas seleccionada en Control.
TrendWindowVerticalGrid (RT Professional)
Descripción
Determina si se mostrarán las líneas de retícula verticales.
Sintaxis
Object.TrendWindowVerticalGrid[=BOOLEAN]
Object
BOOLEAN
TRUE: se mostrarán las líneas de retícula verticales.
FALSE: no se mostrarán las líneas de retícula verticales.

TrendWindowVisible (RT Professional)
Descripción
Determina si se mostrará la ventana de curvas seleccionada.
En esta lista se mostrarán los visores de curvas que se hayan creado.
Active en la lista los visores de curvas que quiera mostrar en Control.
Haga clic sobre una entrada de la lista para ajustar las propiedades de la regla y ajustar las
líneas de cuadrícula.
Sintaxis
Object.TrendWindowVisible[=BOOLEAN]
Object
BOOLEAN
TRUE: se mostrará la ventana de curvas seleccionada.
FALSE: no se mostrará la ventana de curvas seleccionada.
TrendXAxis (RT Professional)
Descripción
Determina qué eje X se utilizará para la representación de la curva.
Los ejes X disponibles se establecerán en la ficha "Ejes X".
Sintaxis
Object.TrendXAxis[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje X utilizado para la curva seleccionada.

TrendYAxis (RT Professional)
Descripción
Determina qué eje Y se utilizará para la representación de la curva.
Los ejes Y disponibles se establecerán en la ficha "Ejes Y".
Sintaxis
Object.TrendYAxis[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje Y utilizado para la curva seleccionada.
3.5.5.14 Propiedades U-W (Panels, Comfort Panels, RT Advanced, RT Professional)
Unit (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.

UnitColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el color de texto para el nombre de la unidad de medida en el objeto "Gauge".
Sintaxis
Object.UnitColor[=Color]
Object
● Gauge
Color
Opcional. Valor o constante que determina el color de texto de la unidad de medida.
Observaciones
UnitText (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el texto para la unidad de medida del objeto indicado.
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 visualizar la unidad física del valor representado, por ejemplo. La
opción predeterminada no contiene ningún texto.
UnitTop (RT Professional)
Descripción
Determina la distancia de la unidad de medida respecto del borde superior del objeto indicado.
El texto solo puede posicionarse a lo largo del diámetro vertical del cuadrante. El valor de la
propiedad hace referencia a la altura del objeto indicado y se mide desde el borde superior
del objeto indicado hasta el borde inferior del texto.
Sintaxis
Object.UnitTop[=DOUBLE]
Object
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina la distancia de la unidad de medida respecto
del borde superior del objeto indicado.
0: el borde inferior del texto se encuentra sobre la delimitación superior del objeto indicado.
El texto ya no se ve, dado que se encuentra fuera del objeto indicado.
1: el borde inferior del texto se encuentra sobre la delimitación inferior del objeto indicado.
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.
Used (RT Professional)
Descripción
Devuelve el tamaño de la memoria ocupada.
Sintaxis
Object.Used[=DOUBLE]
Object
● DiscSpaceView
DOUBLE
Opcional. Un valor o una constante que devuelve el tamaño de la memoria ocupada.
UseDesignColorSchema (RT Professional)
Descripción
Determina si los colores definidos en el Esquema cromático global del diseño actual se
utilizarán para este objeto.
Sintaxis
Object.UseDesignColorSchema[=BOOLEAN]
Object
● Bar
● Button
● CheckBox

● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● WindowsSlider
● 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.
UseDesignShadowSettings (RT Professional)
Descripción
Determina si el objeto se representa con el sombreado fijado en el diseño activo.
Sintaxis
Object.UseDesignShadowSettings[=BOOLEAN]
Object
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicView
● Line
● Polygon
● Polyline
● Rectangle
● TextField
● TubeArcObject
● Tubepolyline
● TubeTeeObject
● Bar

● Button
● CheckBox
● Clock
● ComboBox
● Gauge
● GraphicIOField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● Slider
● SymbolicIOField
● WindowsSlider
BOOLEAN
TRUE: el objeto se representa con el sombreado global establecido para este tipo de objeto.
FALSE: el objeto se representa sin sombra.
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.

UseExponentialFormat (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si los números se representan con exponentes (p. ej., "1,00e+000").
Sintaxis
Object.UseExponentialFormat[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si los números se representan con exponentes (p. ej., "1,00e+000").
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
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "GraphicIOField".
BOOLEAN
Opcional. TRUE si el color del objeto de mapa de bits de una imagen intermitente se establece
en "transparent".
Consulte también

UseMessageColor (RT Professional)
Descripción
Determina si deben mostrarse los colores acordados para las categorías.
Sintaxis
Object.UseMessageColor [=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se mostrarán los colores.
FALSE: serán efectivos en la ficha "Representación" los ajustes de color que se hayan
indicado para el contenido de la tabla.
UseSelectedTitleColor (RT Professional)
Descripción
Determina si se utilizará un color de selección para los títulos de tablas de celdas
seleccionadas.
Sintaxis
Object.UseSelectedTitleColor[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se utilizará un color de selección. Los ajustes de "Fondo" y "Fuente" serán efectivos
en runtime.

FALSE: no se utilizará un color de selección. Los ajustes de "Fondo" y "Fuente" no serán

efectivos en runtime.
UseTableColor2 (RT Professional)
Descripción
Determina si se utilizará un segundo color de filas en la representación de la tabla.
Sintaxis
Object.UseTableColor2[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: los ajustes de "Color de fila 2" se utilizarán alternando con "Color de fila 1".
FALSE: los ajustes de "Color de fila 1" se utilizarán para todas las filas.
UseTagLimitColors (RT Professional)
Descripción
Determina que se utilicen los colores.
Sintaxis
Object.UseTagLimitColors[=BOOLEAN]
Object
● IOField
BOOLEAN
Opcional. TRUE si se utilizan los colores.

UseTransparentColor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el color determinado con la propiedad "TransparentColor" para el objeto indicado
debe verse transparente.
Sintaxis
Object.UseTransparentColor[=BOOLEAN]
Object
● GraphicView
● GraphicIOField
BOOLEAN
Opcional. TRUE si el color definido debe mostrarse transparente.
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".

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]
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
Determina si las propiedades "Nombre" o "Rotulación" se utilizarán como nombre de la curva
en runtime.
Sintaxis
Object.UseTrendNameAsLabel[=BOOLEAN]
Object
BOOLEAN
TRUE: se utilizará el nombre configurado en "Propiedades > Propiedades > Curvas > Nombre".
FALSE: se utilizará el nombre configurado en "Propiedades > Propiedades > Curvas >
Rotulación".
UserName (RT Professional)
Descripción
Devuelve el nombre del usuario que habilitó el objeto Alarm.
UV_ColumnWidth_AKZ (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
UV_ColumnWidth_Descriptor (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción

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

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

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

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

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

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

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 1308)
Tag (Página 1332)
ValueAxisAutoRange(i) (RT Professional)
Descripción
Establece si el rango de valores del eje Y se determina automáticamente o mediante los
valores "ValueAxisBegin(i)" y "ValueAxisEnd(i)".
Sintaxis
Object.ValueAxisAutoRange(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el rango de valores del eje Y se determina automáticamente o mediante
los valores "ValueAxisBegin(i)" y "ValueAxisEnd(i)".
ValueAxisLabel(i) (RT Professional)
Descripción
Define la designación del eje de valores. El dato se evaluará o no dependiendo de la propiedad
"ConfigureTimeAxis(i)".

Sintaxis
Object.ValueAxisLabel(i)[=STRING]
Object
STRING
Opcional. Valor o constante que define la designación del eje de valores.
ValueAxisScalingType(i) (RT Professional)
Descripción
Determina el tipo de escala de los ejes.
Sintaxis
Object.ValueAxisScalingType(i)[=AxisScalingType]
Object
AxisScalingType
hmiBarScalingLinear (0): escala lineal del eje
hmiBarScalingLogarithmic (1): escala logarítmica del eje
hmiBarScalingNegativeLogarithmic (2): escala logarítmica negativa del eje
Observaciones
ValueColumnAlignment(i) (RT Professional)
Descripción
Define la alineación de los valores de variable de este par de columnas. El parámetro i indica
el número del par de columnas.

Sintaxis
Object.ValueColumnAlignment(i)[=HorizontalAlignment]
Object
HorizontalAlignment
hmiAlignmentLeft (0): el texto se alinea a la izquierda.
hmiAlignmentCentered (1): el texto se centra.
hmiAlignmentRight (2): el texto se alinea a la derecha.
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
● DateTimeField
● IOField
● OptionGroup
● RoundButton
● Switch
● SymbolicIOField
● TextField
● CheckBox
VerticalAlignment
Opcional. Valor que determina la alineación vertical.
hmiAlignmentTop (0): el texto se representa en el borde superior.
hmiAlignmentMiddle (1): el texto se representa en el centro.

hmiAlignmentBottom (2): el texto se representa en el borde inferior.
VerticalGridLines (RT Professional)
Descripción
Determina si se deben visualizar líneas verticales.
Sintaxis
Object.VerticalGridLines[=BOOLEAN]
Object
● AlarmControl
BOOLEAN
TRUE: se muestran líneas de separación verticales.
FALSE: no se muestran líneas de separación verticales.
VerticalScrollBarPosition (RT Professional)
Descripción
Define el desplazamiento vertical de la barra de desplazamiento de la imagen en una ventana
de imagen con barras de desplazamiento o retorna el valor.
de las barras de desplazamiento. Si desea representar la imagen recortada en la que las
barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en el borde
superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen de esta
área.
Sintaxis
Object.VerticalScrollBarPosition[=Int32]

Object
● Screenwindow
Int32
Opcional. Valor o constante que determina el desplazamiento de la barra de desplazamiento
vertical.
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.
Sintaxis
Object.ViewOnly[=BOOLEAN]
Object
● SmartClientView
BOOLEAN
Opcional. TRUE si el visor Sm@rtClient sólo debe utilizarse para la monitorización a distancia.
Visible (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto indicado es visible.
Sintaxis
Object.Visible[=BOOLEAN]

Object
● AlarmControl
● AlarmView
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline

● RangeLabelView
● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
● S7GraphOverview
BOOLEAN
Opcional. TRUE si el objeto es visible.

Warning (RT Professional)
Descripción
Define a partir de qué porcentaje de memoria ocupada se emite 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 emite una advertencia.
WarningColor (RT Professional)
Descripción
Determina el color en el que se representa 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.

Observaciones
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":
WarningLowerLimitColor (RT Professional)
Descripción
Determina 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
Los siguientes valores se determinan por medio de las propiedades "WarningUpperLimit",
"WarningUpperLimitColor" y "WarningUpperLimitRelative":
● Valor límite
WarningLowerLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite "WarningLowerLimit".
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
WarningLowerLimitRelative (RT Professional)
Descripción
Determina si el valor límite inferior "WarningLowerLimit" se evalúa en porcentaje o de forma
absoluta.
Sintaxis
Object.WarningLowerLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "WarningLowerLimit" se evalúa en porcentaje.
FALSE: el valor límite inferior "WarningLowerLimit" se evalúa de forma absoluta.
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
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.

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
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".
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.
WarningUpperLimitColor (RT Professional)
Descripción
Define el color del límite de advertencia inferior.
La propiedad "WarningUpperLimitEnabled" debe tener el valor TRUE si el color de la barra
debe cambiar al alcanzarse el valor límite.
Sintaxis
Object.WarningUpperLimitColor[=Color]
Object
● Bar
Color
Opcional. Valor o constante que define el color para el valor límite superior.
Observaciones
WarningUpperLimitEnabled (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si se vigila el valor límite superior.
Sintaxis
Object.WarningUpperLimitEnabled[=BOOLEAN]

Object
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior.
WarningUpperLimitRelative (RT Professional)
Descripción
Determina si el valor límite inferior "WarningUpperLimit" se evalúa en porcentaje o de forma
absoluta.
Sintaxis
Object.WarningUpperLimitRelative[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE cuando se evalúa el valor límite inferior "WarningUpperLimit" en porcentaje.
Width (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina el ancho del objeto en píxeles.
Sintaxis
Object.Width[=Int32]
Object
● AlarmControl
● AlarmView
● Bar

● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RangeLabelView
● RecipeView
● Rectangle

● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeTeeObject
● Tubepolyline
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
● S7GraphOverview
Int32
Opcional. Valor o constante que determina el ancho del objeto en píxeles.
WindowCloseEnabled (RT Professional)
Descripción
Indica si puede cerrarse una ventana en runtime.
Sintaxis
Object.WindowCloseEnabled[=BOOLEAN]

Object
● ScreenWindow
BOOLEAN
Opcional. TRUE cuando la ventana puede cerrarse en runtime.
WindowMaximizeEnabled (RT Professional)
Descripción
Devuelve si el objeto se puede maximizar en runtime.
Sintaxis
Object.WindowMaximizeEnabled[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
TRUE: el objeto se puede maximizar en runtime.
FALSE: el objeto no se puede maximizar en runtime.
WindowMovingEnabled (RT Professional)
Descripción
Devuelve si el objeto se puede desplazar en runtime.
Sintaxis
Object.WindowMovingEnabled[=BOOLEAN]

Object
● Screenwindow
BOOLEAN
TRUE: el objeto se puede desplazar en runtime.
FALSE: el objeto no se puede desplazar en runtime.
WindowOnTop (RT Professional)
Descripción
Devuelve si el objeto permanece siempre en primer plano en runtime.
Sintaxis
Object.WindowOnTop[=BOOLEAN]
Object
● Screenwindow
BOOLEAN
TRUE: el objeto permanece siempre en primer plano en runtime.
FALSE: el objeto no permanece siempre en primer plano en runtime.
WindowsContents (RT Professional)
Descripción
Devuelve el contenido de la ventana de aplicación. Sólo acceso de lectura.
Consulte también

WindowSizingEnabled (RT Professional)
Descripción
Indica si puede modificarse el tamaño del objeto señalado en runtime.
Sintaxis
Object.WindowSizingEnabled[=BOOLEAN]
Object
● ScreenWindow
BOOLEAN
Opcional. TRUE, si puede modificarse el tamaño del objeto señalado en runtime.
WindowsStyle (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Determina si el objeto se representa en el estilo general de Windows.
Sintaxis
Object.WindowsStyle[=BOOLEAN]
Object
● Button
● WindowSlider
● Switch
BOOLEAN
Opcional. TRUE cuando el objeto se representa en el estilo general de Windows.

3.5.5.15 Propiedades X-Z (Panels, Comfort Panels, RT Advanced, RT Professional)
XAxisAdd (RT Professional)
Descripción
Crea un nuevo eje X.
Sintaxis
Object.XAxisAdd[=STRING]
Object
STRING
Opcional. Valor o constante que ???
XAxisAlignment (RT Professional)
Descripción
Determina cómo se alineará el eje seleccionado.
Sintaxis
Object.XAxisAlignment[=AxisAlignment]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "FunctionTrendControl".
AxisAlignment

0 abajo El eje X seleccionado se mostrará debajo de la curva.
1 arriba El eje X seleccionado se mostrará sobre la curva.
XAxisAutoPrecisions (RT Professional)
Descripción

Sintaxis
Object.XAxisAutoPrecisions[=BOOLEAN]
Object
BOOLEAN
FALSE: el valor configurado en "Propiedades > Eje X > Formato > Decimales" en la ventana
de inspección tiene efecto.
XAxisAutoRange(i) (RT Professional)
Descripción
Establece si el rango de valores del eje X se determina automáticamente o mediante los
atributos "XAxisBegin(i)" y "XAxisEnd(i)".
Sintaxis
Object.XAxisAutoRange(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el rango de valores del eje X se determina automáticamente o mediante
los atributos "XAxisBegin(i)" y "XAxisEnd(i)".
XAxisBeginValue (RT Professional)
Descripción
Define el extremo inferior del rango de valores del eje X seleccionado.
Para configurar el valor, desactive la opción "Automático" en "Rango de valores".
Sintaxis
Object.XAxisBeginValue[=DOUBLE]

Object
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje X
seleccionado.
XAxisColor (RT Professional)
Descripción
Con este atributo se define el color utilizado para el eje X común.
Sintaxis
Object.XAxisColor[=Color]
Object
Color
Valor o constante que establece el color utilizado del eje X común.
Observaciones
XAxisCount (RT Professional)
Descripción
Determina el número de ejes X.
Sintaxis
Object.XAxisCount[=Int32]

Object
Int32
Opcional. Valor o constante que determina el número de ejes X.
XAxisEndValue (RT Professional)
Descripción
Define el extremo superior del rango de valores del eje X seleccionado.
Sintaxis
Object.XAxisEndValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje X
seleccionado.
XAxisExponentialFormat (RT Professional)
Descripción
Determina si los valores del eje seleccionado se mostrarán en notación exponencial.
Sintaxis
Object.XAxisExponentialFormat[=BOOLEAN]
Object

BOOLEAN
FALSE: los valores no se muestran en representación exponencial.
XAxisIndex (RT Professional)
Descripción
Hace referencia a un eje X configurado. Esta propiedad permite asignar los valores de otras
propiedades a un determinado eje X.
Los valores válidos para "XAxisIndex" se encuentran entre 0 y "XAxisCount" menos 1. La
propiedad "ToolbarButtonCount" indica el número de ejes X configurados.
Sintaxis
Object.XAxisIndex[=Int32]
Object
Int32
Opcional. Valor o constante que establece el número del eje X seleccionado.
XAxisInTrendColor (RT Professional)
Descripción
Determina si se debe mostrar el eje seleccionado en la ventana de curvas. Si se muestran
varias curvas en la ventana de curvas, se utilizará el color de la primera curva. La secuencia
de las curvas se define en las propiedades de "Curvas".
Sintaxis
Object.XAxisInTrendColor[=BOOLEAN]
Object

BOOLEAN
TRUE: el eje seleccionado se mostrará en el color de la curva. La configuración del campo
"Color" no tendrá efecto.
FALSE: el eje seleccionado se mostrará en el color configurado en el campo "Color".
XAxisLabel(i) (RT Professional)
Descripción
Determina, en función del valor de "XAxisMode(i)", la denominación del eje X de una curva
referenciada por medio de "CurrentCurveIndex".
Sintaxis
Object.XAxisLabel(i)[=STRING]
Object
STRING
Opcional. Valor o constante que determina la denominación del eje X de una curva
referenciada por medio de "CurrentCurveIndex".
XAxisName (RT Professional)
Descripción
Especifica el nombre del eje seleccionado.
Sintaxis
Object.XAxisName[=STRING]
Object
STRING
Opcional. Valor o constante que define el nombre del eje seleccionado.

XAxisPrecisions (RT Professional)
Descripción
Determina con cuántos decimales se mostrarán los valores del eje X seleccionado.
Para introducir el valor, desactive la opción "Automático" en "Formato".
Sintaxis
Object.XAxisPrecisions[=Int16]
Object
Int16
Opcional. Valor o constante que determina el número de decimales.
XAxisRemove (RT Professional)
Descripción
Elimina el eje seleccionado de la lista.
Sintaxis
Object.XAxisRemove[=STRING]
Object
STRING
Opcional. Valor o constante que determina el eje que ha de eliminarse de la lista.
XAxisRepos (RT Professional)
Descripción
Define la secuencia de los ejes. La secuencia en la lista determina en runtime la posición del
eje en el visor de curvas. Si la orientación es la misma y el eje se encuentra en la parte superior
de la lista, se mostrará en una posición alejada de la curva.

Sintaxis
Object.XAxisRepos[=Int32]
Object
Int32
Opcional. Valor o constante que determina la secuencia de los ejes ???
XAxisScalingType(i) (RT Professional)
Descripción
Establece el tipo de escala para el eje X. La indicación se evaluará o no en función del valor
del atributo "XAxisMode(i)".
Sintaxis
Object.XAxisScalingType(i)[=AxisScalingType]
Object
AxisScalingType
hmiBarScalingLinear (0): escala lineal del eje.
hmiBarScalingLogarithmic (1): escala logarítmica del eje
hmiBarScalingNegativeLogarithmic (2): escala logarítmica negativa del eje
Observaciones
XAxisTrendWindow (RT Professional)
Descripción
Determina en qué ventana de curvas se utilizará el eje seleccionado. Las ventanas de curvas
disponibles se definen en las propiedades de "Curvas".

Sintaxis
Object.XAxisTrendWindow[=STRING]
Object
STRING
Opcional. Valor o constante que indica el nombre de la ventana de curvas.
XAxisVisible (RT Professional)
Descripción
En esta lista se mostrarán los ejes que haya creado.
Active en la lista los ejes que quiera mostrar en los visores de curvas.
Haga clic sobre un eje de la lista para ajustar las propiedades y asignar el eje a un visor de
curvas.
Sintaxis
Object.XAxisVisible[=BOOLEAN]
Object
BOOLEAN
Opcional. Determina si se muestra el eje X.
YAxisAdd (RT Professional)
Descripción
Crea un nuevo eje Y.
Sintaxis
Object.YAxisAdd[=STRING]

Object
STRING
Opcional. Valor o constante que determina ???.
YAxisAlignment (RT Professional)
Descripción
Determina cómo se alineará el eje seleccionado.
Sintaxis
Object.YAxisAlignment[=AxisAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la especificación "FunctionTrendControl".
AxisAlignment

0 izquierda El eje Y seleccionado se mostrará a la izquierda de la curva.
1 derecha El eje Y seleccionado se mostrará a la derecha de la curva.
YAxisAutoPrecisions (RT Professional)
Descripción
Sintaxis
Object.YAxisAutoPrecisions[=BOOLEAN]
Object
BOOLEAN

FALSE: el valor configurado en "Propiedades > Eje Y > Formato > Decimales" en la ventana
de inspección tiene efecto.
YAxisAutoRange (RT Professional)
Descripción
Determina si el rango de valores del eje Y seleccionado se determinará automáticamente.
Sintaxis
Object.YAxisAutoRange[=BOOLEAN]
Object
BOOLEAN
Valor Explicación
TRUE El rango de valores se determina automáticamente.
FALSE El rango de valores se determina mediante los valores configurados en los campos "desde"
y "hasta".
YAxisBeginValue (RT Professional)
Descripción
Define el extremo inferior del rango de valores del eje Y seleccionado.
Sintaxis
Object.YAxisBeginValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje Y
seleccionado.

YAxisColor (RT Professional)
Descripción
Define el color del eje seleccionado. Mediante el botón abra el cuadro de diálogo "Selección
de color" para seleccionar el color. El ajuste solo será efectivo si está desactivado el campo
"Del color de la curva".
Sintaxis
Object.YAxisColor[=Color]
Object
Color
Opcional. Valor o constante que define el color del eje seleccionado.
Observaciones
YAxisCount (RT Professional)
Descripción
Determina 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.

YAxisEndValue (RT Professional)
Descripción
Define el extremo superior del rango de valores del eje Y seleccionado.
Sintaxis
Object.YAxisEndValue[=DOUBLE]
Object
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje Y
seleccionado.
YAxisExponentialFormat (RT Professional)
Descripción
Determina si los valores del eje seleccionado se mostrarán en representación exponencial.
Sintaxis
Object.YAxisExponentialFormat[=BOOLEAN]
Object
BOOLEAN
FALSE: los valores no se muestran en notación exponencial.

YAxisIndex (RT Professional)
Descripción
Hace referencia a un eje Y configurado. Esta propiedad permite asignar los valores de otras
propiedades a un determinado eje Y.
Los valores válidos para "YAxisIndex" se encuentran entre 0 y "YAxisCount" menos 1. La
propiedad "ToolbarButtonCount" indica el número de ejes Y configurados.
Sintaxis
Object.YAxisIndex[=Int32]
Object
Int32
Opcional. Valor o constante que establece el número del eje Y seleccionado.
YAxisInTrendColor (RT Professional)
Descripción
Determina si se debe mostrar el eje seleccionado en la ventana de curvas. Si se muestran
varias curvas en la ventana de curvas, se utilizará el color de la primera curva. La secuencia
de las curvas se define en las propiedades de "Curvas".
Sintaxis
Object.YAxisInTrendColor[=BOOLEAN]
Object
BOOLEAN
TRUE: el eje seleccionado se mostrará en el color de la curva. La configuración del campo
"Color" no tendrá efecto.
FALSE: el eje seleccionado se mostrará en el color configurado en el campo "Color".

YAxisLabel (RT Professional)
Descripción
define el texto con el cual se titulará el eje seleccionado.
Sintaxis
Object.YAxisLabel[=STRING]
Object
STRING
Opcional. Valor o constante que establece el texto de la rotulación del eje Y seleccionado.
YAxisName (RT Professional)
Descripción
Especifica el nombre del eje seleccionado.
Sintaxis
Object.YAxisName[=STRING]
Object
STRING
Opcional. Valor o constante que establece el nombre del eje seleccionado.
YAxisPrecisions (RT Professional)
Descripción
Determina con cuántos decimales se mostrarán los valores del eje Y seleccionado.
Para introducir el valor, desactive la opción "Automático" en "Formato".

Sintaxis
Object.YAxisPrecisions[=Int16]
Object
Int16
Opcional. Valor o constante que determina el número de decimales.
YAxisRemove (RT Professional)
Descripción
Elimina el eje seleccionado de la lista.
Sintaxis
Object.YAxisRemove[=STRING]
Object
STRING
Opcional. Valor o constante que establece el nombre del eje seleccionado.
YAxisRename (RT Professional)
Descripción
Modifica el nombre del eje Y que será referenciado mediante la propiedad "YAxisIndex".
Sintaxis
Object.YAxisRename[=STRING]
Object

STRING
Opcional. Valor o constante que establece el nombre nuevo del eje Y seleccionado.
YAxisRepos (RT Professional)
Descripción
Modifica la secuencia de los ejes. "Arriba" y "Abajo" desplazan el eje seleccionado en la lista.
La secuencia en la lista determina en runtime la posición del eje en el visor de curvas. Si la
orientación es la misma y el eje se encuentra en la parte superior de la lista, se mostrará en
una posición alejada de la curva.
Sintaxis
Object.YAxisRepos[=Int32]
Object
Int32
Opcional. #####################################################.
YAxisScalingType (RT Professional)
Descripción
Determina cómo se escalará el eje Y.
Sintaxis
Object.YAxisScalingType[=AxisScalingType]
Object

AxisScalingType
Los siguientes ajustes están a disposición:
Valor Descripción
0 Lineal
1 Logarítmico
2 Logarítmico negativo
YAxisTrendWindow (RT Professional)
Descripción
Determina en qué ventana de curvas se utilizará el eje seleccionado. Las ventanas de curvas
disponibles se definen en las propiedades de "Curvas".
Sintaxis
Object.YAxisTrendWindow[=STRING]
Object
STRING
Opcional. Valor o constante que indica el nombre de la ventana de curvas.
YAxisVisible (RT Professional)
Descripción
En esta lista se mostrarán los ejes que haya creado.
Active en la lista los ejes que quiera mostrar en los visores de curvas.
Haga clic sobre un eje de la lista para ajustar las propiedades y asignar el eje a un visor de
curvas.
Sintaxis
Object.YAxisVisible[=BOOLEAN]

Object
BOOLEAN
Opcional. Determina si se muestra el eje Y seleccionado.
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".
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.
Zoom/Zoomfactor (RT Professional)
Descripción
Establece el factor de zoom de una imagen o ventana de imagen o lo lee.
Si el factor de zoom indicado es más pequeño que el valor mínimo, entonces el factor de zoom
automáticamente es ajustado al valor mínimo. Si el factor de zoom indicado es más grande
que el valor máximo, entonces el factor de zoom automáticamente es ajustado al valor
máximo.
El valor mínimo del factor de zoom es del 2 por ciento y el valor máximo del 800 por ciento.
Con el objeto Screen el factor de zoom se indica como un valor numérico y con el objeto
ventana de imagen como un porcentaje.
Zoom: factor de zoom de la imagen

Zoomfactor: factor de zoom de la ventana de imagen
Ejemplo
El siguiente ejemplo duplica el factor de zoom de la imagen actual:
'VBS97
HMIRuntime.ActiveScreen.Zoom = HMIRuntime.ActiveScreen.Zoom * 2
Consulte también
1 (Panels, Comfort Panels, RT Advanced, RT Professional)
AlarmLow (RT Professional)
Descripción
Define el valor límite inferior en el que se activa la alarma, o lo retorna.
El tipo de evaluación (porcentual o absoluta) se define con la propiedad "TypeAlarmLow".
Sintaxis
Object.AlarmLow[=REAL]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "Bar".
REAL
Valor para el límite inferior
Consulte también
Bar (Página 1353)
AlignmentTop (RT Professional)
Descripción
Define la alineación vertical del texto, o la devuelve. Rango de valores de 0 a 2.

Sintaxis
Object.AlignmentTopt[=VerticalAlignment]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "TextField", "IOField",
"SymbolicIOField", "Button", "RoundButton", "CheckBox", "OptionGroup".
VerticalAlignment
0: alineación izquierda
1: alineación centrada
2: alineación derecha
Application (RT Professional)
Descripción
Devuelve el contenido de la ventana de aplicación. Sólo acceso de lectura.
Consulte también
AssumeOnExit (RT Professional)
Descripción
Define si después de salir del campo de entrada (p. ej. con la tecla <TAB> o haciendo clic con
el ratón) se aplicará el texto introducido.
Sintaxis
Object.AssumeOnExit
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "IOField", "SymbolicIOField".
Consulte también

AssumeOnFull (RT Professional)
Descripción
Define si se sale automáticamente del campo de entrada una vez finalizada la introducción
de datos (es decir, cuando se ha introducido la cantidad predeterminada de caracteres) y se
aplican los datos introducidos.
Sintaxis
Object.AssumeOnFull[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "IOField", "SymbolicIOField".
BOOLEAN
TRUE: se aplican.
FALSE: no se aplican.
Consulte también
BackBorderWidth (RT Professional)
Descripción
Define el ancho del borde 3D en píxeles, o lo retorna. El valor del ancho depende del tamaño
del objeto.
Propiedad BackColor3 (RT Professional)
Descripción
Define el color del fondo de la barra, o lo retorna. Acceso de escritura y lectura LONG.

BackFlashColorOff (RT Professional)
Descripción
Define el color del fondo del objeto para el estado de intermitencia "Off", o lo retorna. Acceso
de escritura y lectura LONG.
BackFlashColorOn (RT Professional)
Descripción
Define el color del fondo del objeto para el estado de intermitencia "On", o lo retorna. Acceso
BorderFlashColorOff (RT Professional)
Descripción
Define el color de línea del objeto para el estado de intermitencia "Off", o lo retorna. Acceso
BorderFlashColorOn (RT Professional)
Descripción
Define el color de línea del objeto para el estado de intermitencia "On", o lo retorna. Acceso
de escritura y lectura LONG
BottomConnectedConnectionPointIndex (RT Professional)
Descripción
Indica el número de índice del punto conector inferior, o lo define.
Acceso de escritura y lectura Long

BottomConnectedObjectName (RT Professional)
Descripción
Indica el nombre de objeto del objeto que está acoplado en el punto conector inferior, o lo
define.
BoxAlignment (RT Professional)
Descripción
TRUE si los campos están dispuestos a la derecha. Acceso de escritura y lectura BOOLEAN.
BoxCount (RT Professional)
Descripción
Define la cantidad de campos, o los retorna. Margen de valores de 0 hasta 31.
BoxType (RT Professional)
Descripción
Define el tipo de campo, o lo retorna. Margen de valores de 0 hasta 2:
● 0: Impresión
● 1: Entrada
● 2: Campo de E/S
Button1Width (RT Professional)
Descripción
Define el ancho del botón 1 en píxeles, o lo retorna.
Cuando la propiedad SameSize está activada en TRUE, todos los botones tendrán el mismo
ancho.

Descripción
ancho.
Descripción
ancho.
Descripción
ancho.
ButtonColor (RT Professional)
Descripción
Define el color del control deslizante, o lo retorna. Acceso de escritura y lectura LONG.
ButtonCommand (RT Professional)
Descripción
Define la visualización en el visor de avisos.
Sintaxis
Object.ButtonCommand[=Long]
Object

Long
Opcional. Valor o constante que determina la visualización en el visor de avisos.
0x00000001; 1; Lista de avisos ·
0x00000002; 2; Lista de ficheros de corto plazo·
0x00000004; 4; Lista de ficheros de largo plazo·
0x00200000; 2097152; Lista de inhibiciones·
0x00000008; 8; Acuse de avisador central·
0x00000010; 16; Acuse individual·
0x00000020; 32; Acuse de grupo·
0x00000040; 64; Autoscroll·
0x00000080; 128; Diálogo de selección·
0x00000100; 256; Diálogo de bloqueos·
0x00000200; 512; Imprimir informe de avisos·
0x00000800; 2048; Acuse de emergencia·
0x00001000; 4096; Primer aviso·
0x00002000; 8192; Último aviso·
0x00004000; 16384; Aviso siguiente·
0x00008000; 32768; Aviso anterior·
0x00010000; 65536; Diálogo de texto informativo·
0x00020000; 131072; Diálogo de comentario·
0x00040000; 262144; Loop en Alarma·
0x00100000; 1048576; Imprimir vista actual·
0x00400000; 4194304; Bloquear/desbloquear aviso·
0x00800000; 8388608; Diálogo de ordenación·
0x01000000; 16777216; Diálogo de base de tiempo·
0x02000000; 33554432; Lista de aciertos
Consulte también
CheckAlarmHigh (RT Professional)
Descripción
TRUE si el valor límite "AlarmHigh" será supervisado. Acceso de escritura y lectura BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "AlarmHigh", "ColorAlarmHigh" y "TypeAlarmHigh".

CheckAlarmLow (RT Professional)
Descripción
TRUE si el valor límite "AlarmLow" será supervisado. Acceso de escritura y lectura BOOLEAN.
medio de las propiedades "AlarmLow", "ColorAlarmLow" y "TypeAlarmLow".
CheckLimitHigh4 (RT Professional)
Descripción
TRUE si el valor límite superior "Reserve 4" debe ser supervisado. Acceso de escritura y
lectura BOOLEAN.
medio de las propiedades "LimitHigh4", "ColorLimitHigh4" y "TypeLimitHigh4".
CheckLimitHigh5 (RT Professional)
Descripción
TRUE si el valor límite superior "Reserve 5" debe ser supervisado. Acceso de escritura y
lectura BOOLEAN.
medio de las propiedades "LimitHigh5", "ColorLimitHigh5" y "TypeLimitHigh5".
CheckLimitLow4 (RT Professional)
Descripción
TRUE si el valor límite inferior "Reserve 4" debe ser supervisado. Acceso de escritura y lectura
BOOLEAN.
medio de las propiedades "LimitLow4", "ColorLimitLow4" y "TypeLimitLow4".
CheckLimitLow5 (RT Professional)
Descripción
TRUE si el valor límite inferior "Reserve 5" debe ser supervisado. Acceso de escritura y lectura
BOOLEAN.
medio de las propiedades "LimitLow5", "ColorLimitLow5" y "TypeLimitLow5".

CheckToleranceHigh (RT Professional)
Descripción
TRUE si el valor límite "ToleranceHigh" será supervisado. Acceso de escritura y lectura
BOOLEAN.
medio de las propiedades "ToleranceHigh", "ColorToleranceHigh" y "TypeToleranceHigh" .
CheckToleranceLow (RT Professional)
Descripción
TRUE si el valor límite "ToleranceLow" será supervisado. Acceso de escritura y lectura
BOOLEAN.
medio de las propiedades "ToleranceLow", "ColorToleranceLow" y "TypeToleranceLow" .
CheckWarningHigh (RT Professional)
Descripción
TRUE si el valor límite "WarningHigh" será supervisado. Acceso de escritura y lectura
BOOLEAN.
medio de las propiedades "WarningHigh", "ColorWarningHigh" y "TypeWarningHigh".
CheckWarningLow (RT Professional)
Descripción
TRUE si el valor límite "WarningLow" será supervisado. Acceso de escritura y lectura
BOOLEAN.
medio de las propiedades "WarningLow", "ColorWarningLow" y "TypeWarningLow".
ClearOnNew (RT Professional)
Descripción
TRUE si la entrada del campo se borra en cuanto el campo E/S recibe el foco. Acceso de
escritura y lectura BOOLEAN.

ColorAlarmHigh (RT Professional)
Descripción
Define el color de barra para el valor límite "AlarmHigh", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckAlarmHigh" debe tener el valor TRUE si el color de barra debe modificarse
al alcanzarse el valor límite.
ColorAlarmLow (RT Professional)
Descripción
Define el color de barra para el valor límite "AlarmLow", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckAlarmLow" debe tener el valor TRUE si el color de barra debe modificarse
ColorLimitHigh4 (RT Professional)
Descripción
Define el color para el valor límite superior "Reserve 4", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitHigh4" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
ColorLimitHigh5 (RT Professional)
Descripción
Define el color para el valor límite superior "Reserve 5", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitHigh5" debe tener el valor TRUE si el color de barra debe
ColorLimitLow4 (RT Professional)
Descripción
Define el color para el valor límite inferior "Reserve 4", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitLow4" debe tener el valor TRUE si el color de barra debe modificarse

ColorLimitLow5 (RT Professional)
Descripción
Define el color para el valor límite inferior "Reserve 5", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitLow5" debe tener el valor TRUE si el color de barra debe modificarse
ColorToleranceHigh (RT Professional)
Descripción
Define el color para el valor límite superior "ToleranceHigh", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckToleranceHigh" debe tener el valor TRUE si el color de barra debe
ColorToleranceLow (RT Professional)
Descripción
Define el color para el valor límite inferior "ToleranceLow", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckToleranceLow" debe tener el valor TRUE si el color de barra debe
ColorWarningHigh (RT Professional)
Descripción
Define el color para el valor límite superior "WarningHigh", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckWarningHigh" debe tener el valor TRUE si el color de barra debe
ColorWarningLow (RT Professional)
Descripción
Define el color para el valor límite inferior "WarningLow", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckWarningLow" debe tener el valor TRUE si el color de barra debe

CountValueColumns (RT Professional)
Descripción
Devuelve el número de curvas o pares de columnas configurados (visibles o invisibles) de la
ventana.
Sintaxis
Object.CountValueColumns[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
Int
Opcional. Valor o constante que devuelve el número de curvas o pares de columnas
configurados (visibles o invisibles) de la ventana.
Consulte también
CurrentColumnIndex (RT Professional)
Descripción
Establece los ajustes que pueden asignarse a un determinado par de columnas. La propiedad
es evaluada por otras propiedades. Los valores válidos para el índice están comprendidos
entre 0 y -1. La propiedad "CountValueColumns" contiene el número de pares de columnas
que deben mostrarse.
Sintaxis
Object.CurrentColumnIndex[=Int]
Object
Int
Opcional. Valor o constante que establece los ajustes que pueden asignarse a un determinado
par de columnas.

Observaciones
La propiedad "NumItems" contiene el número de curvas/pares de columnas que deben
mostrarse.
Consulte también
DeleteEnable (RT Professional)
Descripción
Determina si puede borrarse el visor de recetas en runtime.
Sintaxis
Object.DeleteEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si puede borrarse el visor de recetas en runtime.
DrawAlwaysInsideFrame (RT Professional)
Descripción
Determina si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde o de forma simétrica respecto al borde.
Sintaxis
Object.DrawAlwaysInsideFrame[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Rectangle".
BOOLEAN
Opción. TRUE si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde.

Consulte también
DrawStylishButton (RT Professional)
Descripción
Determina si el botón se representa en el estilo general de Windows.
Sintaxis
Object.DrawStylishButton[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Button".
BOOLEAN
Opcional. TRUE si el botón se representa en el estilo general de Windows.
Consulte también
EditAtOnce (RT Professional)
Descripción
TRUE si al saltar el campo con la tecla <Tab> se puede ejecutar la entrada inmediata y sin
ninguna otra acción.Acceso de escritura y lectura BOOLEAN.
Exponent (RT Professional)
Descripción
TRUE si la representación de números se debe hacer con exponentes (p. ej."1,00e+000").
Acceso de escritura y lectura BOOLEAN.
FillColor (RT Professional)
Descripción
Define el color del tipo de relleno para el objeto, o lo devuelve.

Sintaxis
Object.FillColor[=LONG]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las apariencias "Line", "Polyline", "Ellipse",
"Circle", "EllipseSegment", "CircleSegment", "EllipticalArc", "CircularArc", "Rectangle",
"Polygon", "TextField", "IOField", "SymbolicIOField", "DateTimeField", "Button",
"Roundbutton", "Switch", "Bar", "StatusForce", "Clock", "Gauge", "Slider", "Checkbox".
Determinación del valor cromático

El color se representa en formato RGB (rojo, verde, azul). Para cada uno de los tres valores
RGB indique el valor decimal respectivo.
Ejemplo:
RGB(200, 150, 100)
Ejemplo
El siguiente ejemplo define de color azul el color de relleno de la imagen "ScreenWindow1":
'VBS73
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
objScreen.FillStyle = 131075
objScreen.FillColor = RGB(0, 0, 255)
Filling (RT Professional)
Descripción
TRUE si el objeto se puede rellenar con una línea de borde cerrada (es decir, p. ej. representa
el nivel de llenado de un tanque). Acceso de escritura y lectura BOOLEAN.
Ud. puede definir el nivel de llenado del objeto con la propiedad "FillingIndex".
FillingIndex (RT Professional)
Descripción
Define el valor % (referido a la altura del objeto) con el que se rellenará el objeto con línea de
borde cerrada.
El nivel de llenado se representará con el color de fondo actual. El fondo no rellenado es
transparente.

FillStyle2 (RT Professional)
Descripción
Define el tipo de relleno de la barra, o lo retorna.
FlashBackColor (RT Professional)
Descripción
TRUE si está activada la intermitencia del objeto. Acceso de escritura y lectura BOOLEAN.
FlashBorderColor (RT Professional)
Descripción
TRUE si está activada la intermitencia de la línea del objeto. Acceso de escritura y lectura
BOOLEAN.
FlashRate (RT Professional)
Descripción
Define la frecuencia de intermitencia, o la retorna. Margen de valores de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
FlashRateBackColor (RT Professional)
Descripción
Define la frecuencia de intermitencia para el fondo del objeto, o la retorna. Margen de valores
de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido

FormatType (RT Professional)
Descripción
Determina el tipo de datos del objeto indicado.
Sintaxis
Object.FormatType[=IOFieldDataFormat]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "IOField".
IOFieldDataFormat
hmiOutputFormatString ( 2): string
hmiOutputFormatDecimal ( 1): decimal
hmiOutputFormatHexadecimal ( 3): hexadecimal
hmiOutputFormatBinary ( 0): binario
hmiOutputFormatDate ( 4): fecha
hmiOutputFormatTime ( 5): hora
hmiOutputFormatDateTime ( 6): fecha y hora
Consulte también
GridBackColor (RT Professional)
Descripción
Establece el color de fondo para el visor de recetas en runtime.
Sintaxis
Object.GridBackColor[=Color]
Object
Color
Opcional. Valor o constante que establece el color de fondo para el visor de recetas en runtime.

GridForeColor (RT Professional)
Descripción
Establece el color de fuente para el visor de recetas.
Sintaxis
Object.GridForeColor[=Color]
Object
Color
Opcional. Valor o constante que establece el color de fuente para el visor de recetas.
Propiedad Hysteresis (RT Professional)
Descripción
TRUE si la visualización se debe realizar con histéresis. Acceso de escritura y lectura
BOOLEAN.
HysteresisRange (RT Professional)
Descripción
Define o devuelve la histéresis en tanto por ciento del valor de muestra.
La propiedad Hysteresis debe tener el valor TRUE, para que se pueda calcular la histéresis.
InsertEnable (RT Professional)
Descripción
Determina si pueden introducirse valores en el visor de recetas en runtime.
Sintaxis
Object.InsertEnable[=BOOLEAN]
Object

BOOLEAN
Opcional. TRUE si pueden introducirse valores en el visor de recetas en runtime.
ItemBorderBackColor (RT Professional)
Descripción
Define el color de fondo de las líneas de separación en la lista de selección del objeto Lista
de texto, o lo retorna. Acceso de escritura y lectura LONG. El color de fondo se puede ver
únicamente cuando se ha definido la propiedad ItemBorderStyle > 0.
ItemBorderColor (RT Professional)
Descripción
Define el color de las líneas de separación en la lista de selección del objeto Lista de texto, o
lo retorna. Acceso de escritura y lectura LONG.
ItemBorderWidth (RT Professional)
Descripción
Define en píxeles el grosor de las líneas de separación de la lista de selección del objeto Lista
de texto, o lo retorna.
Propiedad LeftComma (RT Professional)
Descripción
Define la cantidad de dígitos a la izquierda de la coma (0 hasta 20), o los retorna.
LimitHigh4 (RT Professional)
Descripción
Define el valor límite superior para "Reserve 4", o lo retorna.
La propiedad CheckLimitHigh4 debe estar activada en TRUE para que el valor límite "Reserve
4" pueda ser vigilado.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitHigh4.

LimitHigh5 (RT Professional)
Descripción
Define el valor límite superior para "Reserve 5", o lo retorna.
La propiedad CheckLimitHigh5 debe estar activada en TRUE para que el valor límite "Reserve
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitHigh5.
LimitLow4 (RT Professional)
Descripción
Define el valor límite inferior para "Reserve 4", o lo retorna.
La propiedad CheckLimitLow4 debe estar activada en TRUE para que el valor límite "Reserve
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitLow4.
LimitLow5 (RT Professional)
Descripción
Define el valor límite inferior para "Reserve 5", o lo retorna.
La propiedad CheckLimitLow5 debe estar activada en TRUE para que el valor límite "Reserve
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitLow5.
LimitMax (RT Professional)
Descripción
Define el valor límite superior como valor absoluto dependiendo del formato de datos, o lo
retorna.
Si el valor que se ha de visualizar sobrepasa el valor límite superior, él será marcado con una
secuencia de *** como si no fuera representable.
LimitMin (RT Professional)
Descripción
Define el valor límite inferior como valor absoluto dependiendo del formato de datos, o lo
retorna.
Si el valor que se ha de visualizar sobrepasa el valor límite superior, él será marcado con una
secuencia de *** como si no fuera representable.

LockStatus (RT Professional)
Descripción
TRUE si se debe visualizar una posición de medición bloqueada. Acceso de escritura y lectura
BOOLEAN.
LockText (RT Professional)
Descripción
Define la rotulación de los botones de comando para una posición de medición bloqueada.
La propiedad LockStatus debe tener el valor TRUE para que se pueda visualizar la rotulación.
LockTextColor (RT Professional)
Descripción
Define el color de la rotulación del botón de comando para una posición bloqueada de
medición, o lo retorna. Acceso de escritura y lectura LONG.
La propiedad LockStatus debe tener el valor TRUE para que se pueda visualizar el color de
fondo.
LongStrokesBold (RT Professional)
Descripción
TRUE si en la representación de la escala se deben visualizar en negrita las graduaciones
largas. Acceso de escritura y lectura BOOLEAN.
LongStrokesOnly (RT Professional)
Descripción
TRUE si en la representación de la escala se deben visualizar únicamente las graduaciones
largas. Acceso de escritura y lectura BOOLEAN.
LongStrokesSize (RT Professional)
Descripción
Determina si han de representarse solo las marcas grandes de la escala.

Sintaxis
Object.ShowLargeTicksOnly[=BOOLEAN]
Object
● Bar
BOOLEAN
Opcional. TRUE si se representan solo las marcas grandes de la escala.
LongStrokesTextEach (RT Professional)
Descripción
Retorna el valor que define las graduaciones que deberán ser rotuladas en la visualización
de la escala (1 = cada graduación, 2 = cada segunda graduación, etc.). Sólo acceso de lectura.
LowerLimitColor(i) (RT Professional)
Descripción
Establece el color que marca los valores de variable de la curva indicada situados por debajo
del valor de "LowerLimitValue(i)". El dato se evaluará o no dependiendo de la propiedad
"LowerLimitEnabled(i)".
Sintaxis
Object.LowerLimitColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
Color
Opcional. Valor o constante que establece el color que marca los valores de variable de la
curva indicada situados por debajo del valor de "LowerLimitValue(i)".
Observaciones

Consulte también
LowerLimitEnabled(i) (RT Professional)
Descripción
Determina si se utiliza el dato de "LowerLimitColor(i)" para marcar los valores de variable
situados por debajo del valor de "LowerLimitValue(i)".
Sintaxis
Object.LowerLimitEnabled(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se utiliza el dato de "LowerLimitColor(i)" para marcar los valores de variable
situados por debajo del valor de "LowerLimitValue(i)".
Observaciones
Consulte también
LowerLimitValue(i) (RT Professional)
Descripción
???Determina si los valores de variable situados por debajo del valor de "LowerLimitValue(i)"
se marcan con el color definido en "LowerLimitColor(i)". El dato se evaluará o no dependiendo
del valor del atributo "LowerLimitEnabled(i)".

Sintaxis
Object.LowerLimitValue(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que determina si los valores de variable situados por debajo del
valor de "LowerLimitValue(i)" se marcan con el color definido en "LowerLimitColor(i)".
Observaciones
Consulte también
Propiedad Marker (RT Professional)
Descripción
TRUE si se deben visualizar los valores límite como valor de escala. Acceso de escritura y
lectura BOOLEAN.
Propiedad MaximizeButton (RT Professional)
Descripción
TRUE si el objeto en Runtime se puede maximizar. Sólo acceso de lectura.
MCGUBackColorOff (RT Professional)
Descripción
Define el color del fondo para el estado de intermitencia "Off" para el estado "Desaparecido
no acusado", o lo retorna. Acceso de escritura y lectura LONG.

MCGUBackColorOn (RT Professional)
Descripción
Define el color del fondo para el estado de intermitencia "On" para el estado "Desaparecido
no acusado", o lo retorna. Acceso de escritura y lectura LONG.
MCGUBackFlash (RT Professional)
Descripción
TRUE si el fondo debe ser intermitente cuando un aviso desaparece sin acuse. Acceso de
MCGUTextColorOff (RT Professional)
Descripción
Define el color del texto para el estado de parpadeo "Off" en el estado "Desaparecido no
acusado", o lo devuelve. Acceso de escritura y lectura LONG.
MCGUTextColorOn (RT Professional)
Descripción
Define el color de fondo del texto para el estado de parpadeo "On" en el estado "Desaparecido
no acusado", o lo devuelve. Acceso de escritura y lectura LONG.
MCGUTextFlash (RT Professional)
Descripción
TRUE si la fuente debe ser intermitente cuando un aviso desaparece sin acuse. Acceso de
MCKOBackColorOff (RT Professional)
Descripción
Define el color del fondo para el estado de intermitencia "Off" para el estado "Aparecido", o lo
retorna. Acceso de escritura y lectura LONG.

MCKOBackColorOn (RT Professional)
Descripción
Define el color del fondo para el estado de intermitencia "On" para el estado "Aparecido", o lo
retorna. Acceso de escritura y lectura LONG.
MCKOBackFlash (RT Professional)
Descripción
TRUE si el fondo debe ser intermitente cuando aparece un aviso. Acceso de escritura y lectura
BOOLEAN.
MCKOTextColorOff (RT Professional)
Descripción
Define el color del texto para el estado de parpadeo "Off" en el estado "Aparecido", o lo
devuelve. Acceso de escritura y lectura LONG.
MCKOTextColorOn (RT Professional)
Descripción
Define el color de fondo del texto para el estado de parpadeo "On" en el estado "Aparecido",
o lo devuelve. Acceso de escritura y lectura LONG.
MCKOTextFlash (RT Professional)
Descripción
TRUE si la fuente debe ser intermitente cuando aparece un aviso. Acceso de escritura y lectura
BOOLEAN.
MCKQBackColorOff (RT Professional)
Descripción
Define el color del fondo para el estado de intermitencia "Off" para el estado "Desaparecido
acusado", o lo retorna. Acceso de escritura y lectura LONG.

MCKQBackColorOn (RT Professional)
Descripción
Define el color del fondo para el estado de intermitencia "On" para el estado "Desaparecido
acusado", o lo retorna. Acceso de escritura y lectura LONG.
MCKQBackFlash (RT Professional)
Descripción
TRUE si el fondo debe ser intermitente cuando un aviso desaparece con acuse. Acceso de
MCKQTextColorOff (RT Professional)
Descripción
Define el color del texto para el estado de parpadeo "Off" en el estado "Desaparecido
MCKQTextColorOn (RT Professional)
Descripción
Define el color de fondo del texto para el estado de parpadeo "On" en el estado "Desaparecido
MCKQTextFlash (RT Professional)
Descripción
TRUE si la fuente debe ser intermitente cuando un aviso desaparece con acuse. Acceso de
MCText (RT Professional)
Descripción
Define la rotulación para cada clase de aviso, o la retorna.

MessageClass (RT Professional)
Descripción
Define cada violación del límite (alarma High, alarma Low, advertencia High, advertencia
Low, ...) para la que se deben configurar los ajustes "Texto de visualización", "Aparecido -",
"Aparecido acusado -" y "Desaparecido no acusado -".
NumberLines (RT Professional)
Descripción
Define la cantidad de líneas que debe tener la lista de selección para el objeto Lista de texto,
o retorna el valor. Si la cantidad del texto proyectado es mayor a este valor, entonces la lista
de selección tendrá una barra de desplazamiento vertical.
ObjectName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Retorna el nombre del objeto indicado.
Sintaxis
Object.ObjectName
Object
Obligatorio. Objeto del tipo "ScreenItem". Ésta es una propiedad estándar del objeto
ScreenItem, por lo que está disponible en todas las apariencias.
Consulte también
Line (Página 1422)


Bar (Página 1353)
OnTop (RT Professional)
Descripción
TRUE si el objeto en Runtime permanece siempre en el primer plano. Sólo acceso de lectura.

Propiedad OperationMessage (RT Professional)
Descripción
TRUE si en un manejo exitoso se debe editar un aviso. Acceso de escritura y lectura
BOOLEAN.
El manejo se envía entonces al sistema de avisos y se archiva. Por medio del sistema de
aviso se puede emitir un aviso, por ejemplo, en una línea de avisos.
Particularidad del campo E/S, lista de textos y deslizador

La razón del manejo se puede introducir únicamente cuando la propiedad "OperationReport"
ha sido activada en TRUE.
Propiedad OperationReport (RT Professional)
Descripción
TRUE también si se debe protocolizar la razón de un manejo. Acceso de escritura y lectura
BOOLEAN.
En Runtime, durante la manipulación de un objeto, aparece un cuadro de diálogo, en el cual
el usuario puede introducir el motivo de la manipulación en forma de texto.El manejo es
enviado al sistema de aviso y será archivado.
Orientation (RT Professional)
Descripción
Establece la dirección del texto del objeto indicado.
Sintaxis
Object.Orientation[=TextOrientation]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "TextField", "IOField",
"SymbolicIOField", "Button", "Switch", "Bar", "OnlineTrendControl", "FunctionTrendControl",
"Checkbox", "OptionGroup" o "WindowSlider".
TextOrientation
hmiTextHorizontal ( 0): el texto se muestra horizontalmente.
hmiTextRotated90Degree (-1): el texto se muestra verticalmente y alineado a la izquierda.
hmiTextRotated270Degree ( 1): el texto se muestra verticalmente y alineado a la derecha.

Consulte también
Bar (Página 1353)
OutputFormat (RT Professional)
Descripción
Retorna el valor para la representación del valor de salida. La representación depende del
formato de datos. Sólo acceso de lectura.
OutputValue (RT Professional)
Descripción
Define el valor predeterminado para el valor que se va a visualizar, o lo retorna.
Este valor se utiliza en Runtime cuando al iniciarse la imagen no está anexada o actualizada
la variable perteneciente.
PersistentRTAuthorization (RT Professional)
Descripción
Establece el permiso de operación necesario para poder modificar el ajuste de la persistencia
en runtime. El valor que debe introducirse corresponde al número que posee el permiso
deseado en la administración de usuarios. El dato se evaluará o no dependiendo del valor de
la propiedad "AllowPersistance". Esto no se aplica al visor de avisos.
Sintaxis
Object.PersistentRTAuthorization[=RtAuthorization]

Object
"OnlineTrendControl", "FunctionTrendControl" o "OnlineTableControl".
RtAuthorization
Opcional. Valor o constante que establece el permiso de operación para poder modificar el
ajuste de la persistencia.
Consulte también
PersistentRuntime (RT Professional)
Descripción
Determina si los ajustes modificados de la ventana también se conservan tras un cambio de
imagen.
Sintaxis
Object.PersistentRuntime[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los ajustes modificados de la ventana también se conservan tras un cambio
de imagen.
Observaciones
La propiedad "AllowPersistance" determina si el dato se evalúa.
Consulte también

PersistentRuntimeAuthorization (RT Professional)
Descripción
Establece el permiso de acceso para modificar el ajuste de la persistencia en runtime. El valor
que debe introducirse corresponde al número que posee el permiso deseado en la
administración de usuarios.
Sintaxis
Object.PersistentRuntimeAuthorization[=HmiRTAuthorization]
Object
HmiRTAuthorization
Opcional. Valor o constante que establece el permiso de acceso para modificar el ajuste de
la persistencia en runtime.
Observaciones
La propiedad "AllowPersistance" determina si el dato se evalúa. Esto no se aplica al visor de
avisos.
Consulte también
PicDeactReferenced (RT Professional)
Descripción
TRUE si se guarda la imagen asignada para el estado "Desactivado" en el objeto
RoundButton. De no ser así se guardará únicamente la referencia del objeto perteneciente.
Sólo acceso de lectura.

PicDeactTransparent (RT Professional)
Descripción
Define cuál color del objeto Bitmap (.bmp, .dib) asignado para el estado "Desactivado" deberá
ser ajustado en "transparent", o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicDeactUseTransColor" tiene
el valor TRUE.
PicDeactUseTransColor (RT Professional)
Descripción
TRUE si se debe utilizar para el estado "Desactivado" el color transparente definido con la
propiedad "PicDeactTransparent". Acceso de escritura y lectura BOOLEAN.
PicDownTransparent (RT Professional)
Descripción
Define cuál color del objeto Bitmap (.bmp, .dib) asignado para el estado "On" deberá ser
ajustado en "transparent", o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicDownUseTransColor" tiene
el valor TRUE.
PicDownUseTransColor (RT Professional)
Descripción
TRUE si se debe utilizar para el estado "On" el color transparente definido con la propiedad
"PicDownTransparent". Acceso de escritura y lectura BOOLEAN.
PicTransColor (RT Professional)
Descripción
Define cuál color del objeto Bitmap asignado (.bmp, .dib) deberá ser definido en "transparent"
o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicUseTransColor" tiene el
valor TRUE.

PictureName (RT Professional)
Descripción
Establece la ruta y nombre de fichero de la imagen de fondo o los devuelve. Acceso de
escritura y lectura LONG.
PictureUp (RT Professional)
Descripción
Define la imagen que se visualiza en el estado "Off", o retorna el nombre de la imagen.
La imagen (*.BMP o *.DIB) debe estar en la carpeta "GraCS" del proyecto actual, para que
pueda ser insertada.
PicUpTransparent (RT Professional)
Descripción
Define cuál color del objeto Bitmap (.bmp, .dib) asignado para el estado "Off" deberá ser
ajustado en "transparent", o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicUpUseTransColor" tiene
el valor TRUE.
PicUpUseTransColor (RT Professional)
Descripción
TRUE si se debe utilizar para el estado "Off" el color transparente definido con la propiedad
"PicUpTransparent". Acceso de escritura y lectura BOOLEAN.
PicUseTransColor (RT Professional)
Descripción
TRUE si se debe utilizar para el estado "Desactivado" el color transparente definido con la
propiedad "PicDeactTransparent". Acceso de escritura y lectura BOOLEAN.
Pinned (RT Professional)
Descripción
Determina si la visualización de la ventana de imagen en Runtime depende de la imagen de
proceso en la que se proyectó dicha ventana.

PointCount (RT Professional)
Descripción
Define la cantidad de puntos de esquina, o los retorna. Cada punto de esquina tiene
coordenadas de posición y será identificado por medio de un índice.
PrintJobName (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Define el trabajo de impresión que activa la función de impresión botón "Imprimir" de la barra
de herramientas. El trabajo de impresión recomendado para Control esta preconfigurado.
Mediante el botón de selección se abre el cuadro de diálogo "Seleccionar trabajo de impresión"
para la selección de un trabajo de impresión.
Sintaxis
Object.PrintJobName]
Object
"FunctionTrendControl", "OnlineTableControl", "OnlineTrendControl", "TrendRulerControl",
"UserArchiveControl".
Consulte también
PrintVisibleColumnsOnly (RT Professional)
Descripción
Determina si solo aparecen las columnas actualmente visibles en la impresión rápida.
Sintaxis
Object.PrintVisibleColumnsOnly[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si solo aparecen las columnas actualmente visibles en la impresión rápida.

Process (RT Professional)
Descripción
Define el valor predeterminado para el valor que se va a visualizar, o lo retorna.
Este valor se utiliza en Runtime cuando al iniciarse la imagen no está anexada o actualizada
la variable perteneciente.
ReadOnly (RT Professional)
Descripción
Determina si el Control tiene acceso de lectura y escritura en runtime.
Sintaxis
Object.ReadOnly[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el Control tiene acceso de lectura y escritura en runtime.
ReferenceRotationLeft (RT Professional)
Descripción
Define la coordenada x del punto de referencia alrededor de la cual se debe girar el objeto en
Runtime, o la retorna.
El valor de la coordenada x es relativo al ancho del objeto. Indique en porcentaje el valor
partiendo del canto izquierdo del rectángulo que circunda al objeto.
ReferenceRotationTop (RT Professional)
Descripción
Define la coordenada y del punto de referencia alrededor de la cual se debe girar el objeto en
Runtime, o la retorna.
El valor de la coordenada y es relativo a la altura del objeto. Indique en porcentaje el valor
partiendo del canto superior del rectángulo que circunda al objeto.

Propiedad Relevant (RT Professional)
Descripción
TRUE si se considera el objeto para la formación del indicador de grupo. Acceso de escritura
y lectura BOOLEAN.
Propiedad RightComma (RT Professional)
Descripción
Define la cantidad de dígitos a la derecha de la coma (0 hasta 20), o los retorna.
RTPersistencePasswordLevel (RT Professional)
Descripción
Muestra la autorización para la configuración online. A través del botón de selección puede
modificar el permiso. Los permisos se configuran en la administración de usuarios.
Sintaxis
Object.RTPersistencePasswordLevel
Object
Necesario. Objeto del tipo "ScreenItem" con las especificaciones "AlarmControl",
"OnlineTrendControl", "TrendRulerControl", "UserArchiveControl" u "OnlineTableControl"
(Runtime Professional) o bien "HMITrendView" (Runtime Advanced).
Consulte también
SameSize (RT Professional)
Descripción
TRUE si los cuatro botones en el objeto GroupDisplay tienen el mismo tamaño. Acceso de

ScaleTicks (RT Professional)
Descripción
Define la cantidad de segmentos en los que se subdividirá la barra por medio de las
graduaciones grandes de la escala:
0-100: El objeto se puede subdividir en máximo 100 segmentos
= 0: Se definirá automáticamente la cantidad óptima de segmentos
ScrollBars (RT Professional)
Descripción
TRUE si el objeto en Runtime tiene barras de desplazamiento. Sólo acceso de lectura.
ScrollPositionX (RT Professional)
Descripción
Define el desplazamiento horizontal de la barra de desplazamiento de la imagen en una
ventana de imagen con barras de desplazamiento o retorna el valor.
de las barras de desplazamiento de la imagen. Si desea representar la imagen recortada en
la que las barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en
el borde superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen
de esta área.
ScrollPositionY (RT Professional)
Descripción
Define el desplazamiento vertical de la barra de desplazamiento de la imagen en una ventana
de imagen con barras de desplazamiento o retorna el valor.
de las barras de desplazamiento de la imagen. Si desea representar la imagen recortada en
la que las barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en
el borde superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen
de esta área.
SelBGColor (RT Professional)
Descripción
Define el color de fondo para la entrada seleccionada en el objeto Lista de texto, o lo retorna.
Acceso de escritura y lectura LONG.

SelectionMode (RT Professional)
Descripción
Define si se puede seleccionar y cómo se puede seleccionar una línea de avisos.
.
Sintaxis
Object.SelectionMode[=Mode]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "MessageView".
Mode
0 - NoSelection: Evita la selección de un aviso. Un acuse repercute siempre en el aviso
pendiente más antiguo.
1 - Cell: Permite la selección de campos en una línea de avisos. Un acuse repercute siempre
en el aviso seleccionado.
2 - Line: Permite la selección de una línea de avisos. Un acuse repercute siempre en el aviso
seleccionado.
SelectionMode (RT Professional)
Descripción
Determina si se puede seleccionar y cómo se puede seleccionar una línea de avisos.
Sintaxis
Object.SelectionMode[=AlarmViewAdvancedSelectionMode]
Object
AlarmViewAdvancedSelectionMode
hmiAlarmViewAdvancedSelectionModeNone ( 0): evita la selección de un aviso. Un acuse
repercute siempre en el aviso pendiente más antiguo.
hmiAlarmViewAdvancedSelectionModeCell ( 1): permite la selección de campos en la línea
de avisos. Un acuse repercute siempre en el aviso seleccionado.
hmiAlarmViewAdvancedSelectionModeLine ( 2): permite la selección de una línea de avisos.
Un acuse repercute siempre en el aviso seleccionado.

Consulte también
SelTextColor (RT Professional)
Descripción
Define el color de texto de la entrada seleccionada del objeto Lista de texto, o lo retorna.
Acceso de escritura y lectura LONG.
ShortenCellText (RT Professional)
Descripción
Determina si los contenidos de los campos de una línea de avisos se acortan cuando el ancho
Sintaxis
Object.ShortenCellText[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los contenidos de los campos de una línea de avisos se acortan cuando
el ancho de columna es demasiado pequeño.
Consulte también
ShortenColumnHeaderText (RT Professional)
Descripción
Determina si los contenidos de los campos de una barra de título deben acortarse cuando el
ancho de columna es demasiado pequeño.
Sintaxis
Object.ShortenColumnHeaderText[=BOOLEAN]

Object
BOOLEAN
Opcional. TRUE si los contenidos de los campos de una barra de título deben acortarse
cuando el ancho de columna es demasiado pequeño.
Consulte también
ShowVerticalGridlines (RT Professional)
Descripción
Determina si las columnas del visor de avisos quedan separadas por líneas verticales.
Sintaxis
Object.ShowVerticalGridlines[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si las columnas del visor de avisos quedan separadas por líneas verticales.
Consulte también
ShowXValuesExponential(i) (RT Professional)
Descripción
Determina si un valor de la coordenada X se muestra en notación exponencial. El dato se
evaluará o no dependiendo del valor de la propiedad "XAxisMode(i)".
Sintaxis
Object.ShowXValuesExponential(i)[=BOOLEAN]

Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si un valor de la coordenada X se muestra en notación exponencial.
Observaciones
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada X de la
medida.
Consulte también
ShowYValuesExponential(i) (RT Professional)
Descripción
Determina si un valor de la coordenada Y se muestra en notación exponencial. El dato se
evaluará o no dependiendo del valor de la propiedad "XAxisMode(i)".
Sintaxis
Object.ShowYValuesExponential(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si un valor de la coordenada Y se muestra en notación exponencial.
Observaciones
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada Y de la
medida.
Consulte también

Propiedad SignificantMask (RT Professional)
Descripción
Se necesita en Runtime para la representación de la clase de aviso activa con la prioridad
más alta.
El valor de la propiedad SignificantMask representa un valor de salida interno del sistema y
no requiere ninguna configuración específica por el usuario. La actualización se realiza en
Runtime haciendo clic en el objeto.
SortByTimeEnable (RT Advanced)
Descripción
Determina si puede modificarse el sentido de clasificación en runtime.
Sintaxis
Object.SortByTimeEnable[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si puede modificarse el sentido de clasificación en runtime.
Consulte también
SortOnColumnHeaderClick (RT Professional)
Descripción
Determina si los bloques de aviso pueden clasificarse por el título de las columnas de los
bloques de aviso.
Sintaxis
Object.SortOnColumnHeaderClick[=BOOLEAN]
Object

BOOLEAN
Opcional. TRUE, si los bloques de aviso pueden clasificarse por el título de las columnas de
los bloques de aviso.
Consulte también
SortTimeAscending (Panels, Comfort Panels, RT Advanced)
Descripción
Determina si el último aviso que se ha recibido se debe visualizar en el lado superior del objeto
"MessageView" (orden ascendente).
Sintaxis
Object.SortTimeAscending [= BOOLEAN]
Object
Obligatorio. Objeto del tipo "MessageView".
BOOLEAN
Opcional. TRUE si se debe visualizar el último aviso que se ha recibido.
SortTimeEnable (Panels, Comfort Panels, RT Advanced)
Descripción
Determina si el orden de los avisos se puede modificar según la hora en el objeto
"MessageView".
Sintaxis
Object.SortTimeEnable [= BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el operador puede cambiar el orden en el equipo.

StartPointLeft (RT Professional)
Descripción
Determina la distancia horizontal desde el borde izquierdo de la imagen en píxeles.
Sintaxis
Object.StartPointLeft[=Int]
Object
Obligatorio. Un objeto del tipo ""ScreenItem" con la especificación "Line"".
Int
Opcional. Un valor que determina la distancia horizontal del punto inicial desde el borde
izquierdo de la imagen en píxeles.
Consulte también
TagName (RT Professional)
Descripción
La propiedad "Index" hace referencia a una curva. "TagName"define la variable que está
vinculada a esta curva. La indicación se realiza en la forma "Nombre de fichero/de variable"
para la representación de variables de un fichero de valores del proceso, o "Nombre de
variable" para la representación de una variable interna o externa que no se va a guardar en
un fichero.
TimeAxisShowGridLines(i) (RT Professional)
Descripción
Determina si la ventana de curvas se representa con líneas de retícula paralelas al eje x.

Sintaxis
Object.TimeAxisShowGridLines(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "OnlineTrend".
BOOLEAN
Opcional. TRUE si la ventana de curvas se representa con líneas de retícula paralelas al eje
x.
Observaciones
La distancia entre dos líneas de retícula puede modificarse por medio de la propiedad
"TimeAxisGridLineInterval(i)"..
Consulte también
TimeColumnFormat(i) (RT Professional)
Descripción
Define el formato de las columnas de tiempos para el par de columnas especificado. El
parámetro i indica el número del par de columnas.
Sintaxis
Object.TimeColumnFormat(i)[=TimeFormat]
Object
TimeFormat
( 0): los datos tienen el formato hh:mm
( 1): los datos tienen el formato hh:mm:ss
( 2): los datos tienen el formato hh:mm:ss.ms
( 3): los datos tienen el formato hh:mm (horas enteras)
( 4): los datos tienen el formato hh:mm:ss (minutos enteros)
( 5): los datos tienen el formato hh:mm:ss.ms (segundos enteros)
( 6): los datos tienen el formato dd_mm_yy_hh_mm
( 7): los datos tienen el formato dd_mm_yy_hh_mm (hora entera)

( 8): los datos tienen el formato dd_mm_yy

( 9): los datos tienen el formato dd_mm_yy (día entero)
Consulte también
TitleBackColor (RT Professional)
Descripción
Indica el color de fondo del título de la tabla para el estado seleccionado. Con el botón se abre
Titleline (RT Professional)
Descripción
TRUE si el control posee una barra de título y se puede desplazar en Runtime. Acceso de
Propiedad ToleranceHigh (RT Professional)
Descripción
Define el valor límite para "Toleranz high", o lo retorna.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad
TypeToleranceHigh.
La supervisión del valor límite será efectiva únicamente cuando la propiedad
CheckToleranceHigh está activada en "True".
Propiedad ToleranceLow (RT Professional)
Descripción
Define el valor límite para "Toleranz low", o lo retorna.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeToleranceLow.
La supervisión del valor límite será efectiva únicamente cuando la propiedad
CheckToleranceLow está activada en "True".

TopConnectedConnectionPointIndex (RT Professional)
Descripción
Indica el número de índice del punto conector superior o lo establece.
TopConnectedObjectName (RT Professional)
Descripción
Indica el nombre de objeto del objeto que está acoplado en el punto conector superior, o lo
define.
Trend (RT Professional)
Descripción
TRUE si la tendencia (ascendente o descendente) del valor de medición a ser supervisado
debe ser visualizado con una pequeña flecha. Acceso de escritura y lectura BOOLEAN.
TrendTag (RT Professional)
Descripción
Determina qué variable está vinculada a la curva indicada.
Los valores se indican en la forma "Nombre de fichero\Nombre de variable" para la
representación de variables de un fichero de valores del proceso, o bien en la forma "Nombre
de variable" para la representación de una variable interna o externa que no está guardada
en un fichero.
Sintaxis
Object.TrendTag[=HmiTag]
Object
HmiTag
Opcional. Un valor o una constante que determina la variable que está vinculada a la curva
indicada.

Observaciones
Consulte también
TypeAlarmHigh (RT Professional)
Descripción
TRUE si el valor límite superior en el que se activa la alarma se evalúa porcentualmente.
FALSE si la evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura
BOOLEAN.
TypeAlarmLow (RT Professional)
Descripción
TRUE si el valor límite inferior en el que se activa la alarma se evalúa porcentualmente. FALSE
si la evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
TypeLimitHigh4 (RT Professional)
Descripción
TRUE si el valor límite superior "Reserve 4" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
TypeLimitHigh5 (RT Professional)
Descripción
TRUE si el valor límite superior "Reserve 5" se evalúa porcentualmente. FALSE si la
TypeLimitLow4 (RT Professional)
Descripción
TRUE si el valor límite inferior "Reserve 4" se evalúa porcentualmente. FALSE si la evaluación
se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.

TypeLimitLow5 (RT Professional)
Descripción
TRUE si el valor límite inferior "Reserve 5" se evalúa porcentualmente. FALSE si la evaluación
se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
TypeToleranceHigh (RT Professional)
Descripción
TRUE si el valor límite inferior "Toleranz high" se evalúa porcentualmente. FALSE si la
TypeToleranceLow (RT Professional)
Descripción
TRUE si el valor límite inferior "Toleranz low" se evalúa porcentualmente. FALSE si la
TypeWarningHigh (RT Professional)
Descripción
TRUE si el valor límite inferior "Warning high" se evalúa porcentualmente. FALSE si la
TypeWarningLow (RT Professional)
Descripción
TRUE si el valor límite inferior "Warning low" se evalúa porcentualmente. FALSE si la
UncertainStateColor(i) (RT Professional)
Descripción
Define el color para la identificación de valores con estado incierto.

Sintaxis
Object.UncertainStateColor(i)[=Color]
Object
Color
Opcional. Valor o constante que define el color para la identificación de valores con estado
incierto.
Observaciones
Si se desconoce el valor inicial de un valor después de activar runtime o si se utiliza un valor
sustitutivo, el valor tiene un estado incierto.
Consulte también
UncertainStateEnabled(i) (RT Professional)
Descripción
Determina si los valores con estado incierto se identifican con el color definido en
"ReplacementColor(i)".
Los valores con valor inicial desconocido después de activar runtime o para los que se utiliza
un valor sustitutivo tienen un estado incierto.
Sintaxis
Object.UncertainStateEnabled(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los valores con estado incierto se identifican con el color definido en
""ReplacementColor(i)".

Observaciones
Consulte también
UpdateEnable (RT Professional)
Descripción
Determina si puede modificarse el visor de recetas en runtime.
Sintaxis
Object.UpdateEnable[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si puede modificarse el visor de recetas en runtime.
UpperLimitColor(i) (RT Professional)
Descripción
Establece el color que marca los valores de variable que se encuentran por encima del valor
""UpperLimitValue(i)". El dato se evaluará o no dependiendo del valor de la propiedad
"UpperLimitEnabled(i)".
Sintaxis
Object.UpperLimitColor(i)[=Color]
Object

Color
Opcional. Un valor o una constante que identifica los valores de variables situados por encima
del valor de "UpperLimitValue(i)".
Observaciones
Consulte también
UpperLimitEnabled(i) (RT Professional)
Descripción
Determina si se utiliza el dato de "UpperLimitColor(i)" para marcar los valores de variables
situados por encima del valor de "UpperLimitValue(i)".
Sintaxis
Object.UpperLimitEnabled(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se utiliza el dato de "UpperLimitColor(i)" para marcar los valores de variable
situados por encima del valor de "UpperLimitValue(i)".
Observaciones
Consulte también

UpperLimitValue(i) (RT Professional)
Descripción
Determina si los valores de variable situados por encima del valor de "UpperLimitValue(i)" se
marcan con el color definido en "UpperLimitColor(i)". El dato se evaluará o no dependiendo
del valor de la propiedad "UpperLimit(i)".
Sintaxis
Object.UpperLimitValue(i)[=Double]
Object
"FunctionTrendControl"..
Double
Opcional. Valor o constante que determina si los valores de variable situados por encima del
valor de "UpperLimitValue(i)" se marcan con el color definido en "UpperLimitColor(i)".
Observaciones
Consulte también
UseAllServers (RT Professional)
Descripción
Determina si los datos que deben representarse en la ventana de avisos son solicitados por
todos los servidores incluidos en un sistema distribuido. En los servidores participantes debe
estar activado el Alarm Logging.
Acceso en runtime: sólo lectura
Sintaxis
Object.UseAllServers[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "AlarmView".

BOOLEAN
Opcional. TRUE, si los datos que deben representarse en la ventana de avisos son solicitados
por todos los servidores incluidos en un sistema distribuido.
Consulte también
Propiedad UserValue1 (RT Professional)
Descripción
Define un valor cualquiera, o lo retorna.
Ud. puede hacer que p. ej. un guión evalúe el valor. En Runtime no se evalúa ni se visualiza
este valor.
Descripción
este valor.
Descripción
este valor.
Descripción
este valor.

ValueAxisDecimalPrecision(i) (RT Professional)
Descripción
Define el número de decimales del rango de valores de la curva especificada.
Sintaxis
Object.ValueAxisDecimalPrecision(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrend" o
"FunctionTrendView"..
Int
Opcional. Valor o constante que establece el número de decimales del rango de valores de
la curva especificada.
Consulte también
ValueAxisShowGridLines(i) (RT Professional)
Descripción
Determina si la ventana de curvas se representa con líneas de cuadrícula paralelas al eje Y.
Sintaxis
Object.ValueAxisShowGridLines(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si la ventana de curvas se representa con líneas de cuadrícula paralelas al
eje Y.

Observaciones
La distancia entre dos líneas de cuadrícula puede modificarse mediante la propiedad
"ValueAxisGridLineInterval(i)".
Consulte también
ValueColumnPrecision(i) (RT Professional)
Descripción
Define el número de decimales que se muestran en esta columna de valores. El parámetro i
indica el número del par de columnas. Se pueden mostrar hasta 16 decimales.
Sintaxis
Object.ValueColumnPrecision(i)[=Int]
Object
Int
Opcional. Valor o constante que define el número de decimales que se muestran en esta
columna de valores.
Consulte también
WarningHigh (RT Professional)
Descripción
Define el valor límite superior "Warning High", o lo retorna.
La propiedad "CheckWarningHigh" debe estar activada en TRUE para que se supervise el
valor límite.
La representación al llegar al valor límite y el tipo de evaluación se definen por medio de las
propiedades "ColorWarningHigh" y "TypeWarningHigh".

WarningLow (RT Professional)
Descripción
Define el valor límite inferior "Warning Low", o lo retorna.
La propiedad "CheckWarningLow" debe estar activada en TRUE para que se supervise el
valor límite.
La representación al llegar al valor límite y el tipo de evaluación se definen por medio de las
propiedades "ColorWarningLow" y "TypeWarningLow".
StyleSettings (RT Professional)
Descripción
Determina el estilo con el que se representa el objeto.
Sintaxis
Object.StyleSettings[=WinCCStyle]
Object
● Button
● RoundButton
● WindowsSlider
WinCCStyle
Opcional. Valor o constante que determina el estilo con el que se representa el objeto.
Personalizado Representa el objeto según los ajustes propios.

Global Representa el objeto en el diseño ajustado globalmente.
Estilo Windows Presenta el objeto en estilo Windows.
WindowBorder (RT Professional)
Descripción
TRUE si la ventana en Runtime se visualiza con borde. Sólo acceso de lectura.

XAxisBegin(i) (RT Professional)
Descripción
Establece el límite inferior del eje X de una curva referenciada con la propiedad
"CurrentCurveIndex". La indicación se evaluará o no en función de las propiedades
"XAxisAutorange(i)" y "ShareXAxis".
Sintaxis
Object.XAxisBegin(i)[=String]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
String
Opcional. Un valor o una constante que establece el límite inferior del eje X de una curva
referenciada con la propiedad "CurrentCurveIndex".
Consulte también
XAxisEnd(i) (RT Professional)
Descripción
Establece el límite superior del eje X de una curva referenciada con "CurrentCurveIndex". La
indicación se evaluará o no en función de las propiedades "XAxisAutorange(i)" y "ShareXAxis".
Sintaxis
Object.XAxisEnd(i)[=String]
Object
String
Opcional. Un valor o una constante que establece el límite superior del eje X de una curva
referenciada con "CurrentCurveIndex".
Consulte también

XAxisShowGridLines(i) (RT Professional)
Descripción
Determina si la ventana de curvas se representa con líneas de retícula paralelas al eje X. La
distancia entre dos líneas de retícula puede modificarse por medio de la propiedad
"XAxisGridLineInterval(i)".
Sintaxis
Object.XAxisShowGridLines(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE cuando la ventana de curvas se representa con líneas de retícula paralelas
al eje X.
Consulte también
Activate (RT Professional)
Descripción
Define si los datos que se van a representar se solicitarán del servidor de avisos.
Sintaxis
Object.Activate[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los datos que se van a representar se solicitan del servidor de avisos.

Consulte también
AdjustBorder3DWithStyle (RT Professional)
Descripción
Determina si el ancho del borde 3D se representa en el estilo general de Windows.
Sintaxis
Object.AdjustBorder3DWithStyle[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Button".
BOOLEAN
Opcional. TRUE si el ancho del borde 3D se representa en el estilo general de Windows.
Consulte también
AlarmFilter (RT Professional)
Descripción
Define un SQL-Statement para la selección de los avisos mostrados en la ventana de avisos.
Alarmlist and hitlist filtering and sorting settings
Sintaxis
Object.AlarmFilter[=String]
Object
String
Opcional. Valor o constante que define un SQL-Statement para la selección de los avisos
mostrados en la ventana de avisos.

Consulte también
AngleAlpha (RT Professional)
Descripción
Define el ángulo de profundidad a para el efecto 3D del objeto "3DBarGraph", o lo retorna.
Rango de valores en grados de 0 hasta 90.
AngleBeta (RT Professional)
Descripción
Define el ángulo de profundidad b para el efecto 3D del objeto "3DBarGraph", o lo retorna.
Rango de valores en grados de 0 hasta 90.
Propiedad Axe (RT Professional)
Descripción
Define la posición de la barra 3D en el sistema de coordenadas, o retorna el valor. Margen
de valores de 0 hasta 2.
0: La barra 3D se representa en el eje X.
1: La barra 3D se representa en el eje Y.
2: La barra 3D se representa en el eje Z.
AxisSection (RT Professional)
Descripción
Define la distancia entre dos secciones extensas del eje, o la retorna. La introducción de la
distancia se realiza en unidades de escala y depende de los valores máximos y mínimos
proyectados.
Background (RT Professional)
Descripción
TRUE si el fondo en un objeto 3DBarGraph debe ser visibe. Acceso de escritura y lectura
BOOLEAN.

BarDepth (RT Professional)
Descripción
Define la profundidad de barra en píxeles, o la retorna.
Propiedad BarHeight (RT Professional)
Descripción
Define la altura de barra en píxeles, o la retorna.
Propiedad BaseX (RT Professional)
Descripción
Define la distancia horizontal en píxeles desde el borde de barra derecho hasta el borde
izquierdo del campo de objeto, o la retorna.
Propiedad BaseY (RT Professional)
Descripción
Define la distancia vertical desde el borde de barra inferior hasta el borde superior, o la retorna.
CloseButton (RT Professional)
Descripción
TRUE si la ventana tiene un botón de comando "Cerrar". Sólo acceso de lectura.
ColumnSizingEnable (RT Professional)
Descripción
Determina si puede modificarse el ancho de las columnas de la ventana de avisos. El ancho
de las columnas solo puede modificarse si no está activada la propiedad "AutoScroll".
Sintaxis
Object.ColumnSizingEnable[=BOOLEAN]

Object
BOOLEAN
Opcional. TRUE si puede modificarse el ancho de las columnas de la ventana de avisos.
Consulte también
ForeFlashColorOff (RT Professional)
Descripción
Define el color del texto para el estado de parpadeo "Off", o lo devuelve. Acceso de escritura
y lectura LONG.
ForeFlashColorOn (RT Professional)
Descripción
Define el color del texto para el estado de parpadeo "On", o lo devuelve. Acceso de escritura
y lectura LONG.
InsertData(i) (RT Professional)
Descripción
Establece los datos que se insertan para la curva activa.
Sintaxis
Object.InsertData(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControi".
BOOLEAN
Opcional. TRUE si "DataIndex(i)" se ignora y los datos se añaden detrás en el búfer de datos.
FALSE si los datos se insertan en la posición DataIndex(i)" del búfer de datos.

Observaciones
El visor de curvas vuelve a trazarse con cada operación con "InsertData(i)".
Consulte también
Layer00Checked (RT Professional)
Descripción
TRUE si se debe supervisar el límite 0. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer00Value y
Layer00Color.
Layer00Color (RT Professional)
Descripción
Define el color para el límite 0, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer00Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Layer00Value (RT Professional)
Descripción
Define o devuelve el valor para "Límite 0".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer00Checked tiene el valor
TRUE.
Descripción
Layer01Color.

Descripción
Descripción
TRUE.
Descripción
Layer02Color.
Descripción
Descripción
TRUE.

Descripción
Layer03Color.
Descripción
Descripción
TRUE.
Descripción
Layer04Color.
Descripción

Descripción
TRUE.
Descripción
Layer05Color.
Descripción
Descripción
TRUE.
Descripción
Layer06Color.

Descripción
Descripción
TRUE.
Descripción
Layer07Color.
Descripción
Descripción
TRUE.

Descripción
Layer08Color.
Descripción
Descripción
TRUE.
Propiedad Layer09Checked (RT Professional)
Descripción
Layer09Color.
Descripción

Descripción
TRUE.
Descripción
Layer10Color.
Descripción
Descripción
TRUE.
Propiedad LightEffect (RT Professional)
Descripción
TRUE si el efecto luminoso está conectado. Acceso de escritura y lectura BOOLEAN.
Propiedad ListType (RT Professional)
Descripción
En el objeto Lista de texto retorna el tipo de objeto representado. Sólo acceso de lectura.
Margen de valores de 0 hasta 2.

0 = Decimal
1 = Binario
2 = Bit
Localizable (RT Professional)
Descripción
Determina si puede asignarse y formatearse una fuente para cada idioma de runtime.
Sintaxis
Object.Localizable[=BOOLEAN]
Object
"FunctionTrendControl", "OnlineTableControl", "AlarmControl" o "UserArchiveControl".
BOOLEAN
Opcional. TRUE si puede asignarse y formatearse una fuente para cada idioma de runtime.
Consulte también
Propiedad Max (RT Professional)
Descripción
Define el valor absoluto con visualización completa de valores, o lo retorna. Si la visualización
de la escala está activa, entonces se visualizará este valor.

PersistentRTCSAuthorization (RT Professional)
Descripción
Establece el permiso de operación para poder modificar el ajuste de la persistencia en runtime
y ES. El valor que debe introducirse corresponde al número que posee el permiso deseado
en la administración de usuarios. El dato se evaluará o no dependiendo del valor de la
propiedad "AllowPersistance". Esto no se aplica al visor de avisos.
Sintaxis
Object.PersistentRTCSAuthorization[=RtAuthorization]
Object
"OnlineTrendControl", "FunctionTrendControl" o "OnlineTableControl".
RtAuthorization
Opcional. Valor o constante que establece el permiso de operación para poder modificar el
ajuste de la persistencia.
Consulte también
PersistentToDownload (RT Professional)
Descripción
Determina si los ajustes se conservan hasta la nueva descarga de ES.
Sintaxis
Object.PersistentToDownload[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los ajustes se conservan hasta la nueva descarga de ES.

Consulte también
PersistentToDownloadAuthorization (RT Professional)
Descripción
Establece el permiso de acceso para poder modificar los ajustes hasta la próxima descarga
de ES.
Sintaxis
Object.PersistentToDownloadAuthorization[=HmiRTAuthorization]
Object
HmiRTAuthorization
Opcional. Valor o constante que establece el permiso de acceso para poder modificar los
ajustes hasta la próxima descarga de ES.
Consulte también
PicDownReferenced (RT Professional)
Descripción
TRUE si se guarda la imagen asignada para el estado "On". De no ser así se guardará
únicamente la referencia del objeto perteneciente. Sólo acceso de lectura.

PicReferenced (RT Professional)
Descripción
TRUE si se hace una referencia de la imagen asignada y no se guarda en el objeto. Sólo
acceso de lectura.
Posición (RT Professional)
Descripción
Define el valor predeterminado para la posición del control deslizante.
Este valor se utiliza como valor inicial en Runtime.
Para el manejo del valor del proceso enlazado a este atributo es necesario enlazar el valor
del proceso también al evento "Posición". Puede encontrar el evento "Position" en la ficha
"Evento", en la ramificación SliderCtrl\Temas de propiedad\Propiedades de control\Valor.
PredefinedAngles (RT Professional)
Descripción
Define la representación de profundidad en un objeto 3DBarGraph, o la retorna. Margen de
valores de 0 hasta 3.
0 = Caballero
1 = Isométrico
2 = Axionométrico
3 = Definido libremente
PrintConfiguration (RT Professional)
Descripción
Establece el protocolo para la impresión.
Sintaxis
Object.PrintConfiguration[=HMIPrintConfiguration]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl",
"FunctionTrendControl", "OnlineTableControl", "AlarmControl" o "UserArchiveControl".

HMIPrintConfiguration
Opcional. Valor o constante que establece el protocolo para la impresión.
Consulte también
ProjectPath (RT Professional)
Descripción
Contiene la ruta y el nombre del proyecto correspondiente.
Acceso en runtime: solo lectura
Sintaxis
Object.ProjectPath[=String]
Object
String
Opcional. Valor o constante que contiene la ruta y el nombre del proyecto correspondiente.
Consulte también
RowSizingEnable (RT Professional)
Descripción
Determina si puede modificarse la altura de la fila.
La propiedad "RowSizingEnable" solo está desactivada si las propiedades "RowSizingEnable"
y "AdaptFontSizeToLineHeight" tienen el valor FALSE.
Sintaxis
Object.RowSizingEnable[=BOOLEAN]

Object
BOOLEAN
Opcional. TRUE si puede modificarse la altura de la fila.
Consulte también
Scrollable (RT Professional)
Descripción
Determina si la visualización de imágenes DXF soporta en el modo runtime las funciones
Scroll.
Sintaxis
Object.Scrollable[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "DXFView".
BOOLEAN
Opcional. TRUE si la visualización de imágenes DXF soporta en el modo runtime las funciones
Scroll.
ShowMessagesAtDate (Panels, Comfort Panels, RT Advanced)
Descripción
Determina a partir de qué fecha se deben visualizar los avisos.
Nota
Esta función no filtra los avisos, sino que posiciona el área de visualización de la lista de avisos
a partir de la fecha indicada.
Sintaxis
Object.ShowMessagesAtDate [= DATE]

Object
Observación
Para asignar SmartTags a la propiedad "ShowMessagesAtDate", formule la asignación como
se indica a continuación:
'Ejemplo 1
HmiRuntime.Screens("Screen_1").ScreenItems("Alarm
view_1").ShowMessagesAtDate = SmartTags("intern_1").Value
'Ejemplo 2
HmiRuntime.Screens("Screen_1").ScreenItems("Alarm
view_1").ShowMessagesAtDate = CDate(SmartTags("intern_1"))
El SmartTag "intern_1" debe ser del tipo "DateTime".
Consulte también
Sort (RT Professional)
Descripción
Establece criterios de clasificación en sintaxis SQL para la base de datos.
Sintaxis
Object.Sort[=String]
Object
String
Opcional. Valor o constante que establece los criterios de clasificación en sintaxis SQL para
la base de datos.
TableFocusOnButtonCommand (RT Professional)
Descripción
Determina si al hacer clic en un Button de un script en runtime se activa la tabla del Controls.

Sintaxis
Object.TableFocusOnButtonCommand[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "AlarmView".
BOOLEAN
Opcional. TRUE si al hacer clic en un Button de un script en runtime se activa la tabla del
Controls.
Consulte también
TimeRangeBase(i) (RT Professional)
Descripción
Define la unidad para determinar los intervalos de tiempo de la curva especificada.
Sintaxis
Object.TimeRangeBase(i)[=TagLoggingTimeUnit]
Object
TagLoggingTimeUnit
( 1): se definen intervalos de tiempo de milisegundos.
hmiCurveTimeRangeBase500ms ( 500): se definen intervalos de tiempo de 500 ms.
hmiCurveTimeRangeBaseSecond ( 1000): se definen intervalos de tiempo de segundos.
hmiCurveTimeRangeBaseMinute ( 60000): se definen intervalos de tiempo de minutos.
hmiCurveTimeRangeBaseHour ( 3600000): se definen intervalos de tiempo de horas.
hmiCurveTimeRangeBaseDay ( 86400000): se definen intervalos de tiempo de días.
Observaciones
El intervalo de tiempo que se debe representar para la curva i resulta de la multiplicación de
los valores "TimeRangeBase(i)"" y "TimeRangeFactor(i)", interpretándose el valor de
"TimeRangeBase(i)" en milisegundos. Las propiedades "TimeRangeBase(i)" y
"TimeRangeFactor(i)" se evalúan solo si la propiedad "TimeRange" tiene el valor "-1".

Consulte también
TimeRangeFactor(i) (RT Professional)
Descripción
Determina el factor para la determinación de los intervalos de tiempo de la curva indicada.
Sintaxis
Object.TimeRangeFactor(i)[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend",
"FunctionTrendView" o "TableView".
Int
Opcional. Un valor o una constante que determina el factor para la determinación de los
intervalos de tiempo de la curva indicada.
Observaciones
El rango de tiempo que debe representarse para la curva i resulta de la multiplicación de los
valores "TimeRangeBase(i)" y "TimeRangeFactor(i)", interpretándose el valor de
"TimeRangeBase(i)" en milisegundos. Las propiedades "TimeRangeBase(i)" y
"TimeRangeFactor(i)" sólo se evalúan cuando la propiedad "TimeRange" tiene el valor "-1".
Consulte también
UseTimeRange(i) (RT Professional)
Descripción
Determina cómo está definido el rango de tiempo que debe representarse para la curva
indicada.

Sintaxis
Object.UseTimeRange(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones
"OnlineTrend","FunctionTrendView" o "TableView".
BOOLEAN
Opcional. TRUE si el rango de tiempo que debe representarse está determinado por un
instante de inicio ("TimeAxisBeginTime(i)") y un instante final ("TimeAxisEndTime").
FALSE, si el rango de tiempo que debe representarse está determinado por un instante de
inicio ("TimeAxisBeginTime(i)") y un rango de tiempo "TimeRangeBase(i)" y
"TimeRangeFactor(i)".
Observaciones
Consulte también
ValidateFormatPattern (RT Professional)
Descripción
Determina que se comprueben determinados caracteres del campo "Formato de
representación".
Sintaxis
Object.ValidateFormatPattern[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se comprueban determinados caracteres del campo "Formato de
representación".

Consulte también
ValueAxisBegin(i) (RT Professional)
Descripción
Define el límite inferior del rango de valores que se va a representar de la curva especificada.
El dato se evaluará o no dependiendo de las propiedades "Autorange" y "ShareValueAxis".
Sintaxis
Object.ValueAxisBegin(i)[=Double]
Object
Double
Opcional. Valor o constante que define el límite inferior del rango de valores que se va a
representar de la curva especificada.
Consulte también
ValueAxisEnd(i) (RT Professional)
Descripción
Define el límite superior del rango de valores que se va a representar de la curva especificada.
El dato se evaluará o no dependiendo de las propiedades "Autorange" y "ShareValueAxis".
Sintaxis
Object.ValueAxisEnd(i)[=Double]
Object

Double
Opcional. Valor o constante que define el límite superior del rango de valores que se va a
representar de la curva especificada.
Consulte también
ZeroPointValue (RT Professional)
Descripción
Define el valor del punto cero de la visualización de la escala.
Define el valor absoluto para el punto cero, o lo retorna.
Zoomable (RT Professional)
Descripción
Determina si la visualización de imágenes DXF soporta las funciones de zoom en el modo
runtime.
Sintaxis
Object.Zoomable[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "DXFView".
BOOLEAN
Opcional. TRUE si la visualización de imágenes DXF soporta las funciones de zoom en el
modo runtime.
Active (RT Professional)
Descripción
Define si los datos que se van a representar se solicitarán del servidor de ficheros.

Sintaxis
Object.Active[=BOOLEAN]
Object
"OnlineTableControl".
BOOLEAN
Opcional. TRUE si los datos que se van a representar se solicitan del servidor de ficheros.
Observaciones
Si no se activa este atributo, se reducen los tiempos de apertura de las imágenes. Modifique
el valor dinámicamente si es necesario.
Para distinguir la propiedad "Activate" del método "Activate", se accede a la propiedad a través
de "Object".
Consulte también
AdaptFontSizeToLineHeight (RT Professional)
Descripción
Define si se adaptará el tamaño de fuente a la altura de la línea.
Sintaxis
Object.AdaptFontSizeToLineHeight[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el tamaño de fuente se adapta a la altura de la línea.
Consulte también

AddAssignment (RT Professional)
Descripción
Agrega una entrada.
AdjustRulerWindow (RT Professional)
Descripción
Define si la ventana de regla se adapta al visor de curvas cada vez que se muestra.
Sintaxis
Object.AdjustRulerWindow[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si la ventana de regla se adapta al visor de curvas cada vez que se muestra.
Observaciones
TRUE si se desplaza la ventana de regla y a continuación se oculta y se muestra de nuevo,
volverá a representarse en la posición original con el tamaño original.
Consulte también
AlarmHigh (RT Professional)
Descripción
Define el valor límite superior en el que se activa la alarma, o lo retorna.
El tipo de evaluación (porcentual o absoluta) se define con la propiedad "TypeAlarmHigh".
Sintaxis
Object.AlarmHigh[=REAL]

Object
REAL
Valor para el límite superior
Consulte también
Bar (Página 1353)
Alignment (RT Professional)
Descripción
Define la representación de la escala (izquierda/derecha o arriba/abajo) en función de la
posición del objeto Bar, o la devuelve.
Sintaxis
Object.Alignment[=ScalePosition]
Object
ScalePosition
1: derecha o abajo.
0: izquierda o arriba.
Consulte también
Bar (Página 1353)
AlignmentLeft (RT Professional)
Descripción
Define la alineación horizontal del texto, o la devuelve. Rango de valores de 0 a 2.
Sintaxis
Object.AlignmentLeft[=HorizontalAlignment]

Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "TextField", "IOField",
"SymbolicIOField", "Button", "RoundButton", "CheckBox", "OptionGroup", "MultilineEdit",
"ComboBox", "ListBox".
HorizontalAlignment
0: alineación izquierda
1: alineación centrada
2: alineación derecha
AllowPersistence (RT Professional)
Descripción
Define si la persistencia es ajustable.
Sintaxis
Object.AllowPersistence[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si la persistencia es ajustable.
Consulte también
BackColor2 (RT Professional)
Descripción
Define el color de barra para la visualización del valor actual, o lo retorna. Acceso de escritura
y lectura LONG.

BackFillStyleReadOnlySpecial (RT Professional)
Descripción
Determina que el campo "Estilo de relleno del fondo" sólo puede leerse.
Sintaxis
Object.BackFillStyleReadOnlySpecial[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el campo "Estilo de relleno del fondo" sólo puede leerse.
Consulte también
BarStartValue (RT Professional)
Descripción
Determina el valor del punto cero de la escala.
Sintaxis
Object.BarStartValue[=Double]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
Double
Opcional. Un valor o una constante que determina el valor del punto cero de la escala.
Consulte también
Bar (Página 1353)

BarWidth (RT Professional)
Descripción
Define el ancho de barra en píxeles, o lo retorna.
BeginTime(i) (RT Professional)
Descripción
Determina el instante de inicio del intervalo de tiempo que se va a mostrar en el visor de
curvas. La propiedad "TagProviderType(i)" debe tener el valor -1.
Sintaxis
Object.BeginTime(i)[=Time]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "FunctionTrendControl" o
Time
Opcional. Valor o constante que determina el instante de inicio del intervalo de tiempo que se
va a mostrar en el visor de curvas.
Observaciones
Si se modifica "BeginTime(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "BeginTime(i)", debe
evitarse la aplicación inmediata de la modificación con "FreezeProviderConnections".
Consulte también
BorderColorBottom (RT Professional)
Descripción
Define el color de borde para la parte inferior/derecha del objeto, o lo retorna. Acceso de

BorderColorTop (RT Professional)
Descripción
Define el color de borde para la parte superior/izquierda del objeto, o lo retorna. Acceso de
CentrePoint (RT Professional)
Descripción
Determina la posición del punto central.
Sintaxis
Object.CentrePoint[=Point]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Point
Opcional. Un valor que determina la posición del punto central.
Consulte también
CentrePointLeft (RT Professional)
Descripción
Determina la distancia horizontal del punto central desde el borde izquierdo de la imagen en
píxeles.
Sintaxis
Object.CentrePointLeft[=Int]

Object
Int
Opcional. Un valor que determina la distancia horizontal del punto central desde el borde
Consulte también
CentrePointTop (RT Professional)
Descripción
Determina la distancia vertical del punto central desde el borde superior de la imagen en
píxeles.
Sintaxis
Object.CentrePointTop[=Int]
Object
Int
Opcional. Un valor que determina la distancia vertical del punto central desde el borde superior
de la imagen en píxeles.
Consulte también

ColorBottom (RT Professional)
Descripción
Define el color del tope inferior/derecho del objeto Slider, o lo retorna. Acceso de escritura y
lectura LONG.
ColorChangeType (RT Professional)
Descripción
TRUE si en una modificación de color (p. ej. al llegar al valor límite) se debe realizar el cambio
de color segmento por segmento. En el caso de FALSE el cambio de color tiene efecto en
toda la barra. Acceso de escritura y lectura BOOLEAN.
ColorTop (RT Professional)
Descripción
Define el color para el tope superior/izquierdo del objeto Slider, o lo retorna. Acceso de
ColumnColor(i) (RT Professional)
Descripción
Establece el color del par de columnas i. El parámetro i indica el número del par de columnas.
Sintaxis
Object.ColumnColor(i)[=Color]
Object
Color
Opcional. Valor o constante que establece el color del par de columnas i.
Consulte también

ColumnDisplayName(i) (RT Professional)
Descripción
Establece el nombre para el par de columnas indicado. El parámetro i indica el número del
par de columnas.
Sintaxis
Object.ColumnDisplayName(i)[=String]
Object
String
Opcional. Valor o constante que establece el nombre para el par de columnas indicado.
Consulte también
ColumnUpdateEnabled(i) (RT Professional)
Descripción
Determina si la representación del par de columnas indicado es estática o dinámica.
Sintaxis
Object.ColumnUpdateEnabled(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si la representación del par de columnas es estática.
Observaciones
La propiedad "CurrentColumnIndex" hace referencia al par de columnas activo en ese
momento.

Consulte también
Command (RT Professional)
Descripción
Determina si se fuerza la actualización de los valores mostrados en el control.
Sintaxis
Object.Command[=String]
Object
String
Opcional. Valor o constante que determina si se fuerza la actualización de los valores
mostrados en el control.
Consulte también
Comment (RT Professional)
Descripción
Lee o fija el comentario del objeto Alarm.
CommonTimeAxisColor (RT Professional)
Descripción
Establece el color del eje X común.
Sintaxis
Object.CommonTimeAxisColor[=Color]

Object
Color
Opcional. Valor o constante que establece el color del eje X común.
Consulte también
ConfigureTimeAxis(i) (RT Professional)
Descripción
Determina si se utiliza un eje de tiempo común para todas las curvas en el visor de curvas.
Sintaxis
Object.ConfigureTimeAxis(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se utiliza un eje de tiempo común para todas las curvas en el visor de
curvas.
Consulte también
CurrentCurveIndex (RT Professional)
Descripción
Establece el índice de la curva activa.
Sintaxis
Object.CurrentCurveIndex[=Int]

Object
"OnlineTrendControl".
Int
Opcional. Valor o constante que establece el índice de la curva activa en ese momento.
Observaciones
La propiedad "CurrentCurveIndex" es evaluada por otras propiedades para poder asignar sus
ajustes a una curva determinada. Los valores válidos para el índice oscilan entre 0 y -1. La
propiedad "CurvesCount" contiene el número de curvas que deben mostrarse.
Consulte también
CurveColor(i) (RT Professional)
Descripción
Establece el color de la curva indicada.
Sintaxis
Object.CurveColor(i)[=Color]
Object
Color
Opcional. Valor o constante que establece el color de la curva indicada.
Observaciones
Consulte también

CurveLineWidth(i) (RT Professional)
Descripción
Establece el grosor de la línea de la curva indicada.
Sintaxis
Object.CurveLineWidth(i)[=Int]
Object
Int
Opcional. Valor o constante que establece el grosor de la línea de la curva indicada. Rango
de valores de 0 a 10.
Observaciones
Consulte también
CurvesCount (RT Professional)
Descripción
Devuelve el número de curvas o pares de columnas configurados (visibles o invisibles) de la
ventana.
Sintaxis
Object.CurvesCount[=Int]
Object
Int
Opcional. Valor o constante que devuelve el número de curvas o pares de columnas
configurados (visibles o invisibles) de la ventana.

Consulte también
CurveUpdateEnabled(i) (RT Professional)
Descripción
Determina si la representación de la curva indicada es estática o dinámica.
Sintaxis
Object.CurveUpdateEnabled(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si la representación de la curva es estática.
Observaciones
Consulte también
DataIndex(i) (RT Professional)
Descripción
Devuelve el índice actual de los datos de la curva actual.
Sintaxis
Object.DataIndex(i)[=Int]
Object

Int
Opcional. Valor o constante que devuelve el índice actual de los datos de la curva actual.
Consulte también
DataLogTag (RT Professional)
Descripción
Determina qué variable está vinculada con la curva indicada.
Sintaxis
Object.DataLogTag[=HmiLoggingTag]
Object
HmiLoggingTag
Opcional. Valor o constante que determina qué variable está vinculada con la curva indicada.
Observaciones
Consulte también
DataX(i) (RT Professional)
Descripción
Añade un único registro y debe fijarse antes de la llamada de "InsertData(i)".
Sintaxis
Object.DataX(i)[=object]

Object
object
Opcional. Valor o constante que añade un único registro.
Consulte también
DataXY(i) (RT Professional)
Descripción
Añade varios registros como Array con pares de valores y debe fijarse antes de la llamada de
"InsertData(i)".
Los datos de Array se adoptan si "DataX(i)" es del tipo VT_EMPTY. En caso contrario, en el
atributo "InsertData(i)" se utiliza el único par de valores que se obtiene de "DataX(i)" y
"DataY(i)".
Sintaxis
Object.DataXY(i)[=object]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendView".
object
Opcional. Valor o constante que añade varios registros como Array con pares de valores.
Consulte también
DataY(i) (RT Professional)
Descripción
Añade un único registro y debe fijarse antes de la llamada de "InsertData(i)".

Sintaxis
Object.DataY(i)[=Double]
Object
Double
Opcional. Valor o constante que añade un único registro.
Consulte también
DeleteData(i) (RT Professional)
Descripción
Establece los datos que se borran del búfer de datos de la curva activa.
TRUE:
Sintaxis
Object.DeleteData(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se borran todos los datos de la curva.
FALSE si se borra el par de valores en la posición "DataIndex(i)".
Consulte también
Direction (RT Professional)
Descripción
Define la orientación de la barra o la posición del objeto Slider, o la retorna.

Sintaxis
Object.Direction [=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "Bar" o "Slider".
BOOLEAN
0 = Arriba
1 = Abajo
2 = Izquierda
3 = Derecha
DisplayName(i) (RT Professional)
Descripción
Establece el nombre para la curva indicada.
Sintaxis
Object.DisplayName(i)[=String]
Object
String
Opcional. Valor o constante que establece el nombre para la curva indicada.
Observaciones
Consulte también
DrawEnhancedHTMLBrowser (RT Professional)
Descripción
Determina el estilo del HTML-Browsers.

Sintaxis
Object.DrawEnhancedHTMLBrowser[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "HTMLBrowser".
BOOLEAN
Opcional. TRUE se muestra un HTML-Browser ampliado.
Consulte también
Editable(i) (RT Professional)
Descripción
Determina si un par de columnas puede editarse. El parámetro i indica el número del par de
columnas.
Sintaxis
Object.Editable(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si un par de columnas puede editarse. Se hace referencia al par de columnas
con el parámetro i.
Consulte también
EditEnabled (RT Professional)
Descripción
Determina si el modo de edición está activado para una celda cuando su propiedad
"Editable(i)" tiene el valor TRUE.

Sintaxis
Object.EditEnabled[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el modo de edición está activado para una celda cuando su propiedad
"Editable(i)" tiene el valor TRUE.
Consulte también
EndPoint (RT Professional)
Descripción
Determina la posición del punto final.
Acceso en runtime:
Sintaxis
Object.EndPoint[=Point]
Object
Point
Opcional. Un valor que determina la posición del punto final.
Consulte también

EndPointLeft (RT Professional)
Descripción
Determina la distancia horizontal del punto final desde el borde izquierdo de la imagen en
píxeles.
Sintaxis
Object.EndPointLeft[=Int]
Object
Int
Opcional. Un valor que determina la distancia horizontal del punto final desde el borde
Consulte también
EndPointTop (RT Professional)
Descripción
Determina la distancia vertical del punto final desde el borde superior de la imagen en píxeles.
Sintaxis
Object.EndPointTop[=Int]
Object
Int
Opcional. Un valor que determina la distancia vertical del punto final desde el borde superior
de la imagen en píxeles.

Consulte también
EndTime(i) (RT Professional)
Descripción
Establece el instante final del intervalo de tiempo que se muestra en el visor de curvas. La
propiedad "TagProviderType(i)" debe tener el valor -1.
Sintaxis
Object.EndTime(i)[=Time]
Object
"OnlineTabelControl".
Time
Opcional. Valor o constante que establece el instante final del intervalo de tiempo que se
muestra en la ventana de curvas.
Observaciones
Si se modifica "EndTime(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "EndTime(i)", debe
Consulte también
ExportXML (Panels, Comfort Panels, RT Advanced)
ExportXML
Sólo se utiliza internamente.

El atributo se dinamiza con el nombre ExportXML.
ExtendedOperation (RT Professional)
Descripción
TRUE si el control deslizante es colocado en el valor final perteneciente (valor mínimo/valor
máximo). Esto se realiza con un clic del ratón en el área fuera del ajuste actual del regulador.
Acceso de escritura y lectura BOOLEAN.
ExtraSpaceForLabelDisplay (RT Professional)
Descripción
Determina el espacio adicional para la rotulación.
Sintaxis
Object.ExtraSpaceForLabelDisplay[=Int]
Object
Int
Opcional. Un valor que determina el espacio adicional para la rotulación.
Consulte también
Bar (Página 1353)
FlashFlashPicture (RT Professional)
Descripción
TRUE si está activada la intermitencia de la imagen intermitente. Acceso de escritura y lectura
BOOLEAN.
FlashForeColor (RT Professional)
Descripción
TRUE si está activado el parpadeo del texto. Acceso de escritura y lectura BOOLEAN.

FlashPicReferenced (RT Professional)
Descripción
TRUE si se debe guardar el gráfico intermitente asignado. De no ser así se guardará
únicamente la referencia del objeto perteneciente. Sólo acceso de lectura.
FlashPicture (RT Professional)
Descripción
Devuelve el gráfico intermitente. Acceso de sólo lectura.
El gráfico (*.BMP o *.DIB) debe estar en la carpeta "GraCS" del proyecto actual para poder
integrarlo.
La propiedad "FlashPicReferenced" define, en este contexto, si el gráfico intermitente se debe
guardar junto con el objeto o si se debe referenciar.
FlashRateBorderColor (RT Professional)
Descripción
Define la frecuencia de intermitencia para la línea del objeto, o la retorna. Margen de valores
de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
FlashRateFlashPic (RT Professional)
Descripción
Define la frecuencia de parpadeo para el gráfico intermitente, o la devuelve. Margen de valores
de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
FlashRateForeColor (RT Professional)
Descripción
Define la frecuencia de intermitencia para la rotulación del objeto, o la retorna. Margen de
valores de 0 hasta 2.

0 = Lento
1 = Medio
2 = Rápido
FormatPatternReadOnlySpecial (RT Professional)
Descripción
Determina que el campo "Formato de representación" sea de sólo lectura.
Sintaxis
Object.FormatPatternReadOnlySpecial[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el campo "Formato de representación" es de sólo lectura.
Consulte también
FreezeProviderConnections (RT Professional)
Descripción
Determina si pueden modificarse propiedades para la conexión de datos
("TagProviderType(i)", "Source.."...) sin que la modificación se haga efectiva de inmediato. Si
p. ej. se modifica "XDataLogTag(i)", pueden producirse combinaciones inadmisibles con
"YDataLogTag(i)".
Por esta razón, antes de modificar un atributo para la conexión de datos,
"FreezeProviderConnections" debe tener el valor TRUE. Después de modificar todas las
propiedades para la conexión de datos, "FreezeProviderConnection" se pone a FALSE y las
modificaciones se hacen efectivas.
Sintaxis
Object.FreezeProviderConnections[=BOOLEAN]

Object
BOOLEAN
Opcional. TRUE si pueden modificarse propiedades para la conexión de datos
("TagProviderType(i)", "Source.."...) sin que la modificación se haga efectiva de inmediato.
Consulte también
GetSelectionText (RT Professional)
Descripción
Devuelve el texto seleccionado del objeto "MultiLineEdit".
HideTagNames (RT Professional)
Descripción
Determina si los nombres de variables se muestran en el visor de curvas f(t).
Sintaxis
Object.HideTagNames[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se muestran los nombres de variables.
Consulte también
LanguageSwitch (RT Professional)
Descripción
Retorna el valor que define dónde se guardan los textos de asignación dependientes del
idioma. Sólo acceso de lectura.

TRUE si los textos se administran en el editor de textos del proyecto. Las traducciones a otros
idiomas se efectúan en el editor de textos del proyecto.
FALSE si los textos se administran directamente en el objeto. Las traducciones a otros idiomas
pueden efectuarse mediante la función de exportación/importación.
LeaveMarginForBorder (RT Professional)
Descripción
Determina si se deja libre un margen adicional para el borde.
Sintaxis
Object.LeaveMarginForBorder[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se deja libre un margen adicional para el borde.
Consulte también
Bar (Página 1353)
LeaveMarginForMarkers (RT Professional)
Descripción
Determina si se deja libre un margen adicional para marcadores.
Sintaxis
Object.LeaveMarginForMarkers[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se deja libre un margen adicional para marcadores.

Consulte también
Bar (Página 1353)
Min (RT Professional)
Descripción
Define el valor absoluto con la visualización más pequeña de valores, o lo retorna. Si la
visualización de la escala está activa, entonces se visualizará este valor.
NumberOfValues(i) (RT Professional)
Descripción
Establece el número de valores que se representan en la ventana de curvas. La propiedad
"TagProviderType(i)" debe tener el valor -1. El dato se evaluará o no dependiendo del valor
de la propiedad "UseMeasurePoints(i)".
Sintaxis
Object.NumberOfValues(i)[=Int]
Object
Int
Opcional. Valor o constante que establece el número de valores que se representan en la
ventana de curvas.
Observaciones
Number of value pairs for curve i (from tag provider)
Consulte también
Parent (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Retorna la imagen en la que está incrustado el objeto indicado.

Sintaxis
Object.Parent
Object
Obligatorio. Objeto del tipo "ScreenItem". Ésta es una propiedad estándar del objeto
ScreenItem, por lo que está disponible en todas las apariencias.
El ejemplo siguiente escribe el nombre de la imagen raíz en la variable "BaseScreenName":
'VBS_Example_Parent
Dim objScrItem, BaseScreenName
Set objScrItem = HMIRuntime.Screens(1).ScreenItems(1)
BaseScreenName = "Name of BaseScreen: " & objScrItem.Parent.ObjectName
Consulte también
Line (Página 1422)
Bar (Página 1353)


PicUpReferenced (RT Professional)
Descripción
TRUE si se guarda la imagen asignada para el estado "Off" en el objeto. De no ser así se
guardará únicamente la referencia del objeto perteneciente. Sólo acceso de lectura.
RemoveAllAssignment (RT Professional)
Descripción
Borra todas las entradas.
RemoveAssignment (RT Professional)
Descripción
Elimina una entrada.

RowNumber (RT Professional)
Descripción
Indica el número de fila del objeto Row de un control de tabla.
Consulte también
RulerPrecision(i) (RT Professional)
Descripción
Establece el número de decimales con los que se muestra una medida de la curva indicada
si se calcula por medio de la función "Muestra el valor en este punto".
Sintaxis
Object.RulerPrecision(i)[=Int]
Object
Int
Opcional. Valor o constante que establece el número de decimales con los que se muestra
una medida de la curva indicada si se calcula por medio de la función "Muestra el valor en
este punto".
Consulte también
RulerXPrecision(i) (RT Professional)
Descripción
Establece el número de decimales con los que se muestra una medida de la coordenada X.
El dato se evaluará o no dependiendo del valor del atributo "XAxisMode(i)".
Sintaxis
Object.RulerXPrecision(i)[=Int]

Object
Int
una medida de la coordenada X.
Observaciones
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada X de la
medida.
Consulte también
RulerYPrecision(i) (RT Professional)
Descripción
Establece el número de decimales con los que se muestra una medida de la coordenada Y.
El dato se evaluará o no dependiendo del valor del atributo "XAxisMode(i)".
Sintaxis
Object.RulerYPrecision(i)[=Int]
Object
Int
una medida de la coordenada Y.
Observaciones
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada Y de la
medida.
Consulte también

SetAllAssignment (RT Professional)
Descripción
Establece todas las entradas.
SetpointTrendArchiveStartId(i) (RT Professional)
Descripción
Establece la posición inicial a partir de la que se leen los valores de la curva de consigna de
la receta. El dato se evaluará o no dependiendo del valor de la propiedad
"ShowSetpointTrend(i)".
Sintaxis
Object.SetpointTrendArchiveStartId(i)[=Int]
Object
Int
Opcional. Valor o constante que establece la posición inicial a partir de la que se leen los
valores de la curva de consigna de la receta.
Observaciones
Consulte también
SetpointTrendColor(i) (RT Professional)
Descripción
Establece el color de una curva de consigna. El dato se evaluará o no dependiendo del valor
de la propiedad "ShowSetpointTrend(i)".
Sintaxis
Object.SetpointTrendColor(i)[=Color]

Object
Color
Opcional. Valor o constante que establece el color de una curva de consigna.
Observaciones
Consulte también
SetpointTrendNumberOfValues(i) (RT Professional)
Descripción
Establece el número de pares de valores de una curva de consigna. El dato se evaluará o no
dependiendo del valor de la propiedad "ShowSetpointTrend(i)".
Sintaxis
Object.SetpointTrendNumberOfValues(i)[=Int]
Object
Int
Opcional. Valor o constante que establece el número de pares de valores de una curva de
consigna.
Observaciones
Consulte también

SetProps (RT Professional)
Descripción
Ajusta el valor de la propiedad.
SetSelection (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Establece una lista de las filas que están seleccionadas.
ShareTimeAxis (RT Professional)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje X común.
Sintaxis
Object.ShareTimeAxis[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si las curvas de la ventana de curvas se representan con un eje X común.
Consulte también
ShareTimeColumn (RT Professional)
Descripción
Determina si se utiliza una columna de tiempo común en la ventana de tabla.
Sintaxis
Object.ShareTimeColumn[=BOOLEAN]

Object
BOOLEAN
Opcional. TRUE si se utiliza una columna de tiempo común en la ventana de tabla.
Consulte también
ShareValueAxis (RT Professional)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje Y común.
Sintaxis
Object.ShareValueAxis[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si las curvas de la ventana de curvas se representan con un eje Y común.
Consulte también
ShareXAxis (RT Professional)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje X común.
Sintaxis
Object.ShareXAxis[=BOOLEAN]
Object

BOOLEAN
Opcional. TRUE si las curvas de la ventana de curvas se representan con un eje X común.
Consulte también
ShareYAxis (RT Professional)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje Y común.
Sintaxis
Object.ShareYAxis[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE, si las curvas de la ventana de curvas se representan con un eje Y común.
Consulte también
ShowBorder (RT Professional)
Descripción
Determina si la ventana se muestra con borde.
Sintaxis
Object.ShowBorder[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si la ventana se muestra con borde.

ShowColumn(i) (RT Professional)
Descripción
Determina si es visible el par de columnas referenciado con la propiedad
"CurrentColumnIndex".
Sintaxis
Object.ShowColumn(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si es visible el par de columnas referenciado con la propiedad
"CurrentColumnIndex".
Consulte también
ShowCurve(i) (RT Professional)
Descripción
Determina si es visible la curva referenciada con la propiedad "CurrentCurveIndex".
Sintaxis
Object.ShowCurve(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si es visible la curva referenciada con la propiedad "CurrentCurveIndex".
Consulte también

ShowInputControls (Panels, Comfort Panels, RT Advanced)
Descripción
Determina si hay campos adicionales para introducir la dirección y la contraseña.
Sintaxis
Object.ShowInputControls
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "SmartClientView".
ShowMainFrame (RT Professional)
Descripción
Determina si el objeto de barra completo se dota con un borde.
Sintaxis
Object.ShowMainFrame[=BOOLEAN]
Object
BOOLEAN
Opción. TRUE si el objeto de barra completo se dota con un borde.
Consulte también
Bar (Página 1353)
ShowOverflowIndicator (RT Professional)
Descripción
Determina si se muestra un visor de desbordamiento cuando el valor del proceso rebasa por
exceso o defecto los valores límite.
Sintaxis
Object.ShowOverflowIndicator[=BOOLEAN]

Object
BOOLEAN
TRUE si se muestra un visor de desbordamiento cuando el valor del proceso rebasa por
exceso o defecto los valores límite.
Consulte también
Bar (Página 1353)
ShowSetpointTrend(i) (RT Professional)
Descripción
Determina si se representa la curva de consigna correspondiente a la curva referenciada con
"CurrentCurveIndex".
Sintaxis
Object.ShowSetpointTrend(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se representa la curva de consigna correspondiente a la curva referenciada
con "CurrentCurveIndex".
Consulte también
SmallChange (RT Professional)
Descripción
Define cuántos pasos se puede desplazar el regulador con un clic del ratón, o retorna este
valor.

StartPoint (RT Professional)
Descripción
Define el principio del objeto o lo devuelve.
StatusbarShowArchiveName (RT Professional)
Descripción
Determina si el nombre del fichero se muestra en la barra de estado.
Sintaxis
Object.StatusbarShowArchiveName[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el nombre del fichero se muestra en la barra de estado.
StatusbarShowColumn (RT Professional)
Descripción
Determina si se muestra el número actual de columnas de registro seleccionadas.
Sintaxis
Object.StatusbarShowColumn[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se muestra el número actual de columnas de registro seleccionadas.

StatusbarShowRecord (RT Professional)
Descripción
Determina si las coordenadas de campo del registro seleccionado se muestran en la barra de
estado.
Sintaxis
Object.StatusbarShowRecord[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si las coordenadas de campo del registro seleccionado se muestran en la
barra de estado.
StatusbarShowRow (RT Professional)
Descripción
Determina si se muestra el número actual de filas de registro seleccionadas.
Sintaxis
Object.StatusbarShowRow[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se muestra el número actual de filas de registro seleccionadas.
StatusbarShowText (RT Professional)
Descripción
Determina si el estado actual de la base de datos se muestra en la barra de estado.

Sintaxis
Object.StatusbarShowText[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el estado actual de la base de datos se muestra en la barra de estado.
SwapDimensionsWithOrientation (RT Professional)
Descripción
Determina si los valores de altura y anchura de la barra se intercambian automáticamente al
modificar la orientación de la barra.
Sintaxis
Object.SwapDimensionsWithOrientation[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si los valores de altura y anchura de la barra se intercambian
automáticamente al modificar la orientación de la barra.
Consulte también
Bar (Página 1353)
TimeAxisShowLargeIncrements(i) (RT Professional)
Descripción
Determina si el eje de tiempo se escala con marcas largas.
Sintaxis
Object.TimeAxisShowLargeIncrements(i)[=BOOLEAN]
Object

BOOLEAN
Opcional. TRUE cuando el eje de tiempo se escala con marcas largas.
Observaciones
La distancia entre dos marcas largas puede modificarse por medio de la propiedad
"TimeAxisLargeIncrementSize(i)".
Consulte también
TimeAxisShowSmallIncrements(i) (RT Professional)
Descripción
Determina si el eje de tiempo se escala con marcas cortas.
Sintaxis
Object.TimeAxisShowSmallIncrements(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el eje de tiempo se escala con marcas cortas.
Observaciones
La distancia entre dos marcas cortas puede modificarse por medio de la propiedad
"TimeAxisSmallIncrementSize(i)".
Consulte también
TimeJumpColor(i) (RT Professional)
Descripción
Determina el color que caracteriza los saltos de tiempo existentes en el fichero. La indicación
se evaluará o no en función de la propiedad "TimeJumpEnabled(i)".

Sintaxis
Object.TimeJumpColor(i)[=Color]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend" o
""TableView".
Color
Opcional. Un valor o una constante que determina el color que caracteriza los saltos de tiempo
existentes en el fichero.
Consulte también
TimeJumpEnabled(i) (RT Professional)
Descripción
Determina si los saltos de tiempo existentes en el fichero se caracterizan con el color
determinado en "TimeJumpColor(i)".
Sintaxis
Object.TimeJumpEnabled(i)[=BOOLEAN]
Object
"TableView".
BOOLEAN
Opcional. TRUE si los saltos de tiempo existentes en el fichero se caracterizan con el color
determinado en "TimeJumpColor(i)".
Consulte también

TimeOverlapColor(i) (RT Professional)
Descripción
Determina el color que caracteriza las superposiciones de tiempo existentes en el fichero. La
indicación se evaluará o no en función del atributo "TimeOverlapEnabled(i)".
Sintaxis
Object.TimeOverlapColor(i)[=Color]
Object
"TableView".
Color
Opcional. Un valor o una constante que determina el color que caracteriza las superposiciones
de tiempo existentes en el fichero.
Consulte también
TimeOverlapEnabled(i) (RT Professional)
Descripción
Determina si las superposiciones de tiempo existentes en el fichero se caracterizan con el
color determinado en "TimeOverlapColor(i)".
Sintaxis
Object.TimeOverlapEnabled(i)[=BOOLEAN]
Object
"TableView".
BOOLEAN
Opcional. TRUE si las superposiciones de tiempo existentes en el fichero se caracterizan con
el color determinado en "TimeOverlapColor(i)".

Consulte también
Type (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Devuelve el tipo del objeto indicado como STRING. Estructura del nombre: Hmi<nombre del
objeto>, p. ej. HmiCircle para el objeto de imagen "círculo".
Sintaxis
Object.Type
Object
Obligatorio. Objeto del tipo "ScreenItem".
Propiedad UnselBGColor (RT Professional)
Descripción
Define en el objeto Lista de texto el color de fondo de la lista de selección en entradas no
seleccionadas, o lo retorna. Acceso de escritura y lectura LONG.
Propiedad UnselTextColor (RT Professional)
Descripción
Define en el objeto Lista de texto el color del texto en la lista de selección en entradas no
seleccionadas, o lo retorna. Acceso de escritura y lectura LONG.
Propiedad UpdateCycle (RT Professional)
Descripción
Retorna el tipo y la frecuencia para la actualización de la ventana de imagen en Runtime. Sólo
acceso de lectura.

UseBarBorderConstraints (RT Professional)
Descripción
Determina si el borde de la barra está limitado a determinados valores.
Sintaxis
Object.UseBarBorderConstraints[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el borde de la barra está limitado a determinados valores.
Consulte también
Bar (Página 1353)
UseEffectiveProcessValue (RT Professional)
Descripción
Determina si se utiliza un valor de proceso actual formado por valor máximo, valor mínimo,
media de los 15 últimos valores e histéresis.
Sintaxis
Object.UseEffectiveProcessValue[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se utiliza un valor de proceso actual formado por valor máximo, valor
mínimo, media de los 15 últimos valores e histéresis.
Consulte también
Bar (Página 1353)

UseGDI (RT Professional)
Descripción
Determina si la elipse se traza por medio de GDI o GDI+.
Sintaxis
Object.UseGDI[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Ellipse".
BOOLEAN
Opcional. TRUE si la elipse se traza por medio de GDI.
Consulte también
UseMeasurePoints(i) (RT Professional)
Descripción
Determina si los puntos de medida o el instante final establecen el intervalo de tiempo de la
curva especificada. El dato se evaluará o no dependiendo de las propiedades
"TimeAxisEndTime" y "TimeAxisBeginTime(i)".
Define el intervalo de tiempo de la curva i mediante puntos de medida (TRUE) o instante final
(FALSE) (para Tag Provider de tiempo)
Sintaxis
Object.UseMeasurePoints(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl"o
BOOLEAN
Opcional. TRUE si el intervalo de tiempo de la curva especificada se determina mediante
puntos de medida.
Observaciones

Consulte también
UseMultipleLimits (RT Professional)
Descripción
Determina si se representan una o varias parejas de valores límite como selección o línea.
Sintaxis
Object.UseMultipleLimits[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se representan una o varias parejas de valores límite como selección o
línea.
Consulte también
Bar (Página 1353)
UseScaleConstraints (RT Professional)
Descripción
Determina si la distancia entre dos marcas grandes de la escala se calcula a partir del valor
mínimo y máximo.
Sintaxis
Object.UseScaleConstraints[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si la distancia entre dos marcas grandes de la escala se calcula a partir del
valor mínimo y máximo.

Consulte también
Bar (Página 1353)
UseScaledBarBorder (RT Professional)
Descripción
Determina si el rectángulo que rodea al objeto se representa en función de la escala o si está
predefinido.
Sintaxis
Object.UseScaledBarBorder[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el rectángulo que rodea al objeto se representa en función de la escala.
Consulte también
Bar (Página 1353)
UseSeparateDiagrams (RT Professional)
Descripción
Determina si las curvas se representan escalonadas.
Sintaxis
Object.UseSeparateDiagrams[=BOOLEAN]
Object
"FunctionTrendView".
BOOLEAN
Opcional. TRUE si las curvas se representan escalonadas

Consulte también
UseSimplePresicionOffset (RT Professional)
Descripción
Determina cómo se calcula la longitud de campo para la rotulación de la escala.
Sintaxis
Object.UseSimplePresicionOffset[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si se calcula la longitud de campo para la rotulación de la escala.
Consulte también
Bar (Página 1353)
UserArchiveNumberOfValues(i) (RT Professional)
Descripción
Determina el número de valores que se cargan de la receta. La propiedad
"TagProviderType(i)" debe tener el valor -2.
Sintaxis
Object.UserArchiveNumberOfValues(i)[=Int]
Object
Int
Opcional. Un valor o una constante que determina el número de valores que se cargan de la
receta.

Observaciones
Con la modificación de "UserArchiveNumberOfValues(i)" pueden generarse combinaciones
no permitidas con otros atributos para la conexión de datos. Por tanto, antes de modificar
"UserArchiveNumberOfValues(i)" debe impedirse la aplicación inmediata del cambio con
"FreezeProviderConnections".
Consulte también
UserArchiveStartId(i) (RT Professional)
Descripción
Define el registro a partir del cual se cargan los valores de la receta para la curva especificada.
La propiedad "TagProviderType(i)" debe tener el valor -2.
Sintaxis
Object.UserArchiveStartId(i)[=Int]
Object
Int
Opcional. Valor o constante que establece el registro a partir del cual se cargan los valores
de la receta para la curva especificada.
Observaciones
Si se modifica "UserArchiveStartId(i)", pueden producirse combinaciones inadmisibles con
otros atributos para la conexión de datos. Por esta razón, antes de modificar
"UserArchiveStartId(i)", debe evitarse la aplicación inmediata de la modificación con
"FreezeProviderConnections".
Consulte también

UserData (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".
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.
ValueAxisGridLineInterval(i) (RT Professional)
Descripción
Especifica la distancia entre dos líneas de cuadrícula. El dato se evaluará o no dependiendo
de las propiedades "ValueAxisShowGridLines(i)" y "TimeAxisShowGridLines(i)".
Sintaxis
Object.ValueAxisGridLineInterval(i)[=Double]
Object
Double
Opcional. Valor o constante que establece la distancia entre dos líneas de cuadrícula.
Consulte también

ValueAxisLargeIncrementSize(i) (RT Professional)
Descripción
Define la distancia entre dos marcas largas de la escala. El dato se evaluará o no dependiendo
de las propiedades "ValueAxisShowLargeIncrements(i)" y
"TimeAxisShowLargeIncrements(i)".
Sintaxis
Object.ValueAxisLargeIncrementSize(i)[=Double]
Object
Double
Opcional. Valor o constante que define la distancia entre dos marcas largas de la escala.
Consulte también
ValueAxisShowLargeIncrements(i) (RT Professional)
Descripción
Determina si el eje de valores se escala con marcas largas.
Sintaxis
Object.ValueAxisShowLargeIncrements(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el eje de valores se escala con marcas largas.

Observaciones
La distancia entre dos marcas largas puede modificarse mediante la propiedad
"ValueAxisLargeIncrementSize(i)".
Consulte también
ValueAxisShowSmallIncrements(i) (RT Professional)
Descripción
Determina si el eje de valores se escala con marcas cortas.
Sintaxis
Object.ValueAxisShowSmallIncrements(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE si el eje de valores se escala con marcas cortas.
Observaciones
La distancia entre dos marcas cortas puede modificarse mediante la propiedad
"ValueAxisSmallIncrementSize(i)".
Consulte también
ValueAxisSmallIncrementSize(i) (RT Professional)
Descripción
Define la distancia entre dos marcas cortas de la escala. El dato se evaluará o no dependiendo
de las propiedades "ValueAxisShowSmallIncrements(i)" y
"TimeAxisShowSmallIncrements(i)".

Sintaxis
Object.ValueAxisSmallIncrementSize(i)[=Double]
Object
Double
Opcional. Valor o constante que define la distancia entre dos marcas cortas de la escala.
Consulte también
XAxisDecimalPrecision(i) (RT Professional)
Descripción
Define el número de decimales con los que se indican los valores de la escala para el eje X.
Sintaxis
Object.XAxisDecimalPrecision(i)[=Int]
Object
Int
Opcional. Un valor o una constante que define el número de decimales con los que se indican
los valores de la escala para el eje X.
Consulte también

XAxisGridLineInterval(i) (RT Professional)
Descripción
Establece la distancia entre dos líneas de retícula del eje X. La indicación se evaluará o no
en función del valor de la propiedad "XAxisShowGridLines(i)".
Sintaxis
Object.XAxisGridLineInterval(i)[=Double]
Object
Double
Opcional. Un valor o una constante que determina la distancia entre dos líneas de retícula del
eje X.
Consulte también
XAxisLargeIncrementSize(i) (RT Professional)
Descripción
Establece la distancia entre dos marcas largas de la escala del eje X. La indicación se evaluará
o no en función del valor de la propiedad "XAxisShowLargeIncrements(i)".
Sintaxis
Object.XAxisLargeIncrementSize(i)[=Double]
Object
Double
Opcional. Un valor o una constante que determina la distancia entre dos marcas largas de la
escala del eje X.
Consulte también

XAxisMode(i) (RT Professional)
Descripción
Determina si se utiliza un eje de tiempo común para todas las curvas en la ventana de curvas.
Especifica las unidades de tiempo que utilizan los controles de Tag Logging.
Sintaxis
Object.XAxisMode(i)[=TrendViewTimeAxisMode]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendContol".
TrendViewTimeAxisMode
( 1): el eje de tiempo se escala.
( 2): no se ha definido ningún intervalo de tiempo. Se muestran solo pruebas aleatorias.
( 3): el intervalo de tiempo se define mediante variables.
( 4): el intervalo de tiempo se define mediante valores constantes.
Observaciones
Determina si se utiliza un eje X común para todas las curvas en la ventana de curvas.
Consulte también
XAxisShowLargeIncrements(i) (RT Professional)
Descripción
Determina si el eje X se escala con marcas largas. La distancia entre dos marcas largas puede
modificarse por medio de la propiedad "XAxisLargeIncrementSize(i)".
Sintaxis
Object.XAxisShowLargeIncrements(i)[=BOOLEAN]
Object

BOOLEAN
Opcional. TRUE cuando el eje X se escala con marcas largas.
Consulte también
XAxisShowSmallIncrements(i) (RT Professional)
Descripción
Determina si el eje X se escala con marcas cortas. La distancia entre dos marcas cortas puede
modificarse por medio de la propiedad "XAxisSmallIncrementSize(i)".
Sintaxis
Object.XAxisShowSmallIncrements(i)[=BOOLEAN]
Object
BOOLEAN
Opcional. TRUE cuando el eje X se escala con marcas cortas.
Consulte también
XAxisSmallIncrementSize(i) (RT Professional)
Descripción
Establece la distancia entre dos marcas cortas de la escala del eje X. La indicación se evaluará
o no en función del valor de la propiedad "XAxisShowSmallIncrements(i)".
Sintaxis
Object.XAxisSmallIncrementSize(i)[=Double]
Object

Double
Opcional. Un valor o una constante que determina la distancia entre dos marcas cortas de la
escala del eje X.
Consulte también
XDataLogTag(i) (RT Professional)
Descripción
Define la variable que se representa en el eje X. La propiedad "TagProviderType(i)" debe tener
el valor -1.
Sintaxis
Object.XDataLogTag(i)[=HmiLoggingTag]
Object
HmiLoggingTag
Opcional. Valor o constante que define la variable que se representa en el eje X.
Observaciones
Si se modifica "XOnlineTag(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "XOnlineTag(i)", debe
Consulte también
XOnlineTag(i) (RT Professional)
Descripción
Determina la variable que se representa a lo largo del eje X. La propiedad "TagProviderType(i)"
debe tener el valor -1.

Sintaxis
Object.XOnlineTag(i)[=HmiTag]
Object
HmiTag
Opcional. Un valor o una constante que determina la variable que se representa a lo largo del
eje X.
Observaciones
Con la modificación de "XOnlineTag(i)" pueden generarse combinaciones no permitidas con
otros atributos para la conexión de datos. Por tanto, antes de modificar "XOnlineTag(i)" debe
impedirse la aplicación inmediata del cambio con "FreezeProviderConnections".
Consulte también
YDataLogTag(i) (RT Professional)
Descripción
Define la variable que se representa en el eje Y. La propiedad "TagProviderType(i)" debe tener
el valor -1.
Sintaxis
Object.YDataLogTag(i)[=HmiLoggingTag]
Object
HmiLoggingTag
Opcional. Valor o constante que define la variable que se representa en el eje Y.
Observaciones
Si se modifica "YOnlineTag(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "YOnlineTag(i)", debe

Consulte también
YOnlineTag(i) (RT Professional)
Descripción
Determina la variable que se representa a lo largo del eje Y. La propiedad "TagProviderType(i)"
debe tener el valor -1.
Sintaxis
Object.YOnlineTag(i)[=HmiTag]
Object
HmiTag
Opcional. Un valor o una constante que determina la variable que se representa a lo largo del
eje Y.
Observaciones
Con la modificación de "YOnlineTag(i)" pueden generarse combinaciones no permitidas con
otros atributos para la conexión de datos. Por tanto, antes de modificar "YOnlineTag(i)" debe
impedirse la aplicación inmediata del cambio con "FreezeProviderConnections".
Consulte también
3.5.6 Métodos (Panels, Comfort Panels, RT Advanced, RT Professional)
3.5.6.1 Métodos A-G (Panels, Comfort Panels, RT Advanced, RT Professional)
Activate (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Activa la ventana permanente o bien la imagen raíz.

Para activar una imagen no seleccionada utilice la propiedad "BaseScreenName".

El método "Activate" sólo puede utilizarse de forma adecuada con los siguientes objetos
gráficos activables. En los objetos gráficos no activables, como rectángulo, se emite un aviso
de error.
● Campo E/S
● Interruptor
● Librería de símbolos
● Visor de curvas
● Visor de curvas f(x)
● Navegador HTML
● Deslizador
● Campo E/S gráfico
● Campo E/S simbólico
● Botón
● Visor de avisos
● Visor de usuarios
● Visor de recetas
● Visor Sm@rtClient
● Estado/forzar
Sintaxis
Expression.Activate
Expression
Obligatorio. Expresión que devuelve un objeto del tipo "Screen" o "ScreenItem".
Parámetros
--
Consulte también




Line (Página 1422)
Bar (Página 1353)
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.
Sintaxis
Ausdruck.ActivateDynamic (ByVAl bstrPropertyName As String, ByVal
bstrCycleName As String)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
Parámetro Descripción
bstrPropertyName Nombre de la propiedad a la que se refiere el dis‐
parador.
bstrCycleName Nombre del ciclo de activación, p. ej., "CycleTi‐
me1s".

Consulte también


Line (Página 1422)
Bar (Página 1353)
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".
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".
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 1311)
Método AttachDB (RT Professional)
Descripción
Ejecuta la función de tecla "Conectar copia de seguridad" del control.
Sintaxis
Expresión.AttachDB()
Expresión
Parámetros
--
Consulte también
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
Expresión.CalculateStatistic()
Expresión
Parámetro
--
Consulte también
CopyRows (RT Professional)
Descripción
Ejecuta la función de tecla "Copiar filas" del control.
Sintaxis
Expresión.CopyRows()
Expresión
Parámetro
--
Consulte también
Create (RT Professional)
Descripción
Crea un nuevo objeto Alarm.

Sintaxis
Expresión.Create (VARIANT vtApplication)
Expresión
Obligatorio. 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
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
Expresión.CutRows()
Expresión
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
Expresión.DeactivateDynamic(ByVal bstrPropertyName As String)
Expresión

Parámetro
String
bstrPropertyName Nombre de la propiedad a la que se refiere el dis‐
parador.
Consulte también


Line (Página 1422)
Bar (Página 1353)
DeleteRows (RT Professional)
Descripción
Ejecuta la función de tecla "Borrar líneas" del visor de recetas.
Sintaxis
Expresión.DeleteRows()
Expresión
Parámetro
--

Consulte también
DetachDB (RT Professional)
Descripción
Ejecuta la función de tecla "Desconectar copia de seguridad" del control.
Sintaxis
Expresión.DetachDB()
Expresión
Parámetros
--
Consulte también
Edit (RT Professional)
Descripción
Ejecuta la función de tecla "Editar" del visor de tablas.
Sintaxis
Expresión.Edit()
Expresión
Parámetro
--

Consulte también
Exportación (RT Professional)
Descripción
Ejecuta la función de tecla "Exportar fichero" o "Exportar datos" del control.
Sintaxis
Expresión.Export()
Expresión
Parámetro
VARIANT
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)

Expresión
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()

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

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

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

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

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

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

Nota
del listado.
En el listado "MessageColumn" debe escribirse, p. ej., "objMessColumn.Visible" en lugar de
"objMessColumn.MessageColumnVisible".
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.

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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.

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


● 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

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

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

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.

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


● 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

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

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

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)

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

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

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"

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

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

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)

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

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

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

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)

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

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

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

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

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

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

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

Consulte también
3.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
Expresión.HideAlarm()
Expresión
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".

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.

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 1325)
LockAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Bloquear aviso" del visor de avisos.
Sintaxis
Expresión.LockAlarm()
Expresión

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
Expresión.LoopInAlarm()
Expresión
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
Expresión.MoveAxis()
Expresión
Parámetro
--

Consulte también
MoveToFirst (RT Professional)
Descripción
Ejecuta la función del botón "Primera fila" del control.
Sintaxis
Expresión.MoveToFirst()
Expresión
Parámetros
--
Consulte también
MoveToFirstLine (RT Professional)
Descripción
Ejecuta la función del botón "Primer aviso" del visor de avisos.
Sintaxis
Expresión.MoveToFirstLine()
Expresión
Parámetro
--

Consulte también
MoveToFirstPage (RT Professional)
Descripción
Ejecuta la función del botón "Primera página" del visor de avisos.
Sintaxis
Expresión.MoveToFirstPage()
Expresión
Parámetro
--
Consulte también
MoveToLast (RT Professional)
Descripción
Ejecuta la función del botón "Último registro" del control.
Sintaxis
Expresión.MoveToLast()
Expresión
Parámetros
--

Consulte también
MoveToLastLine (RT Professional)
Descripción
Ejecuta la función del botón "Último aviso" del visor de avisos.
Sintaxis
Expresión.MoveToLastLine()
Expresión
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
Expresión.MoveToLastPage()
Expresión
Parámetro
--

Consulte también
MoveToNext (RT Professional)
Descripción
Ejecuta la función del botón "Registro siguiente" del control.
Sintaxis
Expresión.MoveToNext()
Expresión
Parámetros
--
Consulte también
MoveToNextLine (RT Professional)
Descripción
Ejecuta la función del botón "Aviso siguiente" del visor de avisos.
Sintaxis
Expresión.MoveToNextLine()
Expresión
Parámetro
--

Consulte también
MoveToNextPage (RT Professional)
Descripción
Ejecuta la función del botón "Página siguiente" del visor de avisos.
Sintaxis
Expresión.MoveToNextPage()
Expresión
Parámetro
--
Consulte también
MoveToPrevious (RT Professional)
Descripción
Ejecuta la función del botón "Registro anterior" del control.
Sintaxis
Expresión.MoveToPrevious()
Expresión
Parámetros
--

Consulte también
MoveToPreviousLine (RT Professional)
Descripción
Ejecuta la función del botón "Aviso anterior" del visor de avisos.
Sintaxis
Expresión.MoveToPreviousLine()
Expresión
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
Expresión.MoveToPreviousPage()
Expresión
Parámetro
--

Consulte también
NextColumn (RT Professional)
Descripción
Ejecuta la función del botón "Columna siguiente" del visor de tablas.
Sintaxis
Expresión.NextColumn()
Expresión
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
Expresión.NextTrend()
Expresión
Parámetro
--
Consulte también

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
Expresión.OneToOneView()
Expresión
Parámetro
VARIANT
Consulte también
PasteRows (RT Professional)
Descripción
Ejecuta la función del botón "Insertar líneas" del visor de recetas.
Sintaxis
Expresión.PasteRows()
Expresión
Parámetro
--
Consulte también

PreviousColumn (RT Professional)
Descripción
Ejecuta la función del botón "Columna anterior" del visor de tablas.
Sintaxis
Expresión.PreviousColumn()
Expresión
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
Expresión.PreviousTrend()
Expresión
Parámetro
--
Consulte también

Print (RT Professional)
Descripción
Ejecuta la función del botón "Imprimir" del control.
Sintaxis
Expresión.Print()
Expresión
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
Expresión.QuitHorn()
Expresión
Parámetro
--

Consulte también
QuitSelected (RT Professional)
Descripción
Ejecuta la función del botón "Acuse individual" del visor de avisos.
Sintaxis
Expresión.QuitSelected()
Expresión
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
Expresión.QuitVisible()
Expresión
Parámetro
--
Consulte también

ReadTags (RT Professional)
Descripción
Ejecuta la función del botón "Leer variables" del visor de recetas.
Sintaxis
Expresión.ReadTags()
Expresión
Parámetro
--
Consulte también
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.
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.
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.
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

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]

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.

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

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

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

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.

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

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

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

Sintaxis
Expresión.SelectAll()
Expresión
Parámetro
--
Consulte también
SelectedStatisticAreae (RT Professional)
Descripción
Ejecuta la función del botón "Definir área estadística" del visor de tablas.
Sintaxis
Expresión.SelectedStatisticArea()
Expresión
Parámetro
--
Consulte también
SelectRow (RT Professional)
Descripción
Selecciona una determinada fila en un control basado en tablas.

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( 2, True ), se marcarán las filas
1 y 2.
● Actualmente está marcada la fila 1. Si se llama SelectRow( 2, False ) o SelectRow( 2 ) sin
parámetros opcionales, se marca solo la fila 2.
Consulte también
ServerExport (RT Professional)
Descripción
Ejecuta la función del botón "Exportar fichero" del visor de recetas.
Sintaxis
Expresión.ServerExport()
Expresión
Parámetro
--

Consulte también
ServerImport (RT Professional)
Descripción
Ejecuta la función del botón "Importar fichero" del visor de recetas.
Sintaxis
Expresión.ServerImport()
Expresión
Parámetro
--
Consulte también
ShowColumnSelection (RT Professional)
Descripción
Ejecuta la función del botón "Seleccionar columnas" del visor de tablas.
Sintaxis
Expresión.ShowColumnSelection()
Expresión
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
Expresión.ShowComment()
Expresión
Parámetro
--
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
Expresión.ShowDisplayOptionsDialog()
Expresión
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
Expresión.ShowEmergencyQuitDialog()
Expresión
Parámetro
--
Consulte también
ShowHelp (RT Professional)
Descripción
Ejecuta la función del botón "Ayuda" del control.
Sintaxis
Expresión.ShowHelp()
Expresión
Parámetros
VARIANT
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
Expresión.ShowHideList()
Expresión
Parámetro
--
Consulte también
ShowHitList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de aciertos" del visor de avisos.
Sintaxis
Expresión.ShowHitList()
Expresión
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
Expresión.ShowInfoText()
Expresión
Parámetro
--
Consulte también
ShowLockDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de bloqueos" del visor de avisos.
Sintaxis
Expresión.ShowLockDialog()
Expresión
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
Expresión.ShowLockList()
Expresión
Parámetro
--
Consulte también
ShowLongTermArchiveList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de ficheros de largo plazo" del visor de avisos.
Sintaxis
Expresión.ShowLongTermArchiveList()
Expresión
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
Expresión.ShowMessageList()
Expresión
Parámetro
--
Consulte también
ShowPercentageAxis (RT Professional)
Descripción
Ejecuta la función del botón "Eje relativo" del visor de curvas f(t).
Sintaxis
Expresión.ShowPercentageAxis()
Expresión
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
Expresión.ShowPropertyDialog()
Expresión
Parámetros
VARIANT
Consulte también
ShowSelectArchive (RT Professional)
Descripción
Ejecuta la función del botón "Seleccionar conexión de datos" del visor de recetas.
Sintaxis
Expresión.ShowSelectArchive()
Expresión
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
Expresión.ShowSelection ()
Expresión
Parámetro
--
Consulte también
ShowSelectionDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de selección" del visor de avisos.
Sintaxis
Expresión.ShowSelectionDialog()
Expresión
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
Expresión.ShowSelectTimeBase()
Expresión
Parámetro
--
Consulte también
ShowShortTermArchiveList (RT Professional)
Descripción
Ejecuta la función del botón "Lista de ficheros de corto plazo" del visor de avisos.
Sintaxis
Expresión.ShowShortTermArchiveList()
Expresión
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
Expresión.ShowSort()
Expresión
Parámetro
--
Consulte también
ShowSortDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de ordenación" del visor de avisos.
Sintaxis
Expresión.ShowSortDialog()
Expresión
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
Expresión.ShowTagSelection()
Expresión
Parámetros
--
Consulte también
ShowTimebaseDialog (RT Professional)
Descripción
Ejecuta la función del botón "Diálogo de base de tiempo" del visor de avisos.
Sintaxis
Expresión.ShowTimebaseDialog()
Expresión
Parámetro
--
Consulte también

ShowTimeSelection (RT Professional)
Descripción
Ejecuta la función del botón "Rango de tiempo Seleccionar" del control.
Sintaxis
Expresión.ShowTimeSelection()
Expresión
Parámetros
--
Consulte también
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
Expresión.ShowTrendSelection()
Expresión
Parámetro
-- -
Consulte también

StartStopUpdate (RT Professional)
Descripción
Ejecuta la función del botón "Iniciar" o "Detener" del control.
Sintaxis
Expresión.StartStopUpdate()
Expresión
Parámetros
--
Consulte también
Stop (Panels, Comfort Panels, RT Advanced, RT Professional)
Descripción
Finaliza WinCC Runtime.
Sintaxis
Expression.Stop
Expression
Obligatorio. 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 sólo funciona en el entorno basado en PC. El texto transferido
como parámetro puede visualizarse con las herramientas de diagnóstico "Diagnóstico de
GSC" o "ApDiag". Si se requiere un "trace" sin herramientas externas es posible utilizar la
función de sistema "MostrarAvisoDeSistema".
Sintaxis
Expression.Trace"STRING"
Expression
Obligatorio. Expresión que devuelve un objeto del tipo "HMIRuntime".
Parámetro
STRING
Texto que se emitirá como aviso de depuración. El texto transferido puede visualizarse con
las herramientas de diagnóstico "Diagnóstico de GSC" o "ApDiag". Si se requiere un "trace"
sin herramientas externas es posible utilizar la función de sistema "MostrarAvisoDeSistema".
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
Expresión.UnhideAlarm()

Expresión
Parámetro
--
Consulte también
UnlockAlarm (RT Professional)
Descripción
Ejecuta la función del botón "Habilitar aviso" del visor de avisos.
Sintaxis
Expresión.UnlockAlarm()
Expresión
Parámetro
--
Consulte también
UnselectAll (RT Professional)
Descripción
Elimina todas las marcas de las celdas de un control basado en tablas.
Sintaxis
Expresión.UnselectAll()
Expresión

Parámetro
--
Consulte también
UnselectRow (RT Professional)
Descripción
Elimina las marcas de una determinada celda de un control basado en tablas.
Sintaxis
Expresión.UnselectRow(ByVal IRow As Long)
Expresión
Parámetro
Long
IRow Número de fila que se ha de seleccionar.
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
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.
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".
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
Expresión.WriteTags()
Expresión
Parámetro
--
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
Expresión.ZoomArea()
Expresión
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
Expresión.ZoomInOut()
Expresión
Parámetro
--
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
Expresión.ZoomInOutTime()
Expresión
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
Expresión.ZoomInOutValues()
Expresión
Parámetro
--
Consulte también
ZoomInOutX (RT Professional)
Descripción
Ejecuta la función del botón "Zoom eje X +/-" del visor de curvas f(x).
Sintaxis
Expresión.ZoomInOutX()

Expresión
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
Expresión.ZoomInOutY()
Expresión
Parámetro
--
Consulte también
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
Expresión.ZoomMove()
Expresión
Obligatorio. Una expresión que dev

WCC Professional V13 SP2 Prog EsES Es-ES

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

WCC Professional V13 SP2 Prog EsES Es-ES

Hochgeladen von

Copyright:

Verfügbare Formate

C-Scripting (RT Professional) 1

API de runtime (RT

Impresión de la Ayuda en pantalla

1 C-Scripting (RT Professional).....................................................................................................................23

WinCC Professional V13 SP2 - Referencia para programación

1.1.27 SetBitInTag (RT Professional)...............................................................................................85

WinCC Professional V13 SP2 - Referencia para programación

1.1.39.19 uaArchiveGetSor (RT Professional).....................................................................................142

WinCC Professional V13 SP2 - Referencia para programación

1.3.1 Definición de estructura CCAPErrorExecute (RT Professional)..........................................181

WinCC Professional V13 SP2 - Referencia para programación

2.2.2.31 MCP_VARIABLE_LIMITS5 (RT Professional).....................................................................263

WinCC Professional V13 SP2 - Referencia para programación

2.2.6.9 DM_ENUM_VAR_PROC (RT Professional).........................................................................340

WinCC Professional V13 SP2 - Referencia para programación

2.2.10.1 DMBeginStartVarUpdate (RT Professional).........................................................................453

WinCC Professional V13 SP2 - Referencia para programación

2.3.1.4 constantes (RT Professional)...............................................................................................526

WinCC Professional V13 SP2 - Referencia para programación

2.4.4.3 GSCGenCompile (RT Professional)....................................................................................622

WinCC Professional V13 SP2 - Referencia para programación

2.5.7.2 PWRTGetLoginPriority (RT Professional)............................................................................675

WinCC Professional V13 SP2 - Referencia para programación

2.7.1.2 Constantes (RT Professional)..............................................................................................727

WinCC Professional V13 SP2 - Referencia para programación

2.8.2.3 TLG_BACKUP_TABLE_INFO (RT Professional).................................................................814

WinCC Professional V13 SP2 - Referencia para programación

2.8.7 Funciones para representación de curvas y tablas (RT Professional).................................896

WinCC Professional V13 SP2 - Referencia para programación

2.9.4.6 uaArchiveGetSort (RT Professional)....................................................................................967

WinCC Professional V13 SP2 - Referencia para programación

2.10.2.5 MSG_CLASS_STRUCT_PLUS (RT Professional).............................................................1036

WinCC Professional V13 SP2 - Referencia para programación

2.10.10 Funciones para la edición de textos de información (RT Professional).............................1107

WinCC Professional V13 SP2 - Referencia para programación

3.1.25 ExportDataRecordsWithChecksum (Panels, Comfort Panels, RT Advanced)...................1174

WinCC Professional V13 SP2 - Referencia para programación

3.1.77 SetRecipeTags (Panels, Comfort Panels, RT Advanced)..................................................1222

WinCC Professional V13 SP2 - Referencia para programación

3.4.1 VBScript para Windows CE (Panels, Comfort Panels)......................................................1271

WinCC Professional V13 SP2 - Referencia para programación

3.5.3.15 ScreenItems (lista) (RT Professional)................................................................................1325

WinCC Professional V13 SP2 - Referencia para programación

1.1.1 ActivateNextScreen (RT Professional)

WinCC Professional V13 SP2 - Referencia para programación

El valor de retorno guardado puede procesarse en el código subsiguiente.

//Open next screen

1.1.2 ActivatePreviousScreen (RT Professional)

WinCC Professional V13 SP2 - Referencia para programación

//Open previous screen

1.1.3 ActivateScreen (RT Professional)

Utilización en la lista de funciones

Utilización en funciones definidas por el usuario

WinCC Professional V13 SP2 - Referencia para programación

Número del objeto

// User defined code

1.1.4 ActivateScreenInScreenWindow (RT Professional)

Utilización en la lista de funciones

WinCC Professional V13 SP2 - Referencia para programación

Utilización en funciones definidas por el usuario

Nuevo nombre de imagen

1.1.5 ActivateStartScreen (RT Professional)

WinCC Professional V13 SP2 - Referencia para programación

//Open start screen