$$NEWCP^XPDUTL(): Create Checkpoint

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

Description

The $$NEWCP^XPDUTL extrinsic function creates a checkpoint in pre- or post-install routines during KIDS installations. The checkpoint is stored in the INSTALL (#9.7) file.

Pre-and post-install checkpoints are stored separately, so you can use the same name for a pre- and post-install checkpoint if you wish:

• Checkpoints created with this API from the pre-install routine are pre-install checkpoints.
  
  
• Checkpoints created during the post-install routine are post-install checkpoints.

You can use $$NEWCP^XPDUTL to create a checkpoint with or without a call back. You can also store a value for the parameter node, if you wish.

Checkpoints created with call backs have that call back automatically executed by KIDS during the appropriate phase of the installation:

• If the checkpoint is created during the pre-install routine, KIDS executes the call back as soon as the pre-install routine completes.
  
  
• If the call back is created during the post-install, KIDS executes the call back as soon as the post-install routine completes.
  
  
• If multiple checkpoints are created during the pre- or post-install routine, KIDS executes the call backs (and completes the checkpoints) in the order the corresponding checkpoints were created.

Checkpoints created without a call back cannot be executed by KIDS; instead, they provide a way for developers to store and retrieve information during the pre-install and post-install phases. Rather than storing information in a local or global variable, you can store information in a checkpoint parameter node and retrieve it (even if an installation is re-started).

If the checkpoint you are trying to create already exists, the original parameter and call back is not overwritten.

Format

  $$NEWCP^XPDUTL(name[,callback][,par_value])

Input Parameters

Output