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

CHKEQ^XTMUNIT(): Check Two Values for Equivalence

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

Description

The CHKEQ^XTMUNIT API runs a test that checks two values for equivalence.

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 CHKEQ^XTMUNIT(expect,actual,msg)

Input Parameters

expect:

(required) The expected value.
actual:

(required) The actual value.
msg:

(required) The error message to be generated if the result of the test is False (not equal).

Output

returns:

Returns:

  • A period or “dot”—If the result of the test is True.

  • The <expected value>, the <actual value>, and the error message “msg”—If the result of the test is False.