Registration Facility APIs

The registration facility is a service that provides storage and retrieval operations for OS/400 and non-OS/400 exit points and exit programs. An exit point is a specific point in a system function or program where control may be passed to one or more specified exit programs. An exit program is a program to which control is passed from an exit point. This exit program can then supplement standard system functions in areas such as additional authorization checks, data transformations, auditing, and so on. Examples of exit programs often can be found with the exit point documentation. For instance, Client Access Exit Program examples can be found in the AS/400 Client Access Host Servers book, SC41-5740 Link outside Information Center

. This registration facility repository allows multiple programs to associate with a given system function or application function.

The registration facility APIs provide the capability to:

Register and deregister exit points with the registration facility
Add and remove exit programs to and from the repository
Retrieve exit point and exit program information from the repository
Designate the order in which exit programs should be called

An exit point can call one program, a fixed number of programs, or all programs associated with an exit point. The exit program number associated with each exit program should be used to determine the sequence in which the exit programs are run.

An exit point can be registered multiple times with the same exit point name; however, the combination of the exit point name and the exit point format name must be unique. Each exit program will be associated with a specific exit point and exit point format. The exit point format name can be used to indicate that a change occurred to the interface of the exit point. For example, this unique name (exit point and format) could be the result of a parameter change, version change, exit program data definition, and so forth. This unique name will facilitate having different exit programs run from different versions of a product for the same exit point name.

The exit point provider is responsible for the following:

Defining the exit point information
Defining the details of the exit program, such as the number of exit programs to call and what the parameters (if any) will be
Calling the exit programs

If you intend to provide an exit point, you should become familiar with all the APIs and the preprocessing exit programs in the registration facility part before using them. The APIs and preprocessing exit programs are interdependent.

If you intend to provide an exit program, you should become familiar with the Add Exit Program and the Remove Exit Program APIs.

The registration facility APIs available to you are:

Add Exit Program (QUSADDEP, QusAddExitProgram) API adds an exit program entry to a specific exit point or replaces an existing exit program.
Deregister Exit Point (QUSDRGPT, QusDeregisterExitPoint) API removes an exit point and all associated exit programs from the registration facility.
Register Exit Point (QUSRGPT, QusRegisterExitPoint) API registers an exit point with the registration facility or updates an exit point.
Remove Exit Program (QUSRMVEP, QusRemoveExitProgram) API removes an exit program entry from a specific exit point.
Retrieve Exit Information (QUSRTVEI, QusRetrieveExitInformation) API retrieves information about one or more exit points and exit programs.

Top | Registration Facility Processing exit programs | APIs by category

[ Information Center Home Page ]

[ Legal | AS/400 Glossary ]