Online Help - Region 1: [CORE HL7 API Basic] |
Object: COREException
Implementation: Exception Handling with the COREHL7 API.
In the CORE HL7 libraries we make great effort NOT to THROW any system exceptions, instead almost all of our objects implement our Standard Exception Handling system. All of our pertinent objects will have a publicly accessible LastException property with a SetException() and ClearErrors() methods built in as well. For instance, when you instantiate a HL7Controller object you have to pass in either a File Name which contains your API License OR a String value which contains the XML value of your license. If you want to know if everything worked successfully you can immediately check for errors after you create the object.
Public Properties:
Property Name |
Data Type |
ExceptionMessage |
string |
ExceptionMethod |
string |
ExceptionNumber |
integer |
SimpleErrorMessage |
string (read only) |
ExtendedErrorMessage |
string (read only) |
Public Methods:
Method |
Return Value |
Clear() |
void |
Copy() |
COREException - Returns a copy of the COREException object |
HasException() |
bool |
IsExceptionXML() |
bool |
LoadFromXML() |
bool |
SetException() |
void |
XMLObject() |
COREXml Visit Region 3: [ CORE HL7 Dialogs ] for information on the COREXml object |
XMLValue() |
string |
Object: COREExceptionEX - (Subclass of COREException)
As this object is a sub-class of COREException it contains all of the same properties and methods with one singular addition. COREExceptionEX contains a Tag property which is of type CORETag.
Public Properties:
Property Name |
Data Type |
Tag |
Public Methods:
Method |
Return Value |
CloneFrom() |
void - Use the CloneFrom() method in lieu of the base Copy() method to also copy the Tag property |