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

$$UPCP^XPDUTL(): Update Checkpoint

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

Description

The $$UPCP^XPDUTL extrinsic function updates the parameter node of an existing checkpoint, in pre- or post-install routines during KIDS installations. The parameter node is stored in the INSTALL (#9.7) file.

Use this API for checkpoints both with and without call backs.

During the pre-install, you can only update pre-install checkpoints; during the post-install, you can only update post-install checkpoints.

Format

  $$UPCP^XPDUTL(name[,par_value])

Input Parameters

name:

(required) Checkpoint name.
par_value:

(optional) Value to set the checkpoint parameter.

Output

returns:

Returns:

  • Internal Entry Number (IEN)—Successfully updated checkpoint.

  • Zero (0)—Error updating checkpoint.