Class pvx_build_log

Build Information

Author fmcguirk
Date 2007.06.13 24 at 04:13:13 PM EDT
Outputfile pvx_build_log.pvc
Forcelinenumbers false

Constructor

Capture errors and warnings for a program during the build process.

ParameterDescription
SourceFile$ The source file that was processed
Destination$ The output file (tokenized) program that was created

Properties

PROPERTY _version$

Methods

FUNCTION getErrorData(errorData$, errorCount)

Get the log information that has been captured

ParameterDescription
errorData$ The information about the errors that have been logged
errorCount The number of errors recorded
FUNCTION getWarningData(warningData$, warningCount)

Get the warnings that have been recorded

ParameterDescription
warningData The information about the warnings that have been captured
warningCount The number of warnings that have been recorded
FUNCTION get_Build_Log$()

Get the contents of the build log as a simple data stream (string).

FUNCTION isEmpty()

This method returns a boolean value (0=false, 1=true) to indicate if any issues have been recorded

FUNCTION record_Error(stmt_Num, src_Line, err_Num, err_Msg$, pgm_Line$)

Record information about an error found in the program source code

ParameterDescription
stmt_Num Program line number (or projected line number) where error was found
src_Line Source file line where error was found
err_Num Error number
err_Msg$ Error message text
pgm_Line$ The actual program line that has the error
FUNCTION record_Error(stmt_Num, src_Line, err_Num$, err_Msg$, pgm_Line$)

Record information about an error found in the program source code

ParameterDescription
stmt_Num Program line number (or projected line number) where error was found
src_Line Source file line where error was found
err_Num$ Error number/ID
err_Msg$ Error message text
pgm_Line$ The actual program line that has the error
FUNCTION record_Warning(err_Num, err_Msg$)

Record information about a warning that has been captured about the program

ParameterDescription
err_Num Error number
err_Msg$ Error message text
FUNCTION record_Warning(err_Num, err_Msg$, info$)

Record information about a warning that has been captured about the program

ParameterDescription
err_Num Error number
err_Msg$ Error message text
info$ Additional data associated with this warning
FUNCTION record_Warning(stmtNum, srcLine, warnID$, warnMsg$, pgmLine$)

Record information about a warning found in the program source code

ParameterDescription
stmtNum Program line number (or projected line number) where warning was found
srcLine Source file line where warning was found
warnID$ warning number/ID
warnMsg$ warning message text
pgm_Line$ The actual program line for the warning
FUNCTION setErrorData(newErrorData$, newErrorCount)

Reset the build log data.

FUNCTION set_Warnings(warningData$, warningCount)

Set information about all warnings that have been captured for the program and retrieved using _OBJ'get_Warnings$()

ParameterDescription
warningData The information about the warnings that have been captured
warningCount The number of warnings that have been recorded
FUNCTION summarize_Errors()

Write a summary of the errors that have been recorded about the program