NRJEHJCancel [ SNA NRJE User/Programmer Reference Manual ] MPE/iX 5.0 Documentation
SNA NRJE User/Programmer Reference Manual
NRJEHJCancel
Cancels jobs already transmitted to the host, by marking the Job Log to
dispose of returning data sets. This intrinsic does not apply if you are
connected to a VSE/POWER host system.
Syntax
______________________________________________________________________
| |
| |
| BA BA I BA I |
| NRJEHJCancel (Wsid, UserName, UserNameLen, JobList, JobListLen,|
| I IA |
| NumCancelled, Result) |
______________________________________________________________________
Parameters
Wsid An eight-character input byte array. The Wsid parameter identifies
your workstation. It must contain a left-justified alphanumeric name
beginning with a letter. If the workstation identifier is less than
eight characters long, it must be followed by blanks.
UserName An input byte array (value required if JobList and JobListLen are not
supplied. If both UserName and JobList are supplied, only JobList is
used to match host jobs). The UserName parameter specifies the kind
of job information you want. A name can be one of the following:
* An @ character. Use of this character cancels all your own jobs.
If you have NM capability, all jobs will be cancelled.
* A UserName.AcctName. (If you are referring to jobs submitted by
another user with this parameter, you must have NM capability).
UserNameLen An input integer variable (value required if UserName is supplied).
The UserNameLen parameter specifies the number of bytes in UserName,
from 0 through 17.
JobList An input byte array (value required if UserName and UserNameLen are
not supplied; if JobList is supplied, UserName and UserNameLen are
not required, and will be ignored).
The JobList array is a list of host job names and/or numbers. Names
are those on the host JCL JOB card. When cancelling jobs by job
names, only jobs submitted by the logon UserName.AcctName are
cancelled. The exception to this is a logon with NM capability.
When cancelling by job number, you must have NM capability to cancel
jobs submitted by another user. Numbers are those assigned by the
host system. Each entry is eight characters long, left-justified,
and blank-filled. An example of JobList with four entries is:
DS1
1099
2122
FIRSTONE
JobListLen An input integer variable (value required if JobList is supplied).
The JobListLen parameter specifies the number of entries in the
JobList.
NumCancelled An output integer (required). NumCancelled is returned to reflect
the number of host jobs that were successfully cancelled.
Result An eight-element integer output array (required). The Result array
contains error codes that occurred during execution of this
intrinsic.
The first element of the Result array is set to zero if no errors
took place. The structure of the Result array is described in
"Parameters Common to NRJE Intrinsics" in the introduction to this
chapter.
Always test the first element of Result immediately after you call
this intrinsic. If the first element of Result is not zero, test the
other elements of Result to determine the nature of the problem that
has occurred.
Description
Use NRJEHJCancel to cancel jobs already transmitted to the host. This
intrinsic functions by marking the Job Log to purge returning output data
sets for the cancelled jobs. Specify a job set one of these ways:
* All files of the logon user, or all files of another user if you have
NM capability.
* Individually, by host job number, or host job name. Note that if
more than one job matches the job name, only those matching the logon
UserName.AcctName are cancelled. If you have NM capability, all jobs
that match the job name are cancelled.
After NRJEHJCancel has returned control to your program, test the first
element of Result. If the first element of Result is not zero, test the
other elements of Result to determine the nature of the problem that has
occurred.
Text Reference
See the CANCEL command in Chapter 3, "User Commands."
MPE/iX 5.0 Documentation