Cancel EDRS Request (QxdaCancelEDRS) API


  Required Parameter Group:

1 Connection handle Input Binary(4)
2 Input structure Input Char(*)
3 Input structure format Input Char(8)
4 Error code I/O Char(*)

  Service Program Name: QXDAEDRS

  Default Public Authority: *USE

  Threadsafe: Conditional; see Usage Notes

The Cancel EDRS Request (QxdaCancelEDRS) API is used to cancel a previous call to the QxdaProcessExtDynEDRS or QxdaProcessImmediateEDRS APIs. All parameters are passed to the program by reference.


Authorities and Locks

Job Authority
To perform a cancel operation, you must be running under a user profile that is the same as the job user identity of the job being canceled, or the issuer of the command must be running under a user profile that has job control (*JOBCTL) special authority.

The job user identity is the name of the user profile by which a job is known to other jobs. It is described in more detail in the Work management topic collection.


Required Parameter Groups

Connection handle
INPUT; BINARY(4)

The handle number of the connection on which to execute the cancel request. The connection handle must have been generated by the QxdaConnectEDRS API in the current job and activation group. The connection must have been made to the same system where the qualified job name, user, and number currently is executing.

Input structure
INPUT; CHAR(*)

The structure in which to pass information about the job to cancel. For the format of this parameter, see CNCL0100 Format.

Input structure format
INPUT; CHAR(8)

The format of the input structure template being used. The possible value is:

CNCL0100 Basic input structure

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


CNCL0100 Format

The following table shows the information to pass in the CNCL0100 format. For more details about the fields in this table, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 CHAR(26) Fully qualified job name


Field Descriptions

Fully qualified job name. The fully qualified name of the job to cancel. The qualified job name has three parts:

Job name CHAR(10). The job name.
User name CHAR(10). The user profile name for the job.
Job number CHAR(6). The job number.


Usage Notes

This function may be called from the initial thread of a job only.


Error Messages

Message ID Error Message Text
CPFAE14 E Cannot allocate &1 bytes.
CPFB750 E Connection handle specified not valid.
CPFB757 E The connection is suspended.
CPFB758 E The EDRS server system has been switched.
CPF1344 E Not authorized to control job &1.
CPF1321 E Job &1 user &2 job number &3 not found.

API introduced: V5R2

[ Back to top | Database and File APIs | APIs by category ]