gbatch_varlist(3)

NAME
gbatch_varlist - obtain a list of variables

SYNOPSIS
#include <gbatch.h>

int gbatch_varlist(const int fd, const unsigned flags, int * numvars, slotno_t **slots)

DESCRIPTION
The function gbatch_varlist is used to obtain a vector of slots which can be used to access the details of variables readable by the user.

fd is a file descriptor which was previously returned by a successful call to gbatch_open(3).

flags is zero, or a logical OR of one or more of the following values

GBATCH_FLAG_LOCALONLY
    Ignore remote variables/hosts, i.e. not local to the server, not the client.

GBATCH_FLAG_USERONLY
    Restrict to the user only.

GBATCH_FLAG_GROUPONLY
    Restrict to the current group (possibly as selected by gbatch_newgrp(3)) only.

numvars is a pointer to an integer which will contain the number of variables in the list.

slots is a pointer to an array of slots. The memory used by this list should not be freed by the user as it is owned by the API.

RETURN VALUES
The function returns 0 if successful, otherwise an error code as defined in the include file \fBgbatch.h\fR.

SEE ALSO
gbatch_joblist(3), gbatch_newgrp(3), gbatch_varadd(3), gbatch_varchcomm(3), gbatch_varchgrp(3), gbatch_varchmod(3), gbatch_varchown(3), gbatch_vardel(3), gbatch_varfind(3), gbatch_varmon(3), gbatch_varread(3), gbatch_varrename(3), gbatch_varupd(3).

COPYRIGHT
Copyright (c) 2009 Free Software Foundation, Inc. This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

AUTHOR
John M Collins, Xi Software Ltd.