pbs_statque (3) Linux Manual Page

pbs_statque – obtain status of pbs batch queues

Synopsis

#include <pbs_error.h>

#include <pbs_ifl.h>

struct batch_status *pbs_statque(int connect, char *id,
struct attrl *attrib, 
char *extend)
void pbs_statfree(struct batch_status *psj)

Description

Issue a batch request to obtain the status of a batch queue. A Status Queue batch request is generated and sent to the server over the connection specified by which is the return value of pbs_connect(). The is the name of a queue, in the form:

or the null string. If is specified, the status of the queue named at the server will be returned. If the is a null string or null pointer, the status of all queues at the server will be returned. The parameter, is a pointer to an attrl structure which is defined in pbs_ifl.h as: The list is terminated by the first entry where is a null pointer. If is given, then only the attributes in the list are returned by the server. Otherwise, all the attributes of a job are returned. When an list is specified, the member is a pointer to a attribute name as listed in pbs_alter(3) and pbs_submit(3). The member is only used if the name member is ATTR_l, otherwise it should be a pointer to a null string. The member should aways be a pointer to a null string. The parameter, is reserved for implementation defined extensions. The return value is a pointer to a list of batch_status structures, which is defined in pbs_ifl.h as: It is up the user to free the structure when no longer needed, by calling pbs_statfree().

See Also

qstat(1B) and pbs_connect(3B)

Diagnostics

When the batch request generated by pbs_statque() function has been completed successfully by a batch server, the routine will return a pointer to the batch_status structure. Otherwise, a null pointer is returned and the error code is set in the global integer pbs_errno.