RTVREGINF RETRIEVE REGISTRATION INFORMATION TAAREGC |
The Retrieve Registration Information command retrieves information
as displayed with WRKREGINF. RTVREGINF retrieves information for one
exit point. The Retrieve Server Authentication Entries
(QsyRetrieveServerEntries) API is used.
A typical command would be:
DCL &RIENAM *CHAR LEN(20)
.
RTVREGINF EXITPNT(xxx) RIENAM(&RIENAM)
The format name and program number default to *FIRST.
The name of the first exit point would be returned for the specified
exit point.
RTVREGINF escape messages you can monitor for
---------------------------------------------
CPF3CDB Exit point does not exist
Escape messages from based on functions will be re-sent.
RTVREGINF Command parameters *CMD
----------------------------
EXITPNT The exit point name.
FORMAT The exit point's format. A name or generic name (8
characters) may be entered. *FIRST is the default.
PGMNBR The program number of the exit point. *FIRST is the
default. A number in the range of 1 to 2147482647
may be entered
PGMDTA A two part parameter to describe the program data.
If program data is not specified, the first program
(if any) is returned for the exit point/format.
The first part is the starting position within the
data where the search for the data will begin. *NO
is the default meaning do not use the program data
when searching.
The second part is the program data itself. *NO is
the default meaning do not use the program data when
searching. Up to 256 bytes may be entered.
RIENAM The exit point name. This is an optional return
parameter that if used must be specified as *CHAR
LEN(20).
RIEFMT The format name. This is an optional return
parameter that if used must be specified as *CHAR
LEN(8).
RIEMAX The maximum number of exit programs. A value of -1
is returned for *NOMAX. This is an optional return
parameter that if used must be specified as *DEC
LEN(10 0).
RIECUR The current number of exit programs. This is an
optional return parameter that if used must be
specified as *DEC LEN(10 0).
RIEDRG Whether to allow de-registration. Y or N will be
returned. This is an optional return parameter that
if used must be specified as *CHAR LEN(1).
RIECHG Whether to allow changes to the registration
information. Y or N will be returned. This is an
optional return parameter that if used must be
specified as *CHAR LEN(1).
RIEREG The registered exit point. Y or N will be returned.
This is an optional return parameter that if used
must be specified as *CHAR LEN(1).
RIEADN The pre-processing exit program name for adding an
exit point. This is an optional return parameter
that if used must be specified as *CHAR LEN(10).
RIEADL The library of the pre-processing exit program name
for adding an exit point. This is an optional
return parameter that if used must be specified as
*CHAR LEN(10).
RIEADF The format name of the pre-processing exit program
name for adding an exit point. This is an optional
return parameter that if used must be specified as
*CHAR LEN(8).
RIERMN The name of the pre-processing exit program name for
removing an exit point. This is an optional return
parameter that if used must be specified as *CHAR
LEN(10).
RIERML The library name of the pre-processing exit program
name for removing an exit point. This is an
optional return parameter that if used must be
specified as *CHAR LEN(10).
RIERMF The format name of the pre-processing exit program
name for removing an exit point. This is an
optional return parameter that if used must be
specified as *CHAR LEN(8).
RIERTN The name of the pre-processing exit program name for
retrieving an exit point. This is an optional
return parameter that if used must be specified as
*CHAR LEN(10).
RIERTL The library name of the pre-processing exit program
name for retrieving an exit point. This is an
optional return parameter that if used must be
specified as *CHAR LEN(10).
RIERTF The format name of the pre-processing exit program
name for retrieving an exit point. This is an
optional return parameter that if used must be
specified as *CHAR LEN(8).
RIEDSL The exit point description location. The values
returned will be *MSGF or *TEXT. This is an
optional return parameter that if used must be
specified as *CHAR LEN(5).
RIEMFN The exit point description message file. The value
will be blank if RIEDSL is *TEXT. This is an
optional return parameter that if used must be
specified as *CHAR LEN(10).
RIEMFL The exit point description message file library.
The value will be blank if RIEDSL is *TEXT. This is
an optional return parameter that if used must be
specified as *CHAR LEN(10).
RIEMID The exit point description message ID. The value
will be blank if RIEDSL is *TEXT. This is an
optional return parameter that if used must be
specified as *CHAR LEN(7).
RIETXT The exit point text description. The value will be
blank if RIEDSL is *MSGF. This is an optional
return parameter that if used must be specified as
*CHAR LEN(50).
RIPNBR The exit program number. The value will be 0 if the
exit program is not found. This is an optional
return parameter that if used must be specified as
*DEC LEN(10 0).
RIPPGM The exit program name. This is an optional return
parameter that if used must be specified as *CHAR
LEN(10).
RIPLIB The library of the exit program. This is an
optional return parameter that if used must be
specified as *CHAR LEN(10).
RIPDSL The exit point description location. The values
will be *MSGF or *TEXT. This is an optional return
parameter that if used must be specified as *CHAR
LEN(5).
RIPMFN The exit point description message file name. The
value will be blank if RIPDSL is *TEXT. This is an
optional return parameter that if used must be
specified as *CHAR LEN(10).
RIPMFL The exit point description message file library
name. The value will be blank if RIPDSL is *TEXT.
This is an optional return parameter that if used
must be specified as *CHAR LEN(10).
RIPMID The exit point description message ID. The value
will be blank if RIPDSL is *TEXT. This is an
optional return parameter that if used must be
specified as *CHAR LEN(7).
RIPTXT The exit point text description. The value will be
blank if RIPDSL is *MSGF. This is an optional
return parameter that if used must be specified as
*CHAR LEN(50).
RIPCCSID The exit program data CCSID. This is an optional
return parameter that if used must be specified as
*DEC LEN(5 0).
RIPTHRSAF The thread safety status of the exit program entry.
The values will be Y, N, or U (unknown). This is an
optional return parameter that if used must be
specified as *CHAR LEN(1).
RIPTHRACN The action to be taken when calling an exit program
in a multi-threaded job.
'1' means to send an escape and do not call the exit
program. CPF3C80 may be used as the escape
message).
'2' means to send an informational message and do
not call the exit program. CPF3C80 may be used as
the informational message.
This is an optional return parameter that if used
must be specified as *CHAR LEN(1).
RIPDTL The length of the exit program data. This is an
optional return parameter that if used must be
specified as *DEC LEN(5 0).
RIPDTA The exit program data. This is an optional return
parameter that if used must be specified as *CHAR
LEN(2048).
Restrictions
------------
None.
Prerequisites
-------------
The following TAA Tools must be on your system:
SNDCOMPMSG Send completion message
SNDESCINF Send escape information
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVREGINF *CMD TAAREGC QATTCMD
TAAREGCC *PGM CLP TAAREGCC QATTCL
TAAREGCR *PGM RPGLE TAAREGCR QATTRPG
|
Added to TAA Productivity tools January 1, 2008