System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Example:
In the following example, a check is made whether the language '1036' exists. If it does, it will
be deleted.
Sub DeleteLanguage()
'HMIGO_030
' delete an existing languages in TextLibrary
' language '1036'/spanish has to exist
Dim objHMIGO As New HMIGO
Dim varRange As Variant
Dim intLanguage As Long
Dim lngPointer As Long
' get all existing languages
objHMIGO.ListText TEXT_LANGUAGE_IDS, arrContent
' check requested list for language '1036'/ spanish and delete
For lngPointer = LBound(arrContent) To UBound(arrContent)
intLanguage = arrContent(lngPointer) + Val("&H400")
If intLanguage = 1036 Then
'delete language
objHMIGO.DeleteTextLanguage intLanguage
End If
Next lngPointer
End Sub
See also
GetText Function (Page 2471)
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetTextID Function (Page 2473)
DeleteText Function (Page 2468)
CreateText Function (Page 2467)
CreateTextLanguage Function (Page 2466)
VBA in the Text Library (Page 2465)
4.6.4.6 GetText Function
Description
Returns the text for the selected text ID in the selected language.
syntax
Expression.GetText(LanguageID,TextID,Text)
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2471
Expression
Necessary. An expression that returns an object of the type "HMIGeneralObjects".
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language of the text to be read
TextID (long) ID of the line of text from which text is to be read
Text (string) Returns the text of the selected line of text and
language.
Example:
Sub GetText()
' HMIGO_019
' procedure to get a text
' text with TextID = '69' need to be created
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long
Dim strText As String 'return value of GetText
Set objHMIGO = New HMIGO
lngTextID = 69
lngLanguageID = 1033
'find text text library
objHMIGO.GetText lngLanguageID, lngTextID, strText
'show found text
MsgBox "Read Text in TextID : " & lngTextID & " is """ & strText & """ !", _
vbOKOnly, "Result GetText"
Set objHMIGO = Nothing
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2472
System Manual, 11/2008,
See also
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetTextID Function (Page 2473)
DeleteTextLanguage Function (Page 2470)
DeleteText Function (Page 2468)
CreateText Function (Page 2467)
CreateTextLanguage Function (Page 2466)
VBA in the Text Library (Page 2465)
4.6.4.7 GetTextID Function
Description
Returns the ID of the text searched for in the selected language.
If there are several texts with the same contents, only the line of text with the lowest ID is
returned. Whether there are several lines of text with the same contents depends on the
CreateMode of the CreateText function.
syntax
Expression.GetTextID(LanguageID,Text,TextID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language of the text searched for
Text (string) The text searched for
TextID (long) ID of the line of text in which the text searched for
was found
Example:
Sub GetTextID()
' HMIGO_020
' procedure to search a TextID
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2473
' text will be searched and a TextID will be returned
' 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 = "old 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
MsgBox "Text : """ & strText & """ found in TextID: " & lngTextID, _
vbOKOnly, "Result GetTextID"
Else
MsgBox "Text : """ & strText & """ not found!", vbOKOnly, "Result GetTextID"
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 & _
"ErrDes.: " & Err.Description, vbOKOnly, "Error ocurred"
'reset errorhandler
Err.Clear
End Sub
See also
ModifyText Function (Page 2476)
ListText Function (Page 2475)
GetText Function (Page 2471)
DeleteTextLanguage Function (Page 2470)
DeleteText Function (Page 2468)
CreateText Function (Page 2467)
CreateTextLanguage Function (Page 2466)
VBA in the Text Library (Page 2465)
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2474
System Manual, 11/2008,
4.6.4.8 ListText Function
Description
Alternatively, the ListText function returns the following contents of the TextLibrary as a list:
● All languages created
● All text IDs
● All texts in a specific language
syntax
Exoression.ListText(ListType,pListArray,[LanguageID],[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TEXT_LIST_TYPE) Defines which content should be returned as a list.
Possibilities are:
● TEXT_LANGUAGE_IDS (1) All the created
languages.
The result still has to be converted
by adding 400hex.
● TEXT_IDS (2) All text IDs.
● TEXT_TEXTS (3) All texts in a language.
pListArray (Variant) List with the requested content.
LanguageID (Long) The language ID whose text is to be returned.
Filter (String) Filters can be set optionally. Wildcards "*" and "?"
are also possible.
Example:
In the following example, a check is made whether the list with the text of a language is empty
because the language does not exist:
Sub ReadTextsByLanguage()
'HMIGO_031
'read content in textLibrary by language
Dim objHMIGO As New HMIGO
Dim varRange As Variant
Dim intLanguage As Integer
'set invalid language ID
intLanguage = 1051 'language does not exist
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2475
'read all texts
objHMIGO.ListText TEXT_TEXTS, arrContent, intLanguage
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because wrong language selection"
End If
End Sub
See also
ModifyText Function (Page 2476)
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.9 ModifyText Function
Description
Modifies the text for the selected language with the ID specified.
syntax
Expression.ModifyText(LanguageID,TextID,Text)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language of the text to be changed.
TextID (long) ID of the language of the text to be changed.
Text (string) New text to be inserted.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2476
System Manual, 11/2008,
Example:
Sub ModifyText()
' HMIGO_021
' procedure to modify a text
' text will be searched and replaced
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long 'return value of GetTextID
Dim strOldText As String
Dim strNewText As String
On Error GoTo ErrorHandler
Set objHMIGO = New HMIGO
strOldText = "old text"
strNewText = "new text"
lngLanguageID = 1033
'first: find text in text library and return TextID
objHMIGO.GetTextID 1033, strOldText, lngTextID
'if searched text exists: replace this text
If Not lngTextID = -1 Then
objHMIGO.ModifyText lngLanguageID, lngTextID, strNewText
MsgBox "Text : """ & strOldText & """ found in TextID: " & lngTextID & vbNewLine & _
"Text replaced with : """ & strNewText & """ !", vbOKOnly, "Result DeleteText"
Else
MsgBox "Text : """ & strOldText & """ not found." & vbNewLine & _
"No Replacements done!", 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 & _
"ErrDes.: " & Err.Description, vbOKOnly, "Error ocurred"
'reset errorhandler
Err.Clear
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2477
See also
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 the Text Library (Page 2465)
4.6.5 VBA in Alarm Logging
4.6.5.1 VBA in Alarm Logging
Introduction
VBA allows you to create messages directly from the program code, modify them, and delete
them.
Principle
When you have created the instance of the HMIGO class, the following functions are available
to you to access Alarm Logging:
● CloseSingleAlarm
● CommitSingleAlarm
● CreateSingleAlarm
● DeleteSingleAlarm
● GetSingleAlarm
● ListSingleAlarm
Enumeration "HMIGO_SINGLE_ALARM_CLASS_IDS" and
"HMIGO_SINGLE_ALARM_LIST_TYPE" is available for parameter assignment of this
function.
Note
You should not have or should not open the Alarm Logging when editing with VBA.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2478
System Manual, 11/2008,
Access to the Object Properties
You can also access the parameters of the above-mentioned functions directly in VBA by
means of the following object properties:
Object property Description Read/Write
ObjectStateSingleAlarm Returns the object state via the enumeration
HMIGO_OBJECT_STATE. Further information on this enumeration
can be found in this documentation under "VBA in other WinCC
Editors".
Yes/no
SingleAlarmMessageNumber Number of the message Yes/no
SingleAlarmAGNumber AS Number Yes/yes
SingleAlarmCPUNumber CPU number of the AGs. Yes/yes
SingleAlarmClassID Message class of the message. Possible values of the Enum
SINGLE_ALARM_CLASS_IDS:
● SINGLE_ALARM_ERROR (1)
● SINGLE_ALARM_CLASS_2 (2)
● SINGLE_ALARM_CLASS_3 (3)
● SINGLE_ALARM_CLASS_4 (4)
● SINGLE_ALARM_CLASS_5 (5)
● SINGLE_ALARM_CLASS_6 (6)
● SINGLE_ALARM_CLASS_7 (7)
● SINGLE_ALARM_CLASS_8 (8)
● SINGLE_ALARM_CLASS_9 (9)
● SINGLE_ALARM_CLASS_10 (10)
● SINGLE_ALARM_CLASS_11 (11)
● SINGLE_ALARM_CLASS_12 (12)
● SINGLE_ALARM_CLASS_13 (13)
● SINGLE_ALARM_CLASS_14 (14)
● SINGLE_ALARM_CLASS_15 (15)
● SINGLE_ALARM_CLASS_16 (16)
● SINGLE_ALARM_CLASS_SYSTEM_REQUIRE_ACKNOWLEDG
EMENT (17)
● SINGLE_ALARM_CLASS_SYSTEM_WITHOUT_ACKNOWLEDG
EMENT (18)
Yes/yes
SingleAlarmMessageTypeID Type ID of the message. The permissible values depend on the
message class:
● Class 1: Values from 1 to 16
● Class 2: Values from 17 to 32
● Class 3: Values from 33 to 48
● ...
● Class 18: Values from 263 to 288
Yes/yes
SingleAlarmTextXXID
XX = 1...10
The properties SingleAlarmText1ID to SingleAlarmText10ID exist for
the user texts 1 to 10.
Yes/yes
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2479
Object property Description Read/Write
SingleAlarmTagNameProcessVal
ueXX
XX = 1...10
For the process values there are the properties
SingleAlarmTagNameProcessValue1 through 10
If you want to delete a configured process value, you must describe
this parameter with a tag of the type "Long", which has the value "0".
1)
Yes/yes
SingleAlarmTagName Tag name for event Yes/yes
SingleAlarmMessageBit Bits for bit reporting procedure Yes/yes
SingleAlarmQuitTag Tag name for acknowledgment status Yes/yes
SingleAlarmQuitBits Bit for bit reporting procedure Yes/yes
SingleAlarmStateTag Tag for status query Yes/yes
SingleAlarmStateBits Bit for status tag Yes/yes
SingleAlarmNormDLL Name of the conversion DLL Yes/yes
SingleAlarmQuitSingle Acknowledgment of the messages, TRUE or FALSE possible Yes/yes
SingleAlarmHornActivate Activation of the horn, TRUE or FALSE possible Yes/yes
SingleAlarmArchiving Archiving of the message, TRUE or FALSE possible Yes/yes
SingleAlarmProtocol Logging of the message, TRUE or FALSE possible Yes/yes
SingleAlarmFlankInvert Triggering of message at falling edge, TRUE or FALSE possible Yes/yes
SingleAlarmLockedOnStart Message is disabled at system startup, TRUE or FALSE possible Yes/yes
SingleAlarmGlobalAPFunction Forward message to global AP function, TRUE or FALSE possible Yes/yes
SingleAlarmActionName Name of the action Yes/yes
SingleAlarmActionParams Parameters of the action Yes/yes
SingleAlarmInfoText Information text for message Yes/yes
SingleAlarmGroup Name of the user-defined group message assigned to a message. Yes/yes
1)
Sub DeleteSingleAlarmTagNameProcessValue1()
'HMIGO_033
Dim objGO as HMIGO
Dim var as Long
var = 0
Set objGO = new HMIGO
'message 1 will be modified
objGO.GetSingleAlarm 1
objGO.SingleAlarmTagNameProcessValue1 = var
objGO.CommitSingleAlarm
Set objGO = nothing
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2480
System Manual, 11/2008,