Delete User Exit Routine requirements

If you specify a user exit option parameter, SCLM passes it to the user exit routine, followed by a string of up to ten parameters separated by commas. The parameter list can include one list of user-specified options followed by up to nine SCLM parameters (see Table 1). The address of this input data is contained at the address stored in register 1. The first halfword of the input data is the number of characters comprising the input data string. Immediately following this halfword length is the input parameter string itself.

The user exit routine must pass back a return code value to SCLM in register 15. A return code of zero is considered to be successful and processing continues. For the Delete Verify and Delete Initial exit routines, any return code other than zero indicates failure and processing ends. In the case of the Delete Notify exit, the delete has already been performed. SCLM will, however, set a return code of 4 for the final SCLM return code if a nonzero return code is set in the user exit.

Table 1 explains the format and description of the parameters passed from SCLM to all delete user exits.

Table 1. User Exit Parameters
Parameter	Description
OPTION LIST	Up to 255 characters, including delimiters (blank padding is not performed for this parameter). Parameter is specified in the FLMCNTRL macro using macro parameters DELINTOP, DELVFYOP, and DELNTFOP. Delimit this string so that the SCLM parameters that follow can be identified by the user exit routine.
‘xxxxxxxx’	An 8-character literal value indicating the exit type (capitalized, left-aligned, blank-padded). Valid types are: DGINIT Initial Delete DVERIFY Verify delete exit invoked for the DELETE service or Library Utility Delete DNOTIFY Notify delete exit invoked for the DELETE service or Library Utility Delete DGNOTIFY Notify delete exit invoked for the DELGROUP service or Delete from Group dialog
PROJECT	The 8-character name of the project (capitalized, left-aligned, blank-padded).
LIBDEF	The 8-character name of the project definition (capitalized, left-aligned, blank-padded).
USERID	The 8-character value of the user's logon ID (capitalized, left-aligned, blank-padded).
GROUP	The 17-character name of the group (capitalized, left-aligned, blank-padded).
TYPE	The 17-character name of the type (capitalized, left-aligned, blank-padded).
MEMBER	The 17-character name of the member (capitalized, left-aligned, blank-padded).
FLAG	The 8-character delete flag (capitalized, left-aligned, blank-padded). Valid delete flags are ACCT, BMAP, TEXT, and OUTPUT. This value is always TEXT for a Library Utility Delete. OUTPUT is valid only for Delete from Group.
MODE	The 8-character name of the mode (capitalized, left-aligned, blank-padded). Valid modes are EXECUTE and REPORT. This value is valid only for Delete from Group. A blank value is passed for the DELETE service and Library Utility Delete.

Delete from Group allocates the following ddnames for internal use: DGEXIT; DGLIST; DGMSGS; DGREPT

Use of these names in a delete user exit routine can cause conflicts. At the end of an exit routine, free only those ddnames explicitly allocated by the exit routine.