Service Entry Point Stop Handler Exit Program

Required Parameter Group:

1	Qualified program name	Input	Char(*)
2	Program type	Input	Char(10)
3	Module name	Input	Char(10)
4	Stop information	Input	Char(*)
5	Fully qualified job name	Input	Char(30)

QSYSINC Member Name: ETEPSEPH

Threadsafe: No

The Service Entry Point Stop Handler exit program is a user-written program that handles the service entry point program-stop condition.

This program must be identified to the Source Debugger support with the Register Service Entry Point Handler (QteRegSrvEntPntStpHdlr) API.

The location at which the service entry point was encountered is specified in the stop information parameter and is in terms of the statement view. The user-supplied program may use the Map View Position (QteMapViewPosition) API to determine the location to which this program maps any other registered view.

Debugging of threaded jobs is enabled by the thread ID field that is contained in the parameters passed to the stop handler. Threads debugging is supported if a service job is used to debug a job that was spawned by native threads support. For nonthreaded applications, the thread ID passed will always be that of the initial job thread.

Authorities and Locks

None.

Required Parameter Group

Qualified program name

INPUT; CHAR(*)

The format of this parameter is dependent on the program type parameter. If the program type is *PGM or *SRVPGM, the format of this parameter is as follows:

The name of the program that is stopped as a result of a service entry point.
The first 10 characters contain the name of the program. The second 10 characters contain the name of the library where the program is located. Each name is left-justified.

If the program type is *CLASS, the format of this parameter is as follows:

The null-terminated class file name of the JAVA class.

Program type

INPUT; CHAR(10)

The object type of the program that is stopped.

The possible values are:

*PGM	Bound program or OPM program
*SRVPGM	Service program
*CLASS	JAVA class file

Module name

INPUT; CHAR(10)

The name of the module (left-justified) that is stopped. The value of this field is blank for OPM programs and JAVA class files.

Stop information

INPUT; CHAR(*)

A list of locations within the statement view where the program stop condition occurred.

Thread ID	CHAR(8) The thread identification of the thread where the program is stopped.
Offset to stopped locations	BINARY(4) The offset from the start of the stop information to the first stop location.
Number of stopped locations	BINARY(4) The number of positions stored in the stop information parameter. In some cases, it is not known exactly where a program is stopped; therefore, multiple positions are given. Each entry specifies one position in the statement view. This number is not less than one nor greater than three. At least one stopped position will be identified; if stopped at more than one position, no more than the first three positions are made available.
Stopped locations	Array of BINARY(4) The line number in the statement view where the program is stopped.

Fully qualified job name

INPUT; CHAR(30)

The name of the job in which the program stop condition occurred. The fully qualified job name consists of three parts. The first 10 characters contain the job name. The next 10 characters contain the user name. The last 10 characters contain the 6-character job number followed by 4 blanks.