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

NAME

6       pbs_statque - obtain status of pbs batch queues
7

SYNOPSIS

9       #include <pbs_error.h>
10       #include <pbs_ifl.h>
11
12       struct batch_status *pbs_statque(int connect, char *id,
13       struct attrl *attrib,
14       char *extend)
15
16       void pbs_statfree(struct batch_status *psj)
17

DESCRIPTION

19       Issue a batch request to obtain the status of a batch queue.
20
21       A  Status  Queue batch request is generated and sent to the server over
22       the connection specified by  connect  which  is  the  return  value  of
23       pbs_connect().
24
25       The id is the name of a queue, in the form:
26            queue_name
27       or  the  null  string.   If  queue_name is specified, the status of the
28       queue named queue_name at the server will be returned.  If the id is  a
29       null  string  or  null  pointer, the status of all queues at the server
30       will be returned.
31
32       The parameter, attrib, is a pointer to  an  attrl  structure  which  is
33       defined in pbs_ifl.h as:
34
35           struct attrl {
36               struct attrl *next;
37               char         *name;
38               char         *resource;
39               char         *value;
40           };
41
42       The  attrib  list is terminated by the first entry where next is a null
43       pointer.  If attrib is given, then only the attributes in the list  are
44       returned  by  the  server.   Otherwise, all the attributes of a job are
45       returned.  When an attrib list is  specified,  the  name  member  is  a
46       pointer  to  a  attribute  name  as listed in pbs_alter(3) and pbs_sub‐
47       mit(3).  The resource member is only used if the name member is ATTR_l,
48       otherwise  it  should  be a pointer to a null string.  The value member
49       should aways be a pointer to a null string.
50
51       The parameter, extend, is reserved for  implementation  defined  exten‐
52       sions.
53
54       The  return  value  is  a pointer to a list of batch_status structures,
55       which is defined in pbs_ifl.h as:
56
57           struct batch_status {
58               struct batch_status *next;
59               char                *name;
60               struct attrl        *attribs;
61               char                *text;
62           }
63
64       It is up the user to free the structure when no longer needed, by call‐
65       ing pbs_statfree().
66

SEE ALSO

68       qstat(1B) and pbs_connect(3B)
69

DIAGNOSTICS

71       When  the  batch  request  generated by pbs_statque() function has been
72       completed successfully by a batch server, the  routine  will  return  a
73       pointer  to  the  batch_status structure.  Otherwise, a null pointer is
74       returned and the error code is set in the global integer pbs_errno.
75
76
77
78
79Local                                                          pbs_statque(3B)