Use the UCBINFO PATHMAP macro to obtain information about the device path.
The standard form of the PATHMAP option of the UCBINFO macro is written as follows:
Syntax | Description |
---|---|
name | name: symbol. Begin name in column 1. |
␢ | One or more blanks must precede UCBINFO. |
UCBINFO | |
␢ | One or more blanks must follow UCBINFO. |
PATHMAP | |
,MAPAREA=maparea addr | maparea addr: RX-type address or register (2) - (12). |
,DEVN=devn addr | devn addr: RS-type address or register (2) - (12). |
,SCHSET=schset | schset RS-type address or register (2) - (12). |
,SCHSET=0 | Default: 0 |
,IOCTOKEN=ioctoken addr | ioctoken addr: RX-type address or register (2) - (12). |
,PLISTVER=IMPLIED_VERSION | |
,PLISTVER=MAX | Default: IMPLIED_VERSION |
,PLISTVER=plistver | plistver: 2 |
,RETCODE=retcode addr | retcode addr: RX-type address or register (2) - (12). |
,RSNCODE=rsncode addr | rsncode addr: RX-type address or register (2) - (12). |
The parameters are explained as follows:
If you set the input IOCTOKEN (specified by ioctoken addr) to binary zeros, UCBINFO sets IOCTOKEN to the current I/O configuration token.
If you can tolerate the size change, IBM recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form; in this way, MAX ensures that the parameter list does not overwrite nearby storage.
When the UCBINFO PATHMAP macro returns control to your program, GPR 15 (or retcode addr, if you coded RETCODE) contains a return code, and GPR 0 (or rsncode addr, if you coded RSNCODE) contains a reason code.
Hexadecimal Return Code | Hexadecimal Reason Code | Meaning and Action |
---|---|---|
00 | None | Meaning: The PATHMAP function completed
successfully. Action: None. |
04 | None | Meaning: Program error. No UCB exists
for the device number specified in the DEVN parameter. Action: Correct the device number and reissue the macro. |
08 | 01 | Meaning: Program error. A caller in AR
mode specified an ALET that was not valid. Action: Correct the ALET and reissue the macro. |
08 | 02 | Meaning: Program error. An error occurred
when the system tried to access the caller's parameter list. Action: Ensure that you have met the environmental requirements for the macro, and reissue the macro. |
08 | 03 | Meaning: Program error. An unauthorized caller specified the UCB common
address in the MAPAREA field. Unauthorized callers cannot specify
the UCB in MAPAREA. Action: Use the DEVN parameter instead of the MAPAREA field to indicate the device for which the system is to obtain path information. |
08 | 05 | Meaning: Program error. An error occurred
when the system referenced the caller-supplied area specified in the
IOCTOKEN parameter. This reason code is valid only for callers using
the IOCTOKEN parameter. Action: Correct the IOCTOKEN parameter. |
08 | 06 | Meaning: Program error. An error occurred
when the system attempted to reference the area specified by the MAPAREA
parameter. Action: Correct the address specified for MAPAREA and reissue the macro. |
08 | 0B | Meaning: The value specified on the
SCHSET keyword is not valid. Action: Enter a valid value. |
0C | None | Meaning: Environmental error. The I/O
configuration token supplied through the IOCTOKEN parameter is not
current. This return code is valid only for callers using the IOCTOKEN
parameter. Action: Obtain the current I/O configuration token by issuing an IOCINFO macro or by setting the input IOCTOKEN parameter in the UCBINFO macro to zero. |
10 | 04 | Meaning: System error. The subchannel
is in permanent error and cannot be accessed. Action: Supply the return and reason code to the appropriate IBM support personnel. |
20 | None | Meaning: System error. An unexpected error
occurred. Action: Supply the return code to the appropriate IBM support personnel. |
UCBINFO PATHMAP,MAPAREA=INFOAREA,DEVN=DEVNUM, X
RETCODE=INFORTCD
.
.
.
DS 0D
INFOAREA DS CL256
INFORTCD DS F
DEVNUM DS H