UTMEX1 - Timer User Exit

UTMEX1 is a user-written routine that examines each new timer request that is to be added to the timer SD file by UTIMER.

A request can be rejected by the exit. If this occurs, a 40-byte disallow message must be passed back to the calling routine.

A dummy UTMEX1 module is distributed with the Com-plete system as a member of the distribution and load libraries.

This document covers the following topics:

How to Use UTMEX1

Upon entry to UTMEX1, a set of parameters is received in the form of fullword addresses pointed to by register 1. Word 1 of the parameter list contains the address of a return code halfword. Word 2 of the parameter list contains the address of a timer record in the format of a DSECT defined by the TIMRSD macro. Word 3 of the parameter list contains the address of 40 bytes used by UTMEX1 to pass a return code back to UTIMER.

UTMEX1 Conventions

The following table summarizes the UTMEX1 linkage conventions.

Feature Convention
Attributes None required.
Type Thread.
Size No restrictions.
Registers at Entry
Register 1 Address of the parameter list
Register 13 Address of the caller's 18-fullword save area
Register 14 Return address in the calling module
Register 15 Entry point address
Registers at Return Registers 14 through 12 must be unchanged.
Parameters
Word 1 Address of a return code halfword
Word 2 Address of the timer record
Word 3 Address of the return code
Return Codes
0 Normal return. Allow log service in the timer SD file.
4 Do not allow log service in the timer SD file.
Considerations
a Is loaded by UTIMER.
b Linkage is dynamic, with COLOAD.