1.5.1 OcaLog

Class Hierarchy:

OcaRoot : OcaDataset : OcaLog

class OcaLog : OcaDataset

A log object. Child of OcaDataSet.

Properties:

static const OcaClassID ClassID = "1.5.1"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This is a class property instead of an object property. This property will be overridden by each descendant class, in order to specify that class’s ClassID.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

OcaBoolean Enabled

TRUE if and only if logging is enabled.

This property has id 3.1.

OcaLogSeverityLevel SeverityThreshold

Log input filter: Only events whose severity level designator values are at or below this threshold will be logged. Note: OcaLogSeverityLevel is defined to follow the Syslog format as described in [RFC 5424]. In [RFC 5424], higher importance of an event is represented by a lower numeric value of its Severity Level.

This property has id 3.2.

Properties inherited from 1.5 OcaDataset:

Methods:

OcaStatus AddLogRecord(OcaLogRecord Entry)

Adds a log entry.

This method has id 3.1.

  • Entry: Input parameter.

OcaStatus GetSeverityThreshold(OcaLogSeverityLevel &Severity)

Gets the value of the SeverityThreshold property.

This method has id 3.2.

OcaStatus SetSeverityThreshold(OcaLogSeverityLevel Severity)

Sets the value of the SeverityThreshold property.

This method has id 3.3.

OcaStatus OpenRetrievalSession(OcaLockState LockType, OcaLogFilter Filter, OcaIOSessionHandle &Handle)

Opens a log retrieval session. Sets the record filter that the retrievals will use. Returns a handle for subsequent RetrieveRecords(…) calls to use.

This method has id 3.4.

OcaStatus CloseRetrievalSession(OcaIOSessionHandle Handle)

Closes a log retrieval session.

This method has id 3.5.

OcaStatus RetrieveRecords(OcaIOSessionHandle Handle, OcaUint64 RecStartNo, OcaUint16 RecCount, OcaUint64 MaxDataLength, OcaBoolean &EndOfData, OcaUint64 &LengthOfRequestedData, OcaList<OcaLogRecord> &Records)

In a given log reading session, retrieves the next log record(s) that match the session’s retrieval criteria. There must have an open log retrieval session created by calling OpenLogRetrievalSession(…). This call specifies the retrieval criteria. Returns **.EndOfData**=TRUE when there are no more records to retrieve.

This method has id 3.6.

OcaStatus GetEnabled(OcaBoolean &Enabled)

Gets the value of the Enabled property.

This method has id 3.7.

OcaStatus SetEnabled(OcaBoolean Enabled)

Sets the value of the Enabled property.

This method has id 3.8.

Methods inherited from 1.5 OcaDataset: