General Class Reference

Simple exception class that can be throw in user code. More...

Inheritance diagram for General:

Collaboration diagram for General:

Public Member Functions
_.Library.Status	OnNew (_.Library.String pName, _.Library.String pCode, _.Library.String pLocation, _.Library.String pData, _.Exception.AbstractException pInnerException)
	Simple exception class that can be throw in user code. More...
Public Member Functions inherited from AbstractException
_.Library.Integer	AsSQLCODE ()
	Return the SQLCODE value corresponding to the exception.
_.Library.String	AsSQLMessage ()
	Return the SQL msg string describing details of the exception.
_.Library.Status	AsStatus ()
	Convert this exception to a Status compatible value.
_.Library.String	DisplayString (_.Library.Integer pLevel)
	This returns a string that represents the exception. More...
_.Library.Status	Log ()
	Call the log function (LOG^ETN) to log this exception. More...
	OutputToDevice (_.Library.Integer pLevel)
	This outputs the string representation of the exception to the current device, recursively. More...
	OutputToStream (_.Library.CharacterStream pStream, _.Library.Integer pLevel)
	This outputs the string representation of the exception to the supplied stream, recursively. More...
	SQLMessageString (_.Library.Integer pLevel)
	This returns a string that represents the SQL msg string. More...
_.Library.Status	StackAsArray (array)
	This method sets an array that is passed by reference to the execution stack at the time of the exception. More...

Private Member Functions
_.Library.Status	__OnAsStatus ()
	Override this method to provide a custom conversion of an exception to a status.

Additional Inherited Members
Public Attributes inherited from CPPException
	Code
	Code is the error code. More...
	Data
	Data is extra information supplied for certain errors. More...
	InnerException
	This holds an Inner exception. More...
	Location
	Location is the location at which the error occurred. More...
	Name
	Name is the name of the error. More...

Detailed Description

Simple exception class that can be throw in user code.

You can throw this with code similar to:

Throw ##class(Exception.General).New(name,numericCode,location,data)

The name is a string name for the exception, the numericCode is a numeric error code. If the location field is blank and $$$envCallerErrorInfo is defined then the system will attempt to fill in this location where the exception was thrown from automatically. You can pass additional exception data in the data argument.

Member Function Documentation

OnNew()

_.Library.Status OnNew	(	_.Library.String	pName,
		_.Library.String	pCode,
		_.Library.String	pLocation,
		_.Library.String	pData,
		_.Exception.AbstractException	pInnerException
	)

Simple exception class that can be throw in user code.

You can throw this with code similar to:

Throw ##class(Exception.General).New(name,numericCode,location,data)

The name is a string name for the exception, the numericCode is a numeric error code. If the location field is blank and $$$envCallerErrorInfo is defined then the system will attempt to fill in this location where the exception was thrown from automatically. You can pass additional exception data in the data argument.

Reimplemented from AbstractException.