Kernel V. 8.0 APIs Banner [skip navigation]
VHA Office of Information - Health Systems Design and Development (HSD&D) Banner

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

Reference Type: Supported, Category: KIDS, Integration Agreement: 10141

Description

This extrinsic function is used during KIDS installations. Use this function to return the name of the current checkpoint. 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 will return 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 zero (0) to return checkpoint name. Pass as 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.

Example

 
	 
 
 
 
	 
 
		
 
		  
			 

			 

				VA 
                (Internet) /
				 
				VA 
                (Intranet) /
				 
				OI /
				 
				
				 HSD&D /

				Site Map /

				Terms of Use /

				VA Privacy Policy
			    /

				
                Accessibility
 
  
 Reviewed/Updated: 
             December 14, 2005
				

If you have questions, need more information, or are having
				accessibility problems with this website, please contact us by E-Mail:
				Webmasters, Phone:
				510-768-6800, or FAX: 510-768-6850.