aboutsummaryrefslogtreecommitdiff
path: root/unix/os/doc/zcldpr.hlp
blob: 5e80700c9d36720ea827258b7e58b97015dd4cb9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.help zcldpr May84 "System Interface"
.ih
NAME
zcldpr -- close a detached process
.ih
SYNOPSIS
.nf
zcldpr (jobcode, killflag, exit_status)

int	jobcode			# code by which job is known to system
int	killflag		# if YES, kill bkg job
int	exit_status		# exit status of bkg job
.fi
.ih
DESCRIPTION
If \fIkillflag\fR is NO, process execution will be suspended until
the background job terminates.  If \fIkillflag\fR is YES the background
job is dequeued if it has not yet been run, or is killed if it is currently
executing.  The integer \fIjobcode\fR is the magic number assigned the
job by the \fBzopdpr\fR primitive.
.ih
RETURN VALUE
ERR is returned for an illegal \fIjobcode\fR or for an attempt to kill
a job without the necessary permissions.  If the operations completes
successfully the exit status of the process, i.e., OK or a positive integer
error code, is returned in \fIexit_status\fR.
.ih
NOTES
The CL calls this procedure whenever it detects that a background job has
terminated, since a background job may be run as a subprocess on some systems
and since it may be necessary to perform special actions after a subprocess has
terminated.  The CL also calls this procedure whenever the user \fBkills\fR a
background job, or when the user wishes to \fBwait\fR for a background job to
terminate.
.ih
SEE ALSO
zopdpr
.endhelp