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

KILL^%ZTLOAD: Delete a Task

Reference Type: Supported, Category: TaskMan, Integration Agreement: 10063

Description

This API deletes a task. When a task is deleted by KILL^%ZTLOAD, the task referenced by ZTSK will not be defined in the volume set's task file. If the task was pending, it will not start, but if it had already started running, the effects of deleting its record are unpredictable.

NOTE: Tasks can delete their own records through the use of the ZTREQ output variable.

Format

  KILL^%ZTLOAD

Make sure to perform the following steps before calling this API:

  1. NEW all of the following variables.

  2. Set the input variables you want changed.

  3. Call the API.

If you do not follow these steps, the variables could unintentionally assume the values of the variables of the current running task.

Input Variables

ZTSK:

(required) Task number of the TaskMan task to delete.

Output Variables

ZTSK(0):

Returns:

  • 1—Successful deletion of the task.

  • 0—Requested task number is invalid.

Example

 
	 
 
 
 
	 
 
		
 
		  
			 

			 

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

				Site Map /

				Terms of Use /

				VA Privacy Policy
			    /

				
                Accessibility
 
  
 Reviewed/Updated: 
             November 14, 2006
				

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.