TcEventHeader
This structure describes the header of an event object. With the header the parameter of an event could be configured.
struct TcEventHeader
{
TcEventClass nClass;
TcEventPriority nPriority;
long dwFlags;
long dwUserData;
long nId;
long nInvokeId;
DATE fDate;
long nMs;
VARIANT varSource;
BSTR szFmtProgId;
};
TcEventHeader item | DataType | Description |
|---|---|---|
nClass | The class of the alarm, like alarm, warning, hint | |
nPriority | TcEventPriority (long) | The event priority. Since now the priority is always: TcEventPriority.TCEVENTPRIO_IMPLICIT=0 |
dwFlags | TcEventFlags (long) | The flags control the behavior of the alarm. That could be combined by a OR junction. |
dwUserData | long | A spare variable that can be used by the user. |
nId | long | The event id, that unique represent this type of event for this one Event Source. |
nInvokeId | long |
|
fDate | VARIANT-DATE | The date and time when this event occur |
nMs | long | The millisecond part of the event date |
varSource | variant | The source id source name. The event source is used to distinguish different device. Like I/O Event, or different parts of the PLC program. |
szFmtProgId | BSTR string | The PrgId of the formatter. If we want to use the standard XML formatter the string should bet set to "TcEventFormatter.TcXmlFormatter" |