The requirements for the caller are:
Environmental factor | Requirement |
---|---|
Minimum authorization: | Problem state or supervisor state, and any PSW key |
Dispatchable unit mode: | Task or SRB |
Cross memory mode: | Any PASN, any HASN, any SASN |
AMODE: | 24- or 31-bit |
ASC mode: | Primary |
Interrupt status: | Enabled or disabled for I/O and external interrupts |
Locks: | No requirement |
Control parameters: | Must be in the primary address space |
The caller must include the CVT mapping macro in the program that issues the NUCLKUP macro.
None.
After the caller issues the macro, the system might use some registers as work registers or might change the contents of some registers. When the system returns control to the caller, the contents of these registers are not the same as they were before the caller issued the macro. Therefore, if the caller depends on these registers containing the same value before and after issuing the macro, the caller must save these registers before issuing the macro and restore them after the system returns control.
None.
The standard form of the NUCLKUP macro is written as follows:
Syntax | Description |
---|---|
name | name: Symbol. Begin name in column 1. |
␢ | One or more blanks must precede NUCLKUP. |
NUCLKUP | |
␢ | One or more blanks must follow NUCLKUP. |
BYNAME,NAME=name id | name id: 8-byte literal (enclosed in apostrophes), or the address of the 8-byte literal which can be either an RX-type address, or register (1) - (12). |
BYADDR,NAME=name loc | |
name loc: RX-type address or register (1) - (12). | |
,ADDR=addr | addr: RX-type address, or register (0) or (2) - (12). |
The parameters are explained as follows:
None.
When NUCLKUP macro returns control to your program, GPR 15 contains a hexadecimal return code.
Return Code | Meaning and Action |
---|---|
00 | Meaning: The request was satisfied. Action: None. |
04 | Meaning: The request was not satisfied. For a BYNAME request, the name was not found, and the location containing the address was set to zero. For a BYADDR request, the address was not found in the nucleus, and the location containing the name was set to zero. Action: None required. However, you might take some action based upon your application. |
08 | Meaning: Program error. The request was
not satisfied because the type of request was not specified correctly.
The locations containing the name and address were set to zero. Action: Ensure that the name id value is supplied for BYNAME requests, and the addr value is provided on BYADDR requests. |
NUCLKUP BYNAME,NAME='IEAVESTU',ADDR=(0)
NOCLKUP BYNAME,NAME=STRING,ADDR=RETLOC
.
.
STRING DS CL8
RETLOC DS F
NUCLKUP BYADDR,NAME=EPLOC,ADDR=INADDR
.
.
EPLOC DS CL8
INADDR DS F