|
ProviewR Programmer's Reference Manual
V6.1.4
|
The structure describing an application message. More...
#include <rt_mh_appl.h>
Public Attributes | |
| pwr_tUInt32 | Id |
| pwr_tObjid | Object |
| pwr_tObjid | SupObject |
| pwr_tObjid | Outunit |
| mh_mEventFlags | EventFlags |
| pwr_tTime | EventTime |
| pwr_tString80 | EventName |
| mh_eEvent | EventType |
| pwr_tString80 | EventText |
| mh_eEventPrio | EventPrio |
| mh_mEventStatus | EventStatus |
| mh_uSupInfo | SupInfo |
| pwr_sAttrRef | EventSound |
| pwr_tString256 | EventMoreText |
The structure describing an application message.
Definition at line 87 of file rt_mh_appl.h.
| mh_mEventFlags mhs_ApplMessage::EventFlags |
Flags that modify the properties of a message, See mh_mEventFlags.
Definition at line 122 of file rt_mh_appl.h.
| pwr_tString256 mhs_ApplMessage::EventMoreText |
An arbitrary string supplying more information about the event
Definition at line 153 of file rt_mh_appl.h.
| pwr_tString80 mhs_ApplMessage::EventName |
A name that identifies the event, can for instance be the name of an object. It will be shown as the first row of a message in the alarm window.
Definition at line 129 of file rt_mh_appl.h.
| mh_eEventPrio mhs_ApplMessage::EventPrio |
Sets the priority of the message, See mh_eEventPrio.
Definition at line 142 of file rt_mh_appl.h.
| pwr_sAttrRef mhs_ApplMessage::EventSound |
Reference to sound object. Determines the alarm sound.
Definition at line 152 of file rt_mh_appl.h.
| mh_mEventStatus mhs_ApplMessage::EventStatus |
Returns the status of a message, See mh_mEventStatus. This attribute is only used when calling mh_ApplGetMsgInfo.
Definition at line 143 of file rt_mh_appl.h.
| pwr_tString80 mhs_ApplMessage::EventText |
An arbitrary string supplying information about the event. It will be shown as the second row of a message in the alarm window.
Definition at line 137 of file rt_mh_appl.h.
| pwr_tTime mhs_ApplMessage::EventTime |
The time when the event that initiated the creation of the message occurred. This must be supplied by the application, mh will not put a time stamp on the message.
Definition at line 124 of file rt_mh_appl.h.
| mh_eEvent mhs_ApplMessage::EventType |
Specifies the kind of message that will be generated, alarm or informational. See mh_eEvent.
Definition at line 135 of file rt_mh_appl.h.
| pwr_tUInt32 mhs_ApplMessage::Id |
The identity given to the message, which is used as a handle when generating an acknowledgement or return message to the message and should be kept by the application for this purpose. This attribute is only used when calling mh_ApplGetMsgInfo, otherwise the id is supplied/returned as a parameter of its own.
Definition at line 88 of file rt_mh_appl.h.
| pwr_tObjid mhs_ApplMessage::Object |
An object that is associated with the event. When the operator marks the message and clicks on "Select", this object will be shown in the operator window. If you do not want this facility, supply a value of 0 and set the flag mh_EventFlags_NoObject in EventFlags.
Definition at line 99 of file rt_mh_appl.h.
| pwr_tObjid mhs_ApplMessage::Outunit |
A message can be directed to a specific out-unit by supplying the object identity of the unit, if you supply zero the message will be sent to all out-units.
Definition at line 116 of file rt_mh_appl.h.
| mh_uSupInfo mhs_ApplMessage::SupInfo |
Supplies the type of supervision data that should be associated with the message: analog, digital or none. See mh_eSupType.
Definition at line 147 of file rt_mh_appl.h.
| pwr_tObjid mhs_ApplMessage::SupObject |
A supervision object associated with the event. When the operator selects the functions "ActionText", he will see the text attached to this object. It is, for instance, possible to use the application object for this attribute, or zero, in which case no text will be associated.
Definition at line 107 of file rt_mh_appl.h.
1.9.1