1pbs_holdjob(3B)                       PBS                      pbs_holdjob(3B)
2
3
4

NAME

6       pbs_holdjob - place a hold on a pbs batch job
7

SYNOPSIS

9       #include <pbs_error.h>
10       #include <pbs_ifl.h>
11
12       int pbs_holdjob(int connect, char *job_id, char *hold_type,
13       char *extend)
14

DESCRIPTION

16       Issue a batch request to place a hold upon a job.
17
18       A  Hold  Job batch request is generated and sent to the server over the
19       connection specified by connect which is the return value  of  pbs_con‐
20       nect().
21
22       The  argument, job_id, identifies which job is to be held, it is speci‐
23       fied in the form: sequence_number.server
24
25       The parameter, hold_type, contains the type of hold to be applied.  The
26       possible values are defined in pbs_ifl.h as:
27
28              #define USER_HOLD "u"
29                     Available  to  the  owner of the job, the batch operator,
30                     and the batch administrator.
31
32              #define OTHER_HOLD "o"
33                     Available to the batch operator and the batch administra‐
34                     tor.
35
36              #define SYSTEM_HOLD "s"
37                     Available only to the batch administrator.
38
39       If  hold_type  is  either  a  null  pointer or points to a null string,
40       USER_HOLD will be applied.
41
42       The parameter, extend, is reserved for  implementation  defined  exten‐
43       sions.
44

SEE ALSO

46       qhold(1B), pbs_connect(3B), pbs_alterjob(3B), and pbs_rlsjob(3B)
47

DIAGNOSTICS

49       When  the  batch  request generated by pbs_holdjob () function has been
50       completed successfully by a batch server, the  routine  will  return  0
51       (zero).   Otherwise, a non zero error is returned.  The error number is
52       also set in pbs_errno.
53
54
55
56
57Local                                                          pbs_holdjob(3B)
Impressum