Skip to main content

This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).

Status Values

Work with the %StatusOpens in a new window data type.

Background Information

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

Available Tools

System-supplied macros

ObjectScript provides some macros for working with %StatusOpens in a new window 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 %StatusOpens in a new window values. These methods include:

  • AppendStatus()

  • DecomposeStatus()

  • DisplayError()

  • GetErrorText()

  • IsError()

  • IsOK()

  • And others

Availability: All namespaces.

This class provides the following method for working with %StatusOpens in a new window 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

FeedbackOpens in a new window