Previous Topic: $DSCALL OPT=ALLOC SYSOUT=class

Next Topic: $DSCALL OPT=BROWSE


$DSCALL OPT=ALLOCINFO

Obtains allocation information by ddname or relative allocation number.

&CONTROL SHRVARS=($DS)
EXEC $DSCALL OPT=ALLOCINFO 
           { DD=DD_name | RELNUM=number }

This call is used to obtain information about a data set that is allocated to your product region. The data set to be queried is specified using the ddname of the data set, or by specifying the relative allocation number for the data set. If the ddname method is used, information can only be obtained about the first data set in the concatenation. If the relative allocation number method is used, information is obtained about any data set allocated to your product region.

Operands:

OPT=ALLOC

INFO Specifies that allocation information is to be obtained.

DD=DD_name

Specifies the ddname of the data set for which information is to be obtained.

RELNUM=number

Specifies the relative allocation number assigned by the operating system. The number must be an integer in the range 1 to 32,760. A full list of data sets allocated to your product region is obtained by requesting information using RELNUM=1, RELNUM=2, and so on. When the last data set allocated to your product region is reached, a feedback code of 65 (&$DSFDBK=65) is returned to indicate the last data set has been reached.

Return Codes:

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

Return Variables:

&$DSDYNEC

DYNALLOC error code

&$DSDYNIC

DYNALLOC information code

&$DSFDBK

Feedback code

&$DSSTAT

Status of data set; values are NEW, OLD, MOD, or SHR

&$DSDSN

Full data set name or true name if an alias is used

&$DSMEM

Member name if a member of a PDS

&$DSORG

Data set organization; values are PS, PO, PSU, POU, CX, CQ, MQ, GS, TX, TQ, and TR

&$DSDDNAME

DDname for allocation. If you perform a query through RELNUM then this variable may be blank if the relative number is part of a concatenation.

&$DSSTORCLS

SMS storage class if SMS is active for this data set

&$DSMGMTCLS

SMS management class if SMS is active for this data set

&$DSDATACLS

SMS data class if SMS is active for this data set

&$DSCDISP

Conditional data set disposition

&$DSNDISP

Normal data set disposition

Example: OPT=ALLOCINFO

EXEC $DSCALL OPT=ALLOCINFO DD=SYSDD

Notes:

The ALLOCINFO function requires access to a system resource called SYSZTIOT that is also used by other functions such as ALLOCATE. The SYSZTIOT resource is come unavailable for a long period (for example, when waiting for a tape mount to be satisfied if a data set being allocated has been migrated to tape by DFHSM).

To avoid possible delays in the completion of Dataset Services functions, your product region checks to ensure that the SYSZTIOT resource is available. If it is unavailable, the request fails immediately rather than waiting for SYSZTIOT to become available. This should be taken into consideration when writing NCL procedures which use the Allocation Information Query function.

Failure of an allocation information request due to SYSZTIOT being unavailable is indicated by the following:

&$DSFDBK = 5
&$DSDYNEC = 0254