Return Codes from SCRATCH

Control returns to the instruction following the instructions generated by the SCRATCH macro. Register 15 contains the SCRATCH return code as shown in Table 1.

SCRATCH returns 4 bytes of diagnostic information in register 0. If an error occurs, DADSM issues message IEC614I, consisting of failure-related information including the return code and the 4 bytes of diagnostic information. See z/OS DFSMSdfp Diagnosis for a description of this information.

The last two bytes of a volume list entry contain the secondary status code and the scratch status code. The secondary status codes are shown in Table 2 and the scratch status codes are shown in Table 1. To determine if the data set has been deleted from each volume, check the scratch status code. (Even if the scratch status code is zero, the secondary status code might be nonzero for the first entry in the volume list.)

Table 1 describes the conditions indicated by the SCRATCH return code.

Table 1. SCRATCH Return Codes
Return Code	Description
000 (X'00')	If the 4 bytes of diagnostic information returned in register 0 are all zeros, the data set was successfully deleted. If they are nonzero, use the SCRATCH diagnostic information tables in z/OS DFSMSdfp Diagnosis to determine the failure-related conditions.
004 (X'04')	No volume containing any part of the data set was mounted. The data set might be a VIO data set that was not allocated to your jobstep.
008 (X'08')	An unusual condition was encountered on one or more volumes.
012 (X'0C')	One of the following conditions occurred: The SCRATCH parameter list is not valid. The volume list is not valid. At entry to SCRATCH, register 0 was not zero and did not point to a valid UCB. The address must be that of a UCB, not a UCB copy. The SCRATCH status code will not have been set.