Kernel Toolkit 7.3 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

FAIL^XTMUNIT(): Generate an Error Message

Reference Type: N/A; Not callable from outside a unit test, Category: Toolkit—M Unit Utility, ICR#: N/A

Description

The FAIL^XTMUNIT API runs a test that simply generates an error message This command is useful for more complex unit tests that are built within the unit test routine itself.

NOTE: None of the M Unit Utility Application Programming Interfaces (APIs), extrinsic functions, or sections of code in the M Unit are callable from outside a unit test, but are all part of a unit test. M UNIT is a self-contained application.

REF: For an overview and more details of the M Unit Utility, see the "Toolkit—M Unit Utility" section in the Kernel 8.0 & Kernel Toolkit 7.3 Developer's Guide.

Format

  D FAIL^XTMUNIT(msg)

Input Parameters

msg:

(required) The text of the error message.

Output

returns:

Returns the error message.