System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Functionality here is mostly identical with that of a tag object. In the following, only deviations
thereof are described.
Expression
Necessary. An expression which returns an object of type "TagSet".
Reading From the Process Image
The TagSet object offers the advantage of requesting several tags in one read command. The
tags are registered in the process image as a group, improving performance in the process.
Direct reading
Since one call may process several read commands, performance is enhanced in comparison
to single calls.
Example:
The following example shows how tags are included in the TagSet list, how tag values are
imported and subsequently read.
'VBS174
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.Read
HMIRuntime.Trace "Motor1: " & group("Motor1").Value & vbNewLine
HMIRuntime.Trace "Motor2: " & group("Motor2").Value & vbNewLine
If the optional parameter "Readmode" is set to 1, the process tags are not registered but read
directly from AS or channel.
group.Read 1
See also
Example: How to Read Tag Values (Page 741)
Example: Writing tag values (Page 739)
LastError Property (Page 407)
ErrorDescription Property (Page 363)
TagSet Object (List) (Page 151)
Tag Object (Page 146)
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
701
Read Tags method
Function
Executes the "Read tags" key function of the UserArchiveControl.
Syntax
Ausdruck.ReadTags()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
Refresh Method
Function
Drawing all visible pictures again.
syntax
Expression.Refresh
Expression
Necessary. An expression which returns a "Screens" or "Screen" type object.
Parameters
--
Examples
The first example forces all visible pictures to be drawn again:
'VBS149
HMIRuntime.Screens.Refresh
The second example forces the basic picture to be immediately redrawn:
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
702
System Manual, 11/2008,
'VBS150
HMIRuntime.Screens(1).Refresh
See also
Screen Object (Page 140)
Screens Object (List) (Page 143)
HMIRuntime Object (Page 125)
Remove Method
Description of TagSet Object
Removes a tag from the TagSet list. The tag may be removed by name or reference to a tag
object.
syntax
Expression.Remove [Tag]
Expression
Necessary. An expression which returns an object of type "TagSet".
Parameters
VARIANT
Parameters Description
Tag Name of a WinCC tag or reference to a tag object
to be removed from the list.
Example:
The following example shows how several tags are included in the TagSet list, and how to
remove a tag again.
'VBS175
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
703
group.Remove "Motor1"
Description of DataSet Object
Deletes the element specified in parameter "Name" from a list.
syntax
Expression.Remove [Name]
Expression
Necessary. An expression which returns an object of type "DataSet".
Parameters
VARIANT
Parameters Description
Name Name of the object to be removed from the list.
Example:
The example shows how to remove the object "motor1" from the list.
'VBS166
HMIRuntime.DataSet.Remove("motor1")
Description of objects Logging, AlarmLogs, DataLogs
The method deletes a previously swapped archive segment from the Runtime project.
Archive segments deleted with the "Remove" method are removed from the common archiving
directory of the project.
The call may require a somewhat longer time period, depending on archive data. This may
block the processing of subsequent scripts. Blockage of actions within the picture may be
avoided if you start the call in a Global Scripting action, such as starting the action through a
triggering tag.
The archive separation and deletion creates a CPU load. This will affect performance.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
704
System Manual, 11/2008,
Note
Calling up the "Remove" method is presently only possible at the server. There is an example,
however, which shows how the method may be started by the client from a server.
For redundancy, the following applies: Re-swapped archives are deleted with the "Remove"
method only on the computer from which the method was initiated.
syntax
Objects Logging, AlarmLogs
Expression.Remove [TimeFrom] [TimeTo] [TimeOut] [ServerPrefix]
Expression
Necessary. An expression which returns an object of type "Logging" or "AlarmLogs".
Object DataLogs
Expression.Remove [TimeFrom] [TimeTo] [TimeOut] [Type] [ServerPrefix]
Expression
Necessary. An expression which returns an object of type "DataLogs".
Parameters
TimeFrom
Point in time, from which the archives are to be deleted.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
TimeTo
Time up to which archive segments are to be deleted.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
Timeout
Timeout in milliseconds.
If you enter "-1" as a value, the wait will be infinite. If you enter a value of "0", there will be no
wait.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
705
Type:
Type of archive.
The parameter can (optionally) be used only to delete archive segments of the tag
logging.
The following values can be entered:
Assigned Value Type Description
1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reserved for future versions.
Return value
If an error occurred during deletion of the archive segments, the method will return an error
message. Additional information may be found under the subject heading "Error Messages
from Database Area".
Time format
Time format is defined as follows: YYYY-MM-DD hh:mm:ss, where YYYY represents the year,
MM
the month, DD the day, hh the hour, mm the minute and ss the second. For example, the
time of 2 minutes and one second past 11 o'clock on July 26, 2004 is displayed as follows:
2004-07-26 11:02:01.
For parameters "TimeFrom" and "TimeTo" the statement of data and time is also possible in
short form. Not all format fields must be filled in this case. The short form means that the
information on date and time may be lacking one or several parameters, beginning with the
value for seconds. For example, the statement may be in the form of "YYYY-MM" or "YYYY-
MM-DD hh". Using the statement "TimeFrom" = "2004-09" and "TimeTo" = "2004-10-04" all
archive segments between September 2004 up to and including October 4th are to be
swapped.
Example:
In the following example, archive segments re-swapped after the fact for a specified time period
may be removed and the return value may be output as Trace.
'VBS182
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("2004-08-22","2004-09-22",-1) &
vbNewLine
In the following example, all archive segments re-swapped after the fact may be removed and
the return value may be output as Trace.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
706
System Manual, 11/2008,
'VBS183
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("","",-1) & vbNewLine
See also
Error Messages from Database Area (Page 732)
Example: How to Start an Action on the Server (Logging Object) (Page 746)
Logging Object (Page 130)
DataSet-Objekt (List) (Page 122)
DataLogs Object (Page 121)
AlarmLogs Object (Page 118)
TagSet Object (List) (Page 151)
RemoveAll Method
Description of TagSet Object
Deletes all tags from a TagSet list.
syntax
Expression.RemoveAll
Expression
Necessary. An expression which returns an object of type "TagSet".
Parameters
--
Example:
The following example shows how several tags are included in the TagSet list, and how to
remove all tags again.
'VBS176
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.RemoveAll
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
707
Description of DataSet Object
Deletes all values or object references from a DataSet list.
syntax
Expression.RemoveAll
Expression
Necessary. An expression which returns an object of type "DataSet".
Parameters
--
Example:
The example shows how all objects are removed from the list.
'VBS167
HMIRuntime.DataSet.RemoveAll
See also
DataSet-Objekt (List) (Page 122)
TagSet Object (List) (Page 151)
Tag Object (Page 146)
Restore Method
Description of objects Logging, AlarmLogs, DataLogs
The method adds swapped archive segments to the Runtime project.
Upon swapping, the archive segments are copied to the common archiving directory of the
project. Therefore, the appropriate storage capacity must be available.
The call may require a somewhat longer time period, depending on archive data. This may
block the processing of subsequent scripts. Blockage of actions within the picture may be
avoided if you start the call in a Global Scripting action, such as starting the action through a
triggering tag.
Linking / copying of the archives generates a CPU load because the SQL server experiences
additional load because of turned-on signature checking in particular. Copying of archive
segments will slow down hard disk access.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
708
System Manual, 11/2008,
Upon turned-on signature checking, an error message is returned if an unsigned or modified
archive is to be swapped. There is always only one error message returned, even if several
errors
occurred during the swap process. Additionally, a WinCC system message is generated
for each archive segment. An entry is added to the Windows event log in the "Application"
section. This provides the opportunity to check which archive segments are creating the error.
● With an unsigned archive, the return value "0x8004720F" is returned. The archive is stored.
The following text is entered in the event display:
"Validation of database <db_name> failed! No signature found!"
●
With an changed archive, the return value "0x80047207" is returned. The even screen, the
entry is "Validation of database <db_name> failed !".
The archive is not stored.
Note
Calling up the "Restore" method is presently only possible at the server. There is an
example, however, which shows how the method may be started by the client from a
server.
For redundancy, the following applies: Upon re-swapping of archives with the "Restore"
method, only archive segments are added to the Runtime project on the computer from
which the method was called.
Syntax
Objects Logging, AlarmLogs
Expression.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut]
[ServerPrefix]
Expression
Required. An expression which returns an object of type "Logging" or "AlarmLogs".
Object DataLogs
Expression.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut] [Type]
[ServerPrefix]
Expression
Required. An expression which returns an object of type "DataLogs".
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
709
Parameter
SourcePath
Path to archive data.
TimeFrom
Point in time, from which the archives are to be stored.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
TimeTo
Time up to which archive segments are to be swapped.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
Timeout
Timeout in milliseconds.
If you enter "-1" as a value, the wait will be infinite. If you enter a value of "0", there will be no
wait.
Type
Type of archive.
The parameter can (optionally) be used only to store archive segments of the tag
logging.
The following values can be entered:
Assigned Value Type Description
1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reserved for future versions.
Return value
If an error occurred during swapping of archive segments, the method will return an error
message. Additional information may be found under the subject heading "Error Messages
from Database Area".
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
710
System Manual, 11/2008,