Home > Support > Documentation

rtEXIEvent.h File Reference

EXI event definitions and functions. More...

#include "rtexisrc/rtEXIExternDefs.h"
#include "rtxsrc/rtxXmlQName.h"

Go to the source code of this file.


Classes

struct  _OSEXIEvent

Enumerations

enum  OSEXIEventType
 A structure representing an EXI event. More...

Functions

EXTERNEXI void rtEXIEventInit (OSCTXT *pctxt, OSEXIEvent *pEvent, OSEXIEventType type, const OSXMLFullQName *qname)
 This function initializes an event structure.
EXTERNEXI OSEXIEventrtEXINewEvent (OSCTXT *pctxt, OSEXIEventType type, const OSXMLFullQName *qname)
 This function allocates a new event structure and initializes it.
EXTERNEXI OSEXIEventrtEXINewEventDeepCopy (OSCTXT *pctxt, const OSEXIEvent *pEvent)
 This function creates a deep copy of the given event record.
EXTERNRT void rtEXIEventDeepCopy (OSCTXT *pctxt, OSEXIEvent *pdest, const OSEXIEvent *psrc)
 This function makes a deep copy of the given Event including the strings inside.
EXTERNRT void rtEXIEventFreeMem (OSCTXT *pctxt, OSEXIEvent *pEvent, OSBOOL dynamic)
 This function frees all memory within an Event structure.
EXTERNEXI OSUINT32 rtEXIEventHash (const OSEXIEvent *pEvent)
 This function computes a hash code for an event structure.
EXTERNEXI OSBOOL rtEXIEventsEqual (const OSEXIEvent *pEvent1, const OSEXIEvent *pEvent2)
 This function tests if two event structures are equal.
EXTERNEXI const OSEXIEventrtEXIGetBaseEvent (const OSEXIEvent *pEvent)
 This function gets the base event corresponding to a given event.
EXTERNEXI const char * rtEXIEventTypeToString (OSEXIEventType type)
 This function returns the textual name for the given event type (for example, "SD", "SE", etc.
EXTERNEXI OSUTF8CHAR * rtEXIEventToString (OSCTXT *pctxt, const OSEXIEvent *pEvent)
 This function returns the full textual description for the given event.
EXTERNEXI void rtEXIEventPrint (const OSEXIEvent *pEvent)
 This function prints information on the given event to stdout.

Detailed Description

EXI event definitions and functions.

Definition in file rtEXIEvent.h.