Introduction › User Exit General Information

User Exit General Information

After the desired user exit source file has been located, make a backup copy of the file, then edit the file and save it back to its original name and location.

Important! Do not modify the package name. Doing so will cause the exit to be unrecognized at runtime.

Because the user exit source files are saved to their original locations, it may be useful to save the original and modified sources in a configuration management system to prevent the changes from being lost should a new installation overwrite the source file.

Note: xx refers to the current release of CA Gen. For the current release number, see the Release Notes.

Note: Throughout this document, steps are provided to execute several Windows user exit rebuild procedures. Before executing these procedures, verify that the required compiler or linker environment variables are initialized. The Microsoft Visual Studio supplies two batch scripts (when working with Visual Studio) that must be run from within the command window to set these variables.

For Visual Studio, these batch scripts may be referenced through the supplied environment variables VSabcCOMNTOOLS and VCINSTALLDIR as follows:

For 32-bit or 64-bit build environments:

“%VSabcCOMNTOOLS%VSVARS32.BAT”

In addition for 64-bit build environments only:

“%VCINSTALLDIR%VCVARSALL.BAT” x64

Note: VSabc refers to the supported version of Visual Studio. Replace VSabc with VS100 for Visual Studio 2010 and VS110 for Visual Studio 2012. xx refers to the current release of CA Gen. For the current release number, see the Release Notes.

In the following chapters, each user exit is documented as follows:

User Exit Name and Title

Acts as heading for User Exit

Functional Usage

Displays calling format, including format, and return variable

Source Code

Indicates name of the source code filename

Purpose

Details the purpose of the user exit

Arguments

Lists a table with arguments and descriptions

Return Code

Lists a table with return codes and descriptions

Default Behavior

Describes how the user exit behaves when delivered (unmodified)

Building on Target System

Describes how to rebuild the user exit

Related User Exits

Displays a list of related user exits