gbatch_varfind(3)

NAME
gbatch_varfind - find a variable by name and read it

gbatch_varfindslot - find a variable by name return the slot number

SYNOPSIS
#include <gbatch.h>

int gbatch_varfind(const int fd, const unsigned flags, const char *vname, const netid_t nid, slotno_t *slot, apiBtvar *vard)

int gbatch_varfindslot(const int fd, const unsigned flags, const char *vname, const netid_t nid, slotno_t *slot)

DESCRIPTION
The function gbatch_varfind is used to retrieve the details of a variable, starting from its name, in one operation.

The function gbatch_varfindslot is used to retrieve just the slot number of a variable, starting from its name.

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

flags is zero or the logical OR of one or more of the following bits:

GBATCH_FLAG_LOCALONLY
    Search for variables local to the server only.

GBATCH_FLAG_USERONLY
    Search for variables owned by the user only.

GBATCH_FLAG_GROUPONLY
    Search for variables owned by the group only.

vname is the variable name to be searched for.

nid is the IP address (in network byte order) of the host on which the searched-for variable is to be located. It should be correct even if "GBATCH_FLAG_LOCALONLY" is specified.

slot is assigned the slot number corresponding to the variable. It may be null is not required, but this would be nearly pointless with gbatch_varfindslot (other than reporting that the variable was unknown).

vard is a pointer to a structure which will contain the details of the variable for gbatch_varfind.

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

SEE ALSO
gbatch_varadd(3), gbatch_varchcomm(3), gbatch_varchgrp(3), gbatch_varchmod(3), gbatch_varchown(3), gbatch_vardel(3), gbatch_varlist(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.