System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
See also
ListSingleAlarm Function (Page 2489)
GetSingleAlarm Function (Page 2488)
DeleteSingleAlarm Function (Page 2487)
CreateSingleAlarm Function (Page 2483)
CommitSingleAlarm Function (Page 2482)
CloseSingleAlarm Function (Page 2481)
VBA in Other WinCC Editors (Page 2424)
4.6.5.2 CloseSingleAlarm Function
Description
Closes the message which is open.
Note
Modified parameters are not saved. If the current value should be saved, execute the
CommitSingleAlarm() function again.
syntax
Expression.CloseSingleAlarm()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
Example:
Sub CloseSingleAlarm()
' HMIGO_22
' procedure to open a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2481
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'open a singlealarm
objHMIGO.GetSingleAlarm lngMsgNumber
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'close a singlealarm
objHMIGO.CloseSingleAlarm
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
See also
ListSingleAlarm Function (Page 2489)
GetSingleAlarm Function (Page 2488)
DeleteSingleAlarm Function (Page 2487)
CreateSingleAlarm Function (Page 2483)
CommitSingleAlarm Function (Page 2482)
VBA in Alarm Logging (Page 2478)
4.6.5.3 CommitSingleAlarm Function
Description
Writes the changed parameters of the open message to WinCC.
Note
To change further parameters after a CommitSingleAlarm call, write these changes to WinCC
by calling the function again.
syntax
Expression.CommitSingleAlarm()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2482
System Manual, 11/2008,
Example:
Sub CommitSingleAlarm()
' HMIGO_023
' procedure to change a property of a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Dim lngMsgBitNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
lngMsgBitNumber = 10
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'open a singlealarm
objHMIGO.GetSingleAlarm lngMsgNumber
'current status is "OPENED" for changes
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'change a property
objHMIGO.SingleAlarmMessageBit = lngMsgBitNumber
'current status is "MODIFIED" for changes
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'commit a single alarm
objHMIGO.CommitSingleAlarm
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
See also
ListSingleAlarm Function (Page 2489)
GetSingleAlarm Function (Page 2488)
DeleteSingleAlarm Function (Page 2487)
CreateSingleAlarm Function (Page 2483)
CloseSingleAlarm Function (Page 2481)
VBA in Alarm Logging (Page 2478)
4.6.5.4 CreateSingleAlarm Function
Description
Creates a new message.
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2483
syntax
Expression.CreateSingleAlarm(MessageNumber,ClassID,MessageTypeID,Tex
t1ID,MessageTagName,MessageBit)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
MessageNumber (long) Number of the message.
● If an unused message number is specified
here, it is accepted.
● If the value "0" is entered, the message number
is freely assigned by the system. In this case,
the message number is given back here.
ClassID (HMIGO_SINGLE_ALARM_CLASS_IDS) Message class. The possible values are in the
table Enum
HMIGO_SINGLE_ALARM_CLASS_IDS.
MessageTypeID (Integer) 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
Text1ID (Long) ID for the first user text. The ModifySingleAlarm
function can be used to define nine further user
texts (1-10).
MessageTagName (String) Tag name for the event.
MessageBit (integer) Bit in bit reporting process (0...31)
Default Values When a New Message Is Created
The following table indicates the default values that are entered when a new message is
created. These properties can be modified. The modifications are saved using the
ModifySingleAlarm function.
Parameters Default Value (Enum
Name => Value)
Comment
SingleAlarmAGNumber 0 --
SingleAlarmCPUNumber 0 --
SingleAlarmTextXXID No text entered --
SingleAlarmTagNameProcessValu
eXX
No tag entered --
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2484
System Manual, 11/2008,
Parameters Default Value (Enum
Name => Value)
Comment
SingleAlarmQuitTag No tag entered --
SingleAlarmQuitBits 0 No bits set.
SingleAlarmStateTag No tag entered Corresponds to exactly one day. Only
relevant in the case of compressed
tags.
SingleAlarmStateBits 0 No bits set.
SingleAlarmNormDLL No name entered --
SingleAlarmQuitSingle FALSE Single acknowledgment, no group
acknowledgment
SingleAlarmHornActivate FALSE Horn Not active.
SingleAlarmArchiving TRUE Message will be archived.
SingleAlarmProtocol TRUE Message is logged.
SingleAlarmFlankInvert FALSE Not activated.
SingleAlarmLockedOnStart FALSE Message is not disabled.
SingleAlarmGlobalAPIFunction FALSE Message is not forwarded.
SingleAlarmActionName No name entered --
SingleAlarmActionParams No parameters
entered for the action
--
SingleAlarmInfoText No text entered --
SingleAlarmGroup No text entered --
Enum HMIGO_SINGLE_ALARM_CLASS_IDS
The following message classes are available for selection:
Values Description
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) --
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2485
Values Description
SINGLE_ALARM_CLASS_16 (16) --
SINGLE_ALARM_CLASS_SYSTEM_REQUIRE_ACKNOWLEDGEMENT (17) --
SINGLE_ALARM_CLASS_SYSTEM_WITHOUT_ACKNOWLEDGEMENT (18) --
Example:
Sub CreateSingleAlarm()
' HMIGO_024
' procedure to create a SingleAlarm
' message must not be created before
' message Text ID need to be created before in text library
' declarations
Dim objHMIGO As HMIGO
Dim strMsgText As String 'message text
Dim strMsgTagName As String 'message variable
Dim lngMsgNumber As Long 'message number
Dim lngMsgBitNumber As Long 'bit number within the message variable
Dim lngMsgTypeID As Long 'message type
Dim lngMsgClassID 'SINGLE_ALARM_ERROR
Dim lngMsgTextID As Long 'message text ID from textlibrary
Set objHMIGO = New HMIGO
strMsgText = "NewText"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'preset reqiured parameter
lngMsgNumber = 50
lngMsgClassID = 1
lngMsgTypeID = 2
lngMsgTextID = 69
strMsgText = "new text message"
strMsgTagName = "NewVariable"
lngMsgBitNumber = 5
'create a tag
objHMIGO.CreateSingleAlarm lngMsgNumber,SINGLE_ALARM_ERROR, lngMsgTypeID,lngMsgTextID,
strMsgTagName, lngMsgBitNumber
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2486
System Manual, 11/2008,
See also
ListSingleAlarm Function (Page 2489)
GetSingleAlarm Function (Page 2488)
DeleteSingleAlarm Function (Page 2487)
CommitSingleAlarm Function (Page 2482)
CloseSingleAlarm Function (Page 2481)
VBA in Alarm Logging (Page 2478)
4.6.5.5 DeleteSingleAlarm Function
Description
Deletes the specified message.
syntax
Expression.DeleteSingleAlarm(MessageNumber)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
MessageNumber (long) Number of the message to be deleted.
Example:
Sub DeleteSingleAlarm()
' HMIGO_025
' procedure to delete a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'delete a singlealarm
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
2487
objHMIGO.DeleteSingleAlarm lngMsgNumber
Set objHMIGO = Nothing
End Sub
See also
VBA in Alarm Logging (Page 2478)
ListSingleAlarm Function (Page 2489)
GetSingleAlarm Function (Page 2488)
CreateSingleAlarm Function (Page 2483)
CommitSingleAlarm Function (Page 2482)
CloseSingleAlarm Function (Page 2481)
4.6.5.6 GetSingleAlarm Function
Description
Reads in the parameters of the message entered.
You can change or read the parameters by means of the object properties. You will find a list
of the available object properties in this documentation under "VBA in Alarm Logging".
syntax
Expression.GetSingleAlarm(MessageNumber)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
MessageNumber (long) The message number of the message to be read
in.
Example:
Sub GetSingleAlarm()
' HMIGO_026
' procedure to open a singlealarm
' message #100 need to be created before
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2488
System Manual, 11/2008,
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'open/ get a tag
objHMIGO.GetSingleAlarm lngMsgNumber
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
See also
ListSingleAlarm Function (Page 2489)
DeleteSingleAlarm Function (Page 2487)
CreateSingleAlarm Function (Page 2483)
CommitSingleAlarm Function (Page 2482)
CloseSingleAlarm Function (Page 2481)
VBA in Alarm Logging (Page 2478)
4.6.5.7 ListSingleAlarm Function
Description
The ListSingleAlarm function returns the content of Alarm Logging in a list:
● All actions created which are linked to messages
● All message class IDs created
● All info texts created
● All message numbers created
● All message type IDs created
● All message classes created
● All group messages created
syntax
Expression.ListSingleAlarm(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,
2489
Parameters
Parameter (Data Type) Description
ListType
(HMIGO_SINGLE_ALARM_LIST_TYPE)
Defines which content should be returned in a list.
Possibilities are:
● SINGLE_ALARM_ACTION_NAMES (1) All actions
created
for Loop In Alarm when the parameter is set
in the configuration as a string
● SINGLE_ALARM_CLASS_IDS (2) All message class
IDs created
● SINGLE_ALARM_INFO_TEXTS (3) All info texts
created
● SINGLE_ALARM_MESSAGE_NUMBERS (4) All
message numbers created
● SINGLE_ALARM_MESSAGE_TYPE_IDS (5) All
message type IDs created
● SINGLE_ALARM_GROUP_MESSAGE_CLASSES
(6) All message classes created
● SINGLE_ALARM_GROUP_MESSAGE_USER_DEF
INED (7) All group messages created
pListArray (Variant) List with the requested content.
Filter (String) Filters can be set optionally. Wildcards "*" and "?" are
also possible.
Example:
In the following example, a check is made whether info texts have been configured:
Sub ReadSingleAlarm()
'HMIGO_032
'read content in alarm logging
'no info texts are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
'read all info texts
objHMIGO.ListSingleAlarm SINGLE_ALARM_INFO_TEXTS, arrContent
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no info texts are implemented"
End If
End Sub
VBA for Automated Configuration
4.6 VBA in Other WinCC Editors
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
2490
System Manual, 11/2008,