LOAD-MODULE

#### Search Results

Search

# LOAD-MODULE

File | 44
Statement | `PROCESS`
Task | Retrieves information on a load module residing on a specified dataset.

## Fields

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ERROR-CODE` | N3 |  |  |
`ERROR-TEXT` | A58 |  |  |
`NODE` | N5 |  | D |
`NODE-NAME` | A16 |  | D |
`FUNCTION` | A8 |  | D |
`DSNAME` | A54 |  | D |
`VOLSER` | A6 |  | D | Required if dataset is not cataloged.
`MEMBER` | A10 |  | D |
`PASSWORD` | A8 |  | D |
`SEGMENT-LENGTH` | B2 |  | D |
`BLOCK-OFFSET` | B4 |  | D |
`CSECT-OFFSET` | B4 |  | D |
`SEGMENT` | A253 |  | D | Relevant with `FUNCTION=DATA`.
`ESD-NAME` | A8 |  | D | Relevant with `FUNCTION=ESD or IDR`.
`ESD-NAME-LONG` | A253 |  | D | Relevant with `FUNCTION=ESD or IDR or DATA`.
`ESD-TYPE` | A2 |  | D | Relevant with `FUNCTION=ESD or VCON`.
`ESD-ADDRESS` | B4 |  | D | Relevant with `FUNCTION=ESD`.
`ESD-LENGTH` | N11 |  | D | Relevant with `FUNCTION=ESD`.
`ESD-AMODE` | A3 |  | D | Relevant with `FUNCTION=ESD`.
`ESD-RMODE` | A3 |  | D | Relevant with `FUNCTION=ESD`.
`ESD-LR-ID` | N5 |  | D | Relevant with `FUNCTION=ESD`.
`ESD-ID` | N5 |  | D | Relevant with `FUNCTION=ESD`.
`IN-CSECT` | A8 |  | D | Relevant with `FUNCTION=VCON`.
`IN-CSECT-LONG` | A253 |  | D | Relevant with `FUNCTION=VCON`.
`IDR-CALLER-ID` | A80 |  | D | Relevant with `FUNCTION=IDR`.
`IDR-DATE` | A8 |  | D | Relevant with `FUNCTION=IDR`.
`IDR-DATA` | A40 |  | D | Relevant with `FUNCTION=IDR`.
`IDR-DATX` | D |  | D | Relevant with `FUNCTION=IDR`.
IDR-TYPE | A4 |  | D | Relevant with `FUNCTION=IDR`.
`MODULE-LENGTH` | N11 |  | D | Relevant with `FUNCTION=ATTR`.
`MODULE-ATTRIBUTES` | A80 |  | D | Relevant with `FUNCTION=ATTR`.
`MODULE-SSI` | B4 |  | D | Relevant with `FUNCTION=ATTR`.

## Relevant Error Codes

Code | Text
--- | ---
534 | File is not a load library.
580 | Binder API :1: call, rc :2:, rsn :3:
600 | Unknown function.
998 | Member not found.

## Field Descriptions

Field Name | Type/Length
--- | ---
`BLOCK-OFFSET` | (B4)

This field is the offset of the first returned byte in `SEGMENT` into the load module.

Field Name | Type/Length
--- | ---
`CSECT-OFFSET` | (B4)

The offset of this segment in the current `CSECT`.

Field Name | Type/Length
--- | ---
`ESD-ADDRESS` | (B4)

Relevant with `FUNCTION=ESD`. Address of the external symbol.

Field Name | Type/Length
--- | ---
`ESD-AMODE` | (A3)

Relevant with `FUNCTION=ESD`. The `AMODE` assigned to the `CSECT`.

Field Name | Type/Length
--- | ---
`ESD-ID` | (N5)

Relevant with `FUNCTION=ESD`. The ID of the external symbol.

Field Name | Type/Length
--- | ---
`ESD-LENGTH` | (N11)

Relevant with `FUNCTION=ESD`. Length of the external symbol.

Field Name | Type/Length
--- | ---
`ESD-LR-ID` | (N5)

Relevant with `FUNCTION=ESD`. The ID of the label reference (LR) symbol.

Field Name | Type/Length
--- | ---
`ESD-NAME` | (A8)

Relevant with `FUNCTION=ESD or IDR`. The external symbol name.

Field Name | Type/Length
--- | ---
`ESD-NAME-LONG` | (A253)

Relevant with `FUNCTION=ESD or IDR or DATA`. Returns up to 253 bytes of a long ESD name.

Field Name | Type/Length
--- | ---
`ESD-RMODE` | (A3)

Relevant with `FUNCTION=ESD`. The `RMODE` assigned to the `CSECT`.

Field Name | Type/Length
--- | ---
`ESD-TYPE` | (A2)

Relevant with `FUNCTION=ESD` or `VCON`. Possible values:

`FUNCTION=ESD`
`CM` | Common.
`ER` | External reference.
`LR` | Label reference (i.e. Entry name).
`PC` | Private code.
`PR` | Pseudo reference.
`SD` | Section definition (i.e. `CSECT`).
`WX` | Weak external reference.
`FUNCTION=VCON`
`ER` | External symbol is unresolved.
`SD` | External symbol is resolved.
`WX` | External symbol is unresolved (weak).

Field Name | Type/Length
--- | ---
`DSNAME` | (A54)

Fully qualified dataset name.

Field Name | Type/Length
--- | ---
`FUNCTION` | (A8)

Function to be performed. Possible options:

Option | Explanation
--- | ---
`ATTR` | Return module attributes.
`DATA` | Return data on CSECTs.
`ESD` | Return names of external symbols and other related information as it appears in the external symbol dictionary.
`IDR` | Return information on applied Zaps and linkedit date/version.
`VCON` | Return information on external symbols as they appear in the relocation dictionary.

Field Name | Type/Length
--- | ---
`IDR-CALLER-ID` | (A80)

Relevant with `FUNCTION=IDR`. Identifies the caller-ID for the Binder IDR data.

Field Name | Type/Length
--- | ---
`IDR-DATA` | (A40)

Relevant with `FUNCTION=IDR`. The IDR data.

Field Name | Type/Length
--- | ---
`IDR-DATE` | (A8)

Relevant with `FUNCTION=IDR`. The date of the Zap/linkage in format `DD/MM/YY`.

Field Name | Type/Length
--- | ---
`IDR-DATX` | (A8)

Relevant with `FUNCTION=IDR`. The date of the Zap/linkage in internal format.

Field Name | Type/Length
--- | ---
`IDR-TYPE` | (A4)

Relevant with `FUNCTION=IDR`. Possible types:

Type | Explanation
--- | ---
`LANG` | Data produced by the language translator to identify the compiler or assembler.
`LINK` | Linkage entry. The `IDR-DATA` field contains linkedit name followed by version.
`USER` | User data created by `IDENTIFY` statement. The `IDR-DATA` field contains data (max. 40 bytes).
`ZAP` | `AMASPZAP` entry. The `IDR-DATA` field contains `IDRDATA` (length 8).

Field Name | Type/Length
--- | ---
`IN-CSECT` | (A8)

Relevant with `FUNCTION=VCON`. Name of the `CSECT` in which the reference to the external symbol appears.

Field Name | Type/Length
--- | ---
`IN-CSECT-LONG` | (A253)

Relevant with `FUNCTION=VCON`. Returns up to 253 bytes of a long `CSECT` name.

Field Name | Type/Length
--- | ---
`MEMBER` | (A10)

Member name.

Field Name | Type/Length
--- | ---
`MODULE-ATTRIBUTES` | (A253)

Relevant with `FUNCTION=ATTR`. The module's attributes in keyword format. The relevant keywords are separated by a blank. See the description for `MODULE-ATTRIBUTES` in the `LIB-DIRECTORY` view for values returned in this field.

Field Name | Type/Length
--- | ---
`MODULE-LENGTH` | (N11)

Relevant with `FUNCTION=ATTR`. The module's length in bytes.

Field Name | Type/Length
--- | ---
`MODULE-SSI` | (B4)

Relevant with `FUNCTION=ATTR`. The module's SSI data.

Field Name | Type/Length
--- | ---
`PASSWORD` | (A8)

Password for protected dataset.

Field Name | Type/Length
--- | ---
`SEGMENT` | (A253)

Relevant with `FUNCTION=DATA`. Contains the data segment with length `SEGMENT-LENGTH`.

Field Name | Type/Length
--- | ---
`SEGMENT-LENGTH` | (B2)

The length of the record segment to be returned. At the end of the block/CSECT/module, the segment may be smaller.

`SEGMENT-LENGTH` might sometimes have a value greater than 253. This indicates the presence of a large area of the `FILL` character specified when binding the load module or program object (almost always `X'00'`; different values are indicated in the data returned by the `MODULE-ATTRIBUTES` field). Programs should interpret this as indicating that the `FILL` character is present for `SEGMENT-LENGTH` - 253 bytes beyond `CSECT-OFFSET` + 253.

Field Name | Type/Length
--- | ---
`VOLSER` | (A6)

Volume serial number. Only required if the dataset is not cataloged.

### On this page

- Fields
- Relevant Error Codes
- Field Descriptions