Skip to main content

This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Previous sectionNext section

Status Values

Work with the %Status data type.

Background Information

InterSystems classes use the %Status data type class to represent status information. Many methods return a %Status value to indicate success or failure (along with reason for failure).

Available Tools

System-supplied macros

ObjectScript provides some macros for working with %Status values. These include:

  • $$$ADDSC

  • $$$EMBEDSC

  • $$$ERROR

  • $$$ISERR

  • $$$ISOK

For information, see “System-supplied Macro Reference” in the chapter “ObjectScript Macros and the Macro Preprocessor” in Using Caché ObjectScript.

This class provides methods for working with %Status values. These methods include:

  • AppendStatus()

  • DecomposeStatus()

  • DisplayError()

  • GetErrorText()

  • IsError()

  • IsOK()

  • And others

Availability: All namespaces.

This class provides the following method for working with %Status values:

  • DisplayError()


The special variable $SYSTEM is bound to the %SYSTEM package. This means that (for ObjectScript) instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

See Also