%TSQL.sys.log
Class %TSQL.sys.log Extends %Library.RegisteredObject [ System = 2 ]
Properties
logFile
Property logFile As %String;
Methods
%OnNew
Method %OnNew(logFile As %RawString = "", initialize As %Boolean = 0) As %Status [ Private, ProcedureBlock = 1, ServerOnly = 1 ]
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status
%OnClose
Method %OnClose() As %Status [ Private ]
write
Method write(message As %String(MAXLEN=""), linesBefore As %Integer = 0, linesAfter As %Integer = 1) As %Status
write() - write a message to the current log file
logError
Method logError(error As %SYSTEM.Error)
Report an error from a %SYSTEM.Error object
error - an instance of %SYSTEM.Error
logStream
Method logStream(stream As %Stream.Object, pNumbered As %Integer = 0)
Copy the contents of a stream to the log
stream - stream to copy to the file.
logStatus
Method logStatus(StatusCode As %Status, Message As %String, ByRef Outcome)
Report a status message from a trace
sc - pass as status code message - pass a message to be written both to the current device and to the log (or "") (optional) outcome - pass an array of stats (optional)
logHeader
Method logHeader() As %Status
logResults
Method logResults(context As %Library.ProcedureContext, displyRowCount As %Boolean = 0, timeStart As %String = "", startgloref As %String = "", rowcount As %BigInt = "", dumpresults As %Boolean = 1) As %Status
startLog
ClassMethod startLog(logFile As %RawString = "", initialize As %Boolean = 0) As %Status
stopLog
ClassMethod stopLog() As %Status
traceMessage
ClassMethod traceMessage(message As %String(MAXLEN="")) As %Status
traceDeferredStatement
ClassMethod traceDeferredStatement(statementType, sql) As %Status
traceEmbeddedStatement
ClassMethod traceEmbeddedStatement(statementType, sql) As %Status
traceContext
ClassMethod traceContext(context As %Library.ProcedureContext) As %Status
traceStatus
ClassMethod traceStatus(StatusCode As %Status, Message As %String, ByRef Outcome)
Report a status message from a trace
sc - pass as status code message - pass a message to be written both to the current device and to the log (or "") (optional) outcome - pass an array of stats (optional)
traceError
ClassMethod traceError(pError As %SYSTEM.Error) As %Status
Report an error from a %SYSTEM.Error object
error - an instance of %SYSTEM.Error
traceResult
ClassMethod traceResult(pContext As %Library.ProcedureContext, displyRowCount As %Boolean = 0, timeStart As %String = "", startgloref As %String = "", rowcount As %BigInt = "", dumpresults As %Boolean = 1) As %Status