pbs_deljob(3B)

NAME
pbs_deljob - delete a PBS batch job

SYNOPSIS
#include <pbs_error.h>
#include <pbs_ifl.h>

int pbs_deljob(int connect, char *job_id, char *extend)

DESCRIPTION
Issue a batch request to delete a batch job. If the batch job is running, the execution server will send the SIGTERM signal followed by SIGKILL .

A Delete Job batch request is generated and sent to the server over the connection specified by connect which is the return value of pbs_connect().

The argument, job_id , identifies which job is to be deleted. It is specified in the form:
    sequence_number.server

The argument, extend , is overloaded to serve more than one purpose. If extend points to a string other than the above, it is taken as text to be appended to the message mailed to the job owner. This mailing occurs if the job is deleted by a user other than the job owner.

SEE ALSO
qdel(1B) and pbs_connect(3B)

DIAGNOSTICS
When the batch request generated by the pbs_deljob() function has been completed successfully by a batch server, the routine will return 0 (zero). Otherwise, a non zero error is returned. The error number is also set in pbs_errno.