DMSWUERR - Work Unit Error Data Deblocker

Read syntax diagramSkip visual syntax diagram DMSWUERR , retcode , reascode , buffer , length , fperror_num , number_returned , total_errors , filepoolid , workunitid ,error_reascode,prev_retcodeGroup 1
Group 1
Read syntax diagramSkip visual syntax diagram , userid_index ,level_sub1Group 2
Group 2
Read syntax diagramSkip visual syntax diagram , level_sub2 ,warning1Group 3
Group 3
Read syntax diagramSkip visual syntax diagram , error_reascode_info failing_filepoolid
Notes:
  • 1 Up to 16 warnings can be specified.

Call Format

The format for calling a CSL routine is language dependent. DMSWUERR is called only through DMSCSL. The routine name is the first parameter in DMSCSL’s parameter list:

DMSWUERR
(input, CHAR, 8) can be passed as a literal or in a variable.

For more information and examples of the call formats, see Calling VMLIB CSL Routines.

Purpose

Use the DMSWUERR routine to convert work unit error (wuerror) output from the structured format returned in other routines to data placed in individual variables.

Parameters

retcode
(output, INT, 4) is a variable for the return code from DMSWUERR.
reascode
(output, INT, 4) is a variable for the reason code from DMSWUERR.
buffer
(input, CHAR, length) is the wuerror parameter returned on a previous call to another CSL routine. It contains the extended error information that is to be placed in specific variables.
length
(input, INT, 4) is a variable for specifying the length of the buffer area identified by the preceding character parameter (buffer).
fperror_num
(input, INT, 4) is a variable in which you specify the relative number of the extended error information you want returned. If multiple errors occurred, this number specifies the error for which information is to be returned for this call. Typically, this parameter should contain a value of 1 on the first call.
number_returned
(output, INT, 4) is a variable used to return the number of errors for which extended information was returned on a prior call to an SFS function.
total_errors
(output, INT, 4) is a variable used to return the total number of errors for which information was available. As many as would fit in the user-supplied area on a previous call were filled in. This number will be equal to or larger than the number_returned parameter.
filepoolid
(output, CHAR, 8) is a variable used to return the name of the file pool that was used on the previous call which found the error.
workunitid
(output, INT, 4) is a variable used to return the work unit used on the previous call which found the error.
error_reascode
(output, INT, 4) is a variable used to return the SFS error reason code associated with the set of extended error information being converted to individual variables. Warning reason codes are returned in the warning parameters; the error_reascode parameter contains a value of 0 when there are only warning reason codes.
prev_retcode
(output, INT, 4) is a variable used to hold the SFS error or warning return code associated with the set of extended error information being converted to individual variables.
userid_index
(output, INT, 4) is a variable used to return the index of the user ID for which an error or warning was first found for calls that have a list of user IDs. This value indicates the relative position of the user ID in the list.
level_sub1
(CHAR, 4) is a reserved field.
level_sub2
(CHAR, 4) is a reserved field.
warning
(output, INT, 4) is a variable used to hold a warning reason code. You can specify up to 16. All 16 must be specified if you use the error reason code information parameter.
error_reascode_info
(output, CHAR, 4) provides additional information for some error_reascode values:
71800
The error_reascode_info parameter contains the recovery token of the conflicting CRR resynchronization activity. Any display of this value should be hexadecimal.
If your application cannot access the required resource, it should inform the user that the resource is unavailable and provide the following information for the user to pass to the file pool administrator:
  • The recovery token (returned in this parameter)
  • The contents of the filepoolid parameter
50500
The error_reascode_info parameter contains the code for the reason the work unit could not be committed after a successfully completed operation. For explanations of these codes, see usage note 9, Return Codes and Reason Codes, and Common Reason Codes.
failing_filepoolid
(output, CHAR, 8) is a variable used to hold the file pool ID of the failing resource. This will be significant only when a DFSMS/VM recall error has been encountered.

Usage Notes

  1. The Work Unit Error Data Deblocker routine is used by languages that cannot handle the error information structure passed back in the wuerror parameter in other routines. The format passed back is described in wuerror under Common Parameters.
  2. Information for one group of extended error information is returned each time DMSWUERR is called.
  3. The error_reascode and prev_retcode parameters may not contain the same values as the reascode and retcode parameters returned on the CSL routine for which extended error information was generated. For example, if there was an attempt to commit a work unit, generic return and reason codes may be generated, in which case each set of extended error information in the wuerror buffer is used for the SFS-specific error information.
  4. The error_reascode_info field information may contain a CSL error reason code returned from DFSMS/VM in the event of a failed recall attempt.

Return Codes and Reason Codes

For lists of the possible return codes from DMSWUERR, see Return Codes.

The following table lists the special reason codes returned by DMSWUERR. ERROR indicates that the request failed. Errors cause return code 8 or 12.

DMSWUERR can also return the common CSL reason codes, which are codes that can occur with most file system management and related routines. For a list of the common reason codes, see Common Reason Codes.

Severity Reason Code Description
ERROR 76055 Invalid FPERROR number specified. It is less than 1 or greater than the number of FPERROR fields returned.
ERROR 76056 The wuerror buffer contained no FPERROR information.
ERROR 90215 Invalid buffer length specified for input wuerror buffer.