pbs_statque Manual Page


     NAME
	  pbs_statque -	obtain status of 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)

     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 connect which	is the
	  return value of pbs_connect().

	  The id is the	name of	a queue, in the	form:
	       queue_name
	  or the null string.  If queue_name is	specified, the status
	  of the queue named queue_name	at the server will be
	  returned.  If	the id is a null string	or null	pointer, the
	  status of all	queues at the server will be returned.

	  The parameter, attrib, is a pointer to an attrl structure
	  which	is defined in pbs_ifl.h	as:

	      struct attrl {
		  struct attrl *next;
		  char	       *name;
		  char	       *resource;
		  char	       *value;
	      };

	  The attrib list is terminated	by the first entry where next
	  is a null pointer.  If attrib	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 attrib list is specified, the name	member is a pointer to
	  a attribute name as listed in	pbs_alter(3) and
	  pbs_submit(3).  The resource member is only used if the name
	  member is ATTR_l, otherwise it should	be a pointer to	a null
	  string.  The value member should aways be a pointer to a
	  null string.

	  The parameter, extend, 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:

	      struct batch_status {
		  struct batch_status *next;
		  char		      *name;
		  struct attrl	      *attribs;
		  char		      *text;
	      }

	  It is	up the user to free the	structure when no longer
	  needed, by calling pbs_statfree().

     SEE ALSO
	  qstat(1B) 

     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.