Previous Topic: DescriptionNext Topic: Environment


Arguments

event

Specifies the address of the event structure for which the data specified by Xxxx is to be returned.

CMEventXxxx routines Enter specific details about the event they are passed. Most of these routines are macros and you should use them as the preferred mechanism for accessing the internal structure of an event. This mechanism provides protection if the event structure changes in future releases.

The following table shows the valid values for CMEventXxxx routines.

Xxxx Value

Enter Type

Returns

Name

char *

The name of the event as stored in the Console Manager database.

Class

char *

The class of the event as stored in the Console Manager database.

Info

char *

The information for the event as stored in the Console Manager database.

Text

char *

The line of console output which activated the event.

Context

int

The full context for the event as logged in the host's log file, and count of the lines retrieved, -1 on error. Obtain the context data using the CMEventContextYyyy routines.

Time

time_t

The time at which the event occurred.

Type

int

The type of event, one of CMEventTypeEvent,
CMEventTypeAck or
CMEventTypeClear.

Logtime

time_t

The timestamp of the event in the log file for the host on which the event occurred.

Count

int

The number of context lines for the event as stored in the Console Manager database.

Priority

int

The priority of the event as stored in the Console Manager database.

Source

char *

The source of the event, which is typically the name of the detector of the event.

Start

int

The start line of the event relative to the line on which the event occurred as stored in the Console Manager database.

SubSystem

char *

The subsystem for the event as stored in the database.

Host

char *

The hostname of the system on which the event occurred.

System

char *

The hostname of the system on which the event occurred.

Userdata

char *

The userdata value from the dispatch record which caused this event to arrive at the action.

Returned values should not be freed by the caller. They are freed by a call to CMFreeEvent().