CNZMXURF — UCME look-up service macro

Description

Use the CNZMXURF macro to locate the console control block (UCME) that contains a specific console ID. CNZMXURF can only be used to look up MCS and SMCS console IDs.

Environment

The requirements for the caller are:

Environmental factor	Requirement
Minimum authorization:	Problem state and any PSW key.
Dispatchable unit mode:	Task
Cross memory mode:	Any PASN, any HASN, any SASN
AMODE:	24- or 31-bit
ASC mode:	Primary
Interrupt status:	Enabled for I/O and external interrupts
Locks:	The caller must hold the CMS lock.
Control parameters:	Not applicable; held in a register.

Programming requirements

Before issuing the CNZMXURF macro, place a 4-byte console ID into a register. No register save area is required; however, the input registers are saved on the linkage stack.

Restrictions

None.

Input register information

Before issuing the CNZMXURF macro, the caller must either place a 4-byte console ID into a register, or directly specify the RX-type address of a 4-byte console ID.

Output register information

When control returns to the caller, the general purpose registers (GPRs) contain:

Register: Contents
0: UCME pointer
1: Used as a work register by the system
2-13: Unchanged
14: Used as a work register by the system
15: Return code

When control returns to the caller, the access registers (ARs) contain:

Register: Contents
0–15: Unchanged

Some callers depend on register contents remaining the same before and after issuing a service. If the system changes the contents of registers on which the caller depends, the caller must save them before issuing the service, and restore them after the system returns control.

Performance implications

None.

Syntax

The CNZMXURF macro is written as follows:

Syntax	Description

`name`	`name`: Symbol. Begin `name` in column 1.

␢	One or more blanks must precede CNZMXURF.

CNZMXURF

␢	One or more blanks must follow CNZMXURF.

`register`	`register`: General purpose register Register (2-12) containing a 4-byte console ID.
or
`console-ID`	`console-ID`: RX-type address containing a 4-byte console ID.
,INUSE=NO	Default: INUSE=NO
,INUSE=YES

Parameters

The parameters are explained as follows:

register: Contains the 4-byte console ID for which the corresponding UCME is to be located.
console-ID: Contains the 4-byte console ID for which the corresponding UCME is to be located.
INUSE=YES: The UCME corresponding to the input console ID will be returned only if it is initialized and in use.
INUSE=NO: The UCME corresponding to the input console ID will be returned, even if it is not initialized and not in use.

ABEND codes

None.

Return and reason codes

When the CNZMXURF macro returns control to your program, register 15 contains one of the following hexadecimal return codes:

Hexadecimal Return Code	Meaning and Action
00	Meaning: No errors. A pointer to the UCME containing the console ID is returned in register 0. Action: None.
04	Meaning: A UCME containing the specified console ID was not found. Register 0 contains zero. Action: None.
08	Meaning: Incorrect console ID input or there is no UCME for the specified console ID. Register 0 contains zero. Non-MCS console class was supplied. INTERNAL console ID (0) was supplied. INSTREAM console ID (128) was supplied. UNKNOWN console ID (255) was supplied. There is no UCME for the specified 4-byte console ID or the UCME for the console ID is not initialized and in use. Action: None.
16	Meaning: CNZMXURF service is not available. Action: None.

Example 1

Locate the UCME associated with the 4-byte console ID in register 4.

CNZMXURF (4)

Example 2

Locate the UCME associated with the 4-byte console ID stored in field “MYCONID”.

CNZMXURF MYCONID