Dataset Services Interface › $DSCALL OPT=UTILITY

$DSCALL OPT=UTILITY

Executes the IBM utilities: IEBGENER, IEBCOPY, IEHLIST, IEHMOVE, and IDCAMS.

&CONTROL SHRVARS=($DS)
EXEC $DSCALL OPT=UTILITY
             UTILITY=program
           [ DISPLAY= { YES | NO } ]
           [ IEBUPDTE= { YES | NO } ]
           [ SYSIN= DD_name ]
           [ SYSPRINT= { KEEP | DELETE | DSN } ]
           [ SYSUT1= DD_name ]
           [ SYSUT2= DD_name ]

This call allows users of your product region to execute some IBM utility programs. If any SYS* data sets are required for the specified utility, then the data sets must be allocated by the user before issuing the $DSCALL call and the ddnames must be passed as parameters to $DSCALL.

Operands:

• OPT=UTILITY

  Specifies that an operating system utility is to be executed. If you are executing in an MSP or VOS environment, then the actual utility called may be different from the IBM utility name. See the Notes section on the following page.

• UTILITY=program

  Specifies the name of the utility to be executed.

• DISPLAY={ YES | NO }

  Specifies whether to display the output on completion of the function. This operand is valid only if SYSPRINT=DSN is specified. If DISPLAY=YES is specified, then a full-screen display of the SYSPRINT data set is presented after the copy operation has completed.

• IEBUPDTE={ YES | NO }

  Specifies whether PDS updates is performed.

• SYSIN=DD_name

  Specifies a SYSIN ddname. This operand is required for all IBM utilities except IEBGENER. If no SYSIN ddname is provided for IEBGENER, then the default SYSIN file ( /* ) is used.

• SYSPRINT={ DELETE | KEEP | DSN }

  Specifies the type of data set to be allocated to the SYSPRINT DD for the copy operation.

  • If SYSPRINT=KEEP is specified, then your product region allocates a SYSOUT file with CLASS=A, and after the copy has completed the SYSOUT data set is deallocated with DISP=KEEP to cause it to be kept. The output from the copy operation is browsed through, for example, SDSF.
  • If SYSPRINT=DELETE is specified, then your product region allocates a SYSOUT file with CLASS=A, and after the copy has completed the SYSOUT file is deallocated with DISP=DELETE to cause it to be deleted. The output from the copy operation cannot be browsed.
  • If SYSPRINT=DSN is specified, then your product region allocates a temporary data set, which is deleted when your product region terminates. The output from the copy operation is browsed through ISPF or by the use of the DISPLAY=YES operand on this call. The data set is not deallocated from your product region on completion of the copy operation. The data set name, ddname, and volume for the data set are returned in variables to the caller.
• SYSUT1=DD_name

  Specifies the SYSUT1 ddname. This operand is required for IEHMOVE and IEBGENER.

• SYSUT2=DD_name

  Specifies the SYSUT2 ddname. This operand is required for IEBGENER only.

  Return Codes:

Return Codes:

Note: For more information about &SYSMSG, &$DSRC, and &$DSFDBK, see Return Codes and Feedback Codes.

Return Variables:

• &$DSPRINTDSN

  Name of SYSPRINT file

• &$DSPRINTVOL

  Volume where SYSPRINT file is located

• &$DSPRINTDD

  SYSPRINT ddname

Example: OPT=UTILITY

EXEC $DSCALL OPT=UTILITY UTILITY=IDCAMS DISPLAY=YES +
   SYSIN=SYSIN SYSUT1=DDSYS1 SYSUT2=DDSYS2

Notes:

It is the caller's responsibility to allocate the SYSUT1, SYSUT2, and SYSIN data sets prior to the OPT=UTILITY call if they are required for the utility. This is also necessary for other ddnames used on control statements in SYSIN. For example, for IEBCOPY where SYSIN is COPY INDD=DD1 OUTDD=DD2. In this case, DD1 and DD2 must be allocated prior to the OPT=UTILITY call.

The following table shows the IBM utilities that are called by the OPT=UTILITY call and the names of corresponding utilities that are used in other operating environments.