%XSQL.Log
class %XSQL.Log extends %Library.RegisteredObject
Property Inventory (Including Private)
Method Inventory (Including Private)
- %OnClose()
- %OnNew()
- ActivateLog()
- DeactivateLog()
- logEmbeddedSQL()
- logEnterProcedure()
- logError()
- logException()
- logFunction()
- logHeader()
- logResultSet()
- logResults()
- logSQLCODE()
- logStatementResult()
- logStatementSource()
- logStatus()
- logStream()
- logValue()
- prepareLog()
- startLog()
- stopLog()
- traceContext()
- traceDeferredStatement()
- traceEmbeddedSQL()
- traceEnterFunction()
- traceEnterProcedure()
- traceError()
- traceException()
- traceExitProcedure()
- traceFunction()
- traceMessage()
- traceResult()
- traceResultSet()
- traceSQLCODE()
- traceStatus()
- traceValue()
- write()
Properties (Including Private)
Methods (Including Private)
The return value of this method is ignored.
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
Report an error from a %SYSTEM.Error object
pError - an instance of %SYSTEM.Error
Report a function and its return value.
pName - the name of the value, for example, 'pFormal1' as the name of a formal argument
pValue - the value
Log an SQLCODE and %msg value
pSQLCODE - the SQLCODE value
pMessage - the %msg value
pPrefix - the prefix to use when writing the log content, defaults to two tab characters.
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)
Copy the contents of a stream to the log
stream - stream to copy to the file.
Report a named value
pName - the name of the value, for example, 'pFormal1' as the name of a formal argument
pValue - the value
Report a execution of embedded/deferred SQL, its arguments, and status.
pStatement - the text of the SQL Statement executed
pArguments - the Arguments and their values
pSQLCODE - the resulting SQLCODE
pMsg - the resuting %msg (if any)
pROWCOUNT - the resulting %ROWCOUNT (if any)
pTime - the execution time (if any)
Report an error from a %SYSTEM.Error object
error - an instance of %SYSTEM.Error
Report an exception from a trace
pException - pass as an exception oref
Report a function and its return value.
pName - the name of the function method
pValue - the return value
Log an SQLCODE and %msg value
pSQLCODE - the SQLCODE value
pMessage - the %msg value
pPrefix - the prefix to use when writing the log content, defaults to two tab characters.
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)
Report a named value
pName - the name of the value, for example, 'pFormal1' as the name of a formal argument
pValue - the value
Inherited Members
Inherited Methods (Including Private)
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnConstructClone()
- %OnValidateObject()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()