z/OS MVS Programming: Authorized Assembler Services Reference ALE-DYN
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


List information about one or more exits

z/OS MVS Programming: Authorized Assembler Services Reference ALE-DYN
SA23-1372-00

The CSVDYNEX LIST request returns information about all exits in the system that have been defined to the dynamic exits facility, or about specific exits (EXITNAME parameter). The information returned includes:
  • The definition of the exit established on the DEFINE request, including:
    • Addressing mode
    • Reentrancy
    • Whether FASTPATH processing applies to the exit
    • Whether the exit has been explicitly or implicitly defined.
  • Characteristics of the exit routines associated with the exit, as specified on the ADD request:
    • Name of the exit routine
    • State of the exit routine
    • Whether jobname filtering was requested
    • Whether STOKEN filtering was requested
    • The STOKEN and JOBNAME, if provided.

The system returns the information in an area you provide (ANSAREA and ANSLEN parameters), which is mapped by the CSVEXAA mapping macro.

Environment

The requirements for the caller are:

Environmental factor Requirement
Minimum authorization: One of the following:
  • Supervisor state
  • PSW key 0-7
  • PKM allowing key 0-7
  • APF-authorized
  • SAF READ authority to FACILITY class entity CSVDYNEX.LIST.
Dispatchable unit mode: Task
Cross memory mode: PASN=HASN=SASN
AMODE: 24- or 31-bit
ASC mode: Primary or access register (AR)
Interrupt status: Enabled for I/O and external interrupts
Locks: No locks may be held.
Control parameters: Control parameters and the area where the system places the information obtained through the CSVDYNEX LIST request (ANSAREA parameter) must be in the primary address space or, for AR-mode callers, must be in an address space or data space that is addressable through a public entry on the caller's dispatchable unit access list (DU-AL).

Programming requirements

Include the CSVEXRET mapping macro to define symbolic names and associated values for return and reason codes returned by CSVDYNEX. Also include the CSVEXAA mapping macro to get a mapping of the output area specified by the ANSAREA parameter. (See z/OS MVS Data Areas in z/OS Internet Library at http://www.ibm.com/systems/z/os/zos/bkserv/.)

Restrictions

The caller must not have functional recovery routines (FRRs) established.

Input register information

See Input register information for CSVDYNEX for input register information for the CSVDYNEX LIST request.

Output register information

See Output register information for CSVDYNEX for output register information for the CSVDYNEX LIST request.

Syntax

The standard form of the LIST request on the CSVDYNEX macro is written as follows:

Syntax Description
   
   name name: symbol. Begin name in column 1.
   
One or more blanks must precede CSVDYNEX.
   
CSVDYNEX  
   
One or more blanks must follow CSVDYNEX.
   
REQUEST=LIST  
   
   ,EXITNAME=ALL_EXITS Default: EXITNAME=ALL_EXITS
   ,EXITNAME=exitname exitname: RS-type address or address in register (2) - (12).
   
,ANSAREA=ansarea ansarea: RS-type address or address in register (2) - (12).
   
,ANSLEN=anslen anslen: RS-type address or address in register (2) - (12).
   
   ,EXAAVER=0 Default: EXAAVER=0
   ,EXAAVER=1  
   
,EXITTYPE=ANY Default: EXITTYPE=ANY
,EXITTYPE=INSTALLATION  
,EXITTYPE=PROGRAM  
,EXITTYPE=NOTPROGRAM  
   
   ,RETCODE=retcode retcode: RS-type address or register (2) - (12).
   
   ,RSNCODE=rsncode rsncode: RS-type address or register (2) - (12).
   
   ,MF=S  
   

Parameters

The parameters are explained as follows:

REQUEST=LIST
Lists information about one or more exits.
,EXITNAME=ALL_EXITS
,EXITNAME=exitname
EXITNAME=ALL_EXITS, the default, tells the system to list information about all exits in the system that have been defined to the dynamic exits facility.

EXITNAME=exitname specifies a 16-byte field (or a register containing the address of a 16-byte field) that contains the 16-character name of the exit. If the name contains fewer than 16 characters, left-justify the name and pad the field with blanks. To indicate the name of more than one exit, use an asterisk for the last non-blank character. A matching exit name is one that matches all the characters preceding the asterisk. If the first character of the name is X'00', the system processes the request as if EXITNAME=ALL_EXITS has been specified.

,ANSAREA=ansarea
This parameter specifies an area (or a register containing the address of an area) where the system is to store information associated with the exits. Use the CSVEXAA mapping macro to map this area. (See z/OS MVS Data Areas in z/OS Internet Library at http://www.ibm.com/systems/z/os/zos/bkserv/.) Specify the length of this area on the ANSLEN parameter.
,ANSLEN=anslen
Specifies a fullword (or a register containing the address of a fullword) that contains the length of the area where the system is to return the list. This value must be equal to or greater than the length of the EXAAHDR structure in the CSVEXAA mapping macro.

If the area is not long enough to contain all the information, the system returns as many entries as it can. The system returns the length that is currently required to contain all the information in the EXAAHTLEN field in the CSVEXAA mapping macro, with return code CSVDYNEXRC_WARN (4) and reason code CSVDYNEXRSNNOTALLDATARETURNED (X'xxxx0403').

,EXAAVER=0
,EXAAVER=1
Specifies the format of information to be returned, as mapped by DSECTs within the CSVEXAA data area. EXAAVER=1 returns more information about exit routines than EXAAVER=0. Both EXAAVER=1 and EXAAVER=0 return header information mapped by the EXAAHDR DSECT, and exit information mapped by the EXAAE DSECT.
  • EXAAVER=0, the default, specifies that exit routine information is mapped by the EXAAM DSECT.
  • EXAAVER=1 specifies that exit routine information is mapped by the EXAAM1 DSECT.
,EXITTYPE=ANY
,EXITTYPE=INSTALLATION
,EXITTYPE=PROGRAM
,EXITTYPE=NOTPROGRAM
When REQUEST=LIST is specified, EXITTYPE is an optional parameter that indicates the type of exit about which to return data.

The default is EXITTYPE=ANY

EXITTYPE=ANY indicates that data is returned for any exit type.

EXITTYPE=INSTALLATION indicates that data is returned only if the exit is marked as an installation exit.

EXITTYPE=PROGRAM indicates that data is returned only if the exit is marked as a program exit.

EXITTYPE=NOTPROGRAM indicates that data is returned only if the exit is not marked as a program exit.

,RETCODE=retcode
Specifies a fullword (or a register) where the system is to store the CSVDYNEX return code. The return code is also in GPR 15.
,RSNCODE=rsncode
Specifies a fullword (or a register) where the system is to store the CSVDYNEX reason code. The reason code is also in GPR 0.
,MF=S
Specifies the standard form of the CSVDYNEX macro.

ABEND codes

None.

Return and reason codes

See Return and reason codes for the return and reason codes for the CSVDYNEX LIST request.

Example

For an example of how to list information about exits, see Example 6.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014