DSGetLogSummary

Returns a list of short log event details. The details returned are determined by the setting of some filters. (Care should be taken with the setting of the filters, otherwise a large amount of information can be returned.)

Syntax

SummaryArray = DSGetLogSummary (JobHandle, EventType, StartTime, EndTime, MaxNumber)

JobHandle is the handle for the job as derived from DSAttachJob.

EventType is the type of event logged and is one of:

• DSJ.LOGINFO Information message
• DSJ.LOGWARNING Warning message
• DSJ.LOGFATAL Fatal error
• DSJ.LOGREJECT Reject link was active
• DSJ.LOGSTARTED Job started
• DSJ.LOGRESET Log was reset
• DSJ.LOGANY Any category (the default)

StartTime is a string in the form YYYY-MM-DD HH:NN:SS or YYYY-MM-DD.

EndTime is a string in the form YYYY-MM-DD HH:NN:SS or YYYY-MM-DD.

MaxNumber is an integer that restricts the number of events to return. 0 means no restriction. Use this setting with caution.

SummaryArray is a dynamic array of fields separated by @FM. Each field comprises a number of substrings separated by \, where each field represents a separate event, with the substrings as follows:

Substring1 EventId as per DSGetLogEntry

Substring2 Timestamp in form YYYY-MM-DD HH:NN:SS

Substring3 EventType - see DSGetNewestLogId

Substring4 - n Event message

If an error occurs, the error is reported by one of the following negative integer result codes:

• DSJE.BADHANDLE Invalid JobHandle.
• DSJE.BADTYPE Invalid EventType.
• DSJE.BADTIME Invalid StartTime or EndTime.
• DSJE.BADVALUE Invalid MaxNumber.

Example

The following command produces an array of reject link active events recorded for the qsales job between 18th August 1998, and 18th September 1998, up to a maximum of MAXREJ entries:

RejEntries = DSGetLogSummary (qsales_handle, 
→ DSJ.LOGREJECT, "1998-08-18 00:00:00", "1998-09-18 
→ 00:00:00", MAXREJ)