%Library.Status
datatype class %Library.Status
ODBC Type: VARCHAR
The %Status data type class is used to represent an error status code.Many of the methods provided by the system classes return error status information using the %Status data type. The include file %occStatus.INC contains several macro definitions that are useful in testing the value of an error code in %Status format. These macros include:
$$$ISOK(status:%Status)
returns true (1) if the status code status does not represent an error condition.$$$ISERR(status:%Status)
returns true (1) if the status code status represents an error condition.
You can get a more detailed description of an error by using $system.Status.DecomposeStatus(status:%Status,&err,flag), which takes a status code and returns an array of error strings; see %SYSTEM.Status.
For example:
Set status=obj.%Save() If $$$ISERR(status) Do $system.Status.DecomposeStatus(status,.err,"-d") For i=1:1:err Write err(i),!
Method Inventory
Parameters
parameter JSONTYPE = string;
JSONTYPE is JSON type used for this datatype.
parameter MAXLEN = 65536;
Maximum expected length of a %Status value
parameter XSDTYPE = base64Binary;
Declares the XSD type used when projecting XML Schemas.
Methods
classmethod LogicalToOdbc(%val="") as %String
Converts the value of this data type from $List format to a delimited string
using the value of the ODBCDELIMITER parameter as a delimiter.
Converts the %Binary value to the SOAP base64 encoded value.
Converts the SOAP encoded base64 input value to a logical value.