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

$$CURCP^XPDUTL(): Get Current Checkpoint Name/IEN

Reference Type: Supported, Category: KIDS, ICR#: 10141

Description

The $$CURCP^XPDUTL extrinsic function returns the name of the current checkpoint during KIDS installations. It can be useful if, for example, you use the same tag^routine API for more than one call back. Using this function, you can determine which call back you are in.

Use this API only for checkpoints with a call back. It returns the NULL string if you call it when working with a checkpoint with no call back (in which case, you would really be in either the pre- or post-install routine).

Format

  $$CURCP^XPDUTL(format)

Input Parameters

format:

(required) Pass as follows:

  • Zero (0)—To return checkpoint name.

  • 1—To return checkpoint Internal Entry Number (IEN).

Output

returns:

Returns:

  • Checkpoint Name—The current checkpoint name.

  • NULL String—If not currently in a checkpoint call back.