GETINSP supplies information on the path name of an installation item. GETINSP enables
you to view the relationship between the logical IDs and path names of installation items
belonging to an installation unit.
Macro | Operands | ||||||||||||||||||||||||||
GETINSP |
|
The MF, PREFIX, MACID, PARAM and XPAND parameters are described in “Macro forms” on "Macro syntax ".
CALLER | |||||||||||
Controls the type of system call if MF = E. | |||||||||||
=USER | |||||||||||
| System call via SVC for nonprivileged caller (TU). | |||||||||||
=SYSTEM | |||||||||||
| Direct system call for privileged caller (TPR). | |||||||||||
| IUNAME | |||||||||||
| Name of the installation unit containing the installation item or items, see "Installation unit (IU) ". | |||||||||||
=<c-string 1..30> | |||||||||||
Explicit specification of the installation unit. | |||||||||||
=<var: char:30> | |||||||||||
| Symbolic address containing the specification for the name of the installation unit. May not be specified with MF=L. | |||||||||||
UVERS | |||||||||||
Version of the installation unit. Format: <mm.naso> | |||||||||||
=<c-string 7..7> | |||||||||||
| Explicit specification of the version of the installation unit. | |||||||||||
=<var: char:7> | |||||||||||
| Symbolic address containing the specification for the version of the installation unit. May not be specified with MF=L. | |||||||||||
LOGID | |||||||||||
The logical name of the installation item for which the path name will be output. | |||||||||||
=*ALL | |||||||||||
Output the logical names of all installation items. | |||||||||||
=<c-string 1..30> | |||||||||||
| Explicit specification of the logical ID of the installation item. | |||||||||||
=<var: char:30> | |||||||||||
| Symbolic address containing the specification for the logical ID of the installation item. May not be specified with MF=L. | |||||||||||
TARGET=’'BLANK'’ / <c-string 1..1> / <var: char:1> | |||||||||||
Specifies the hardware form belonging to the installation item (specify for IUNAME and IUVERS). Possible values:
| |||||||||||
| OUT@= adr> / (<reg>) | |||||||||||
| Address of the area that is to accept the output information. The address must be aligned on a word boundary. This parameter has no significance unless MF = M. | |||||||||||
| OUTLEN=<integer 1..2147483647> / <var: int:4> | |||||||||||
Length of the output area in bytes, the minimum length is 4. Only output information with the specified length is transferred. The first 4 bytes contain the length of the returned output information. This is then followed by one or more installation items. | |||||||||||
Layout of the output area
Distance | Length | Format | Contents |
| X‘00‘ | 4 | <integer> | Length of the output information |
| X‘04‘ | 30 | <char> | Logical name of the installation item no. 1 |
| X‘22‘ | 54 | <char> | File name of the installation item no. 1 |
| X’58’ | 1 | <char> | Hardware model of the installation item no. 1 |
| X’59’ | 1 | <char> | Indicator of the installation item no. 1: X’80’ File cannot be accessed X’40’ File not initialized |
| X’5A’ | 2 | <char> | Reserved |
| X‘5C‘ | 30 | <char> | Logical name of the installation item no. 2 |
| X‘7A‘ | 54 | <char> | File name of the installation item no. 2 |
| X’B0’ | 1 | <char> | Hardware model of the installation item no. 2 |
| X’B1’ | 1 | <char> | Indicator of the installation item no. 2: X’80’ File cannot be accessed X’40’ File not initialized |
| X’B2’ | 2 | <char> | Reserved |
| ... | Further installation items |
Macro return codes
(SC2) | SC1 | Maincode | Meaning |
| X‘00‘ | X‘00‘ | X‘0000‘ | Function successfully executed |
| X‘01‘ | X‘00‘ | X‘0000‘ | No path name assigned |
| X‘02‘ | X‘00‘ | X‘0000‘ | User not privileged to read the path name. “*” is substituted for the path |
| X‘00‘ | X‘01‘ | X‘0001‘ | Name of installation unit invalid |
| X‘00‘ | X‘01‘ | X‘0002‘ | Version of installation unit invalid |
| X‘00‘ | X‘01‘ | X‘0003‘ | Logical ID invalid |
| X‘00‘ | X‘01‘ | X‘0008‘ | Illegal use of fields reserved for the parameter area |
| X‘00‘ | X‘40‘ | X‘0011‘ | Installation unit not found |
| X‘00‘ | X‘40‘ | X‘0012‘ | Version of installation unit not found |
| X‘03‘ | X‘40‘ | X‘0012‘ | Access to version of installation unit not permitted |
| X‘00‘ | X‘40‘ | X‘0013‘ | Logical ID not found |
| X‘03‘ | X‘40‘ | X‘0013‘ | Access to logical ID not permitted |
| X‘00‘ | X‘40‘ | X‘0018‘ | SCI invalid |
| X‘00‘ | X‘40‘ | X‘001A‘ | SCI version invalid |
| X‘00‘ | X‘40‘ | X‘001B‘ | SCI does not exist |
| X‘00‘ | X‘40‘ | X‘001E‘ | Installation item not initialized |
| X‘00‘ | X‘01‘ | X‘0021‘ | Output field address not assigned |
| X‘00‘ | X‘01‘ | X‘0022‘ | Output field length insufficient (minimum=4) |
| X‘00‘ | X‘01‘ | X‘0023‘ | Output field too small |
| X’00’ | X’01’ | X’0025’ | Operand TARGET invalid |
| X’00’ | X’01’ | X’0026’ | SYSTEM RC cannot be written. |
| X‘00‘ | X‘20‘ | X‘00FF‘ | DMS error in SCI access |
| X’00’ | X‘20‘ | X‘0100‘ | System error |
| X’00’ | X‘20‘ | X‘0101‘ | Internal error |
Notes
You can use GETINSV to ascertain a version designation which you do not know in full.
If a logical name does not contain any assigned path names, an item with an empty file name (blanks) is output in the output area and the indicator contains the value X’40’.
If you are a nonprivileged user, this macro will fetch information only on the installation items of functional level TU (see the section "Attributes of an installation unit").
The scope of information output is the name and version of the installation unit, plus the logical ID, the path name and the associated attributes for each installation item.
The character “*” is substituted for the path name if it cannot be output for the user. The indicator contains the value X’80’.
The first four bytes of the output area indicate the length of the information returned.