System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
See also
CreateTlgTag Function (Page 2451)
ListTlgTag Function (Page 2463)
ListTlgArchive Function (Page 2461)
GetTlgArchive Function (Page 2458)
DeleteTlgTag Function (Page 2457)
DeleteTlgArchive Function (Page 2455)
CreateTlgArchive Function (Page 2448)
CommitTlgTag Function (Page 2446)
CommitTlgArchive Function (Page 2445)
CloseTlgTag Function (Page 2443)
CloseTlgArchive-Funktion (Page 2442)
VBA in Tag Logging (Page 2438)
4.6.3.12 ListTlgArchive Function
Description
Alternatively, the ListTlgArchive function returns the following Tag Logging values in a list:
● All existing Tag Logging archives
● All existing cycles / timers
syntax
Expression.ListTlgArchive(ListType,pListArray,[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2461
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TLG_ARCHIVE_LIST_TYPE) Defines which content should be returned in a list.
Possibilities are:
● TLG_ARCHIVE_NAMES (1) All created Tag
Logging archives
● TLG_ARCHIVE_TRIGGER_NAMES (2) All
created cycles / timers
pListArray (Variant) List with the requested content.
Filter (String) Filters can be set optionally. A trigger name can
be used as a filter. Wildcards "*" and "?" are also
possible.
Example:
In the following example, a check is made whether archives are configured:
Sub ReadTlgArchives()
'HMIGO_028
'read content in tag logging
'no archives are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
'read all tlg archives
objHMIGO.ListTlgArchive TLG_ARCHIVE_NAMES, arrContent
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no tag logging archives are implemented"
End If
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2462
System Manual, 11/2008,
See also
ListTlgTag Function (Page 2463)
GetTlgArchive Function (Page 2458)
DeleteTlgTag Function (Page 2457)
DeleteTlgArchive Function (Page 2455)
CreateTlgTag Function (Page 2451)
CreateTlgArchive Function (Page 2448)
CommitTlgTag Function (Page 2446)
CommitTlgArchive Function (Page 2445)
CloseTlgTag Function (Page 2443)
CloseTlgArchive-Funktion (Page 2442)
VBA in Tag Logging (Page 2438)
4.6.3.13 ListTlgTag Function
Description
The ListTlgTag function returns all the tags created in a Tag Logging archive in a list.
syntax
Expression.ListTlgTag(ListType,ListArray,[ArchiveName],[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TLG_TAG_LIST_TYPE) Defines which content should be returned in a list.
Possibilities are:
TLG_TG_NAMES (1) All tags created in a Tag
Logging archive
ListArray (Variant) List with the requested content.
ArchiveName (String) Name of the archive in Tag Logging (optional). If
the
name of the archive is not specified, all,archive
tags are returned.
Filter (String) Filters can be set optionally. Wildcards "*" and "?"
are also possible.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2463
Example:
In the following example, a check is made whether the archive tags are configured in the
"Process Archive":
Sub ReadTlgTag()
'HMIGO_029
'read content in tag logging
'no tags within archives are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
Dim strArchive as String
'set tlg archive name
strArchive = "processarchive"
'read all tlg tags in specified archive
objHMIGO.ListTlgTag TLG_TAG_NAMES, arrContent, strArchive
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no tag logging tags in specified archive are implemented"
End If
End Sub
See also
ListTlgArchive Function (Page 2461)
GetTlgArchive Function (Page 2458)
DeleteTlgTag Function (Page 2457)
DeleteTlgArchive Function (Page 2455)
CreateTlgTag Function (Page 2451)
CreateTlgArchive Function (Page 2448)
CommitTlgTag Function (Page 2446)
CommitTlgArchive Function (Page 2445)
CloseTlgTag Function (Page 2443)
CloseTlgArchive-Funktion (Page 2442)
VBA in Tag Logging (Page 2438)
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2464
System Manual, 11/2008,
4.6.4 VBA in the Text Library
4.6.4.1 VBA in the Text Library
Introduction
VBA allows you to generate Text Library texts directly from the program code, modify and
delete them, and display text IDs and texts.
Principle
When you have created the instance of the HMIGO class, the following functions are available
to you to access the TextLibrary:
● CreateTextLanguage
● CreateText
● DeleteText
● DeleteTextLanguage
● GetText
● GetTextID
● ListText
● ModifyText
The enumerations "HMIGO_TEXT_CREATE_MODE" and "HMIGO_TEXT_LIST_TYPE"are
available for the parameter assignment of these functions.
Note
The TextLibrary must not be open or be opened when editing using VBA.
See also
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetTextID Function (Page 2473)
GetText Function (Page 2471)
DeleteTextLanguage Function (Page 2470)
DeleteText Function (Page 2468)
CreateText Function (Page 2467)
CreateTextLanguage Function (Page 2466)
VBA in Other WinCC Editors (Page 2424)
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2465
4.6.4.2 CreateTextLanguage Function
Description
Creates a language in the Text Library.
syntax
Expression.CreateTextLanguage(LanguageID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID for the language to be created (e.g. 1031 for
German, 1033 for English, etc.)
For a table of all language codes refer to the
WinCC online help on "Language Identifiers".
Example:
Sub CreateTextLanguage()
' HMIGO_016
' procedure to create a language in text library
' language must not be created before
' LanguageID german = 1031
' LanguageID english(US) = 1033
' LanguageID spanish = 1034
' LanguageID french = 1040
' LanguageID farsi= 1065
' declarations
Dim objHMIGO As HMIGO
Dim lngLangugeNumber As Long
Set objHMIGO = New HMIGO
lngLangugeNumber = 1065 'farsi
'create new language
objHMIGO.CreateTextLanguage lngLangugeNumber
Set objHMIGO = Nothing
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2466
System Manual, 11/2008,
See also
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetTextID Function (Page 2473)
GetText Function (Page 2471)
DeleteTextLanguage Function (Page 2470)
DeleteText Function (Page 2468)
CreateText Function (Page 2467)
VBA in the Text Library (Page 2465)
4.6.4.3 CreateText Function
Description
Creates a new text for the language specified. Text input for other languages can be added
using ModifyText.
syntax
Expression.CreateText(LanguageID,Text,CreateMode,TextID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language for which the text will be created.
Text (string) Text to be created.
CreateMode (HMIGO_TEXT_CREATE_MODE) Mode of text creation:
● TEXT_ADD_REFCOUNT (0) only increases
the reference counter when an identical text
already exists.
● TEXT_CREATE_ALWAYS (1) always sets up
a new text line and inserts the text in it.
TextID (long) Returns the TextID assigned to the new text or the
TextID
whose reference counter is increased. This
ID is required for processing the text in other
functions.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2467
Example:
Sub CreateText()
' HMIGO_017
' procedure to create a new text
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextCreateMode As Long
Dim lngTextID As Long 'return value of ".CreateText"
Dim strText As String
Set objHMIGO = New HMIGO
strText = "new text"
'LanguageID = english
lngLanguageID = 1033
'"TEXT_ADD_REFCOUNT" check if text exists, if not create new text
lngTextCreateMode = 0
'"TEXT_CREATE_ALWAYS" create always a new text (for messages)
' lngTextCreateMode = 1
'create new text
objHMIGO.CreateText lngLanguageID, strText, lngTextCreateMode, lngTextID
'show TextID of created text
MsgBox "TextID: " & lngTextID, vbOKOnly, "Result CreateText"
Set objHMIGO = Nothing
End Sub
See also
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetTextID Function (Page 2473)
GetText Function (Page 2471)
DeleteTextLanguage Function (Page 2470)
DeleteText Function (Page 2468)
CreateTextLanguage Function (Page 2466)
VBA in the Text Library (Page 2465)
4.6.4.4 DeleteText Function
Description
Deletes a line of text. All the languages for the corresponding line of text and the line of text
itself are deleted.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2468
System Manual, 11/2008,
syntax
Expression.DeleteText(TextID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
TextID (long) ID of the line of text to be deleted
Example:
Sub DeleteText()
' HMIGO_018
' procedure to delete a text
' text will be searched and deleted
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long 'return value of GetTextID
Dim strText As String
On Error GoTo ErrorHandler
Set objHMIGO = New HMIGO
strText = "new text"
lngLanguageID = 1033
'first: find text in text library and return TextID
objHMIGO.GetTextID 1033, strText, lngTextID
'if searched text exists: delete this text
If Not lngTextID = -1 Then
objHMIGO.DeleteText lngTextID
MsgBox "Text : """ & strText & """ found in TextID: " & lngTextID & vbNewLine & _
"TextID is deleted!", vbOKOnly, "Result DeleteText"
Else
MsgBox "Text : """ & strText & """ not found." & vbNewLine & _
"No Text deleted!", vbOKOnly, "Result DeleteText"
End If
Set objHMIGO = Nothing
Exit Sub
ErrorHandler:
'if lngText = (-1),searched text does not exit
If lngTextID = -1 Then
'reset errorhandler
Err.Clear
Resume Next
End If
MsgBox "ErrNr. : " & Err.Number & vbNewLine & _
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2469
"ErrDes.: " & Err.Description, vbOKOnly, "Error ocurred"
'reset errorhandler
Err.Clear
End Sub
See also
VBA in the Text Library (Page 2465)
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetTextID Function (Page 2473)
GetText Function (Page 2471)
DeleteTextLanguage Function (Page 2470)
CreateText Function (Page 2467)
CreateTextLanguage Function (Page 2466)
4.6.4.5 DeleteTextLanguage Function
Description
Enables a language to be deleted from the TextLibrary. In this case, all the texts in this
language are also deleted.
syntax
Expression.DeleteTextLanguage(LanguageID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language to be deleted
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2470
System Manual, 11/2008,