DSMakeJobReport

Generates a report describing the complete status of a valid attached job.

Syntax

ReportText = DSMakeJobReport(JobHandle, ReportLevel, LineSeparator)

JobHandle is the string as returned from DSAttachJob.

ReportLevel specifies the type of report and is one of the following:

• 0 - basic report. Text string containing start/end time, time elapsed and status of job.
• 1 - stage/link detail. As basic report, but also contains information about individual stages and links within the job.
• 2 - text string containing full XML report.

By default the generated XML will not contain a <?xml-stylesheet?> processing instruction. If a stylesheet is required, specify a ReportLevel of 2 and append the name of the required stylesheet URL, that is, 2;styleSheetURL. This inserts a processing instruction into the generated XML of the form:

<?xml-stylesheet type=text/xsl" href="styleSheetURL"?>

LineSeparator is the string used to separate lines of the report. Special values recognized are:

• "CRLF" => CHAR(13):CHAR(10)
• "LF" => CHAR(10)
• "CR" => CHAR(13)

The default is CRLF if on Windows, else LF.

Remarks

If a bad job handle is given, or any other error is encountered, information is added to the ReportText.

Example

h$ = DSAttachJob("MyJob", DSJ.ERRNONE)
rpt$ = DSMakeJobReport(h$,0,"CRLF")