gbatch_ciread - read the list of command interpreters

# NAME

gbatch_ciread - read the list of command interpreters

# SYNOPSIS

#include <gbatch.h>

int ciread(const int fd, const unsigned flags, int *numcis, Cmdint **cilist)

# DESCRIPTION

The function gbatch_ciread is used to read the list of command interpreters from the given server. This may be invoked by any user, no special permission is required.

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

flags is currently unsused, but is reserved for future use.

numcis is a pointer to an integer which upon return will contain the number of command interpreter structures returned in cilist. (This might exceed the number of actual command interpeters if some have been deleted).

cilist is a pointer to which a vector of command interpreter structures will be assigned by this routine. The user should not attempt to free the memory used by this structure as it is owned by the API. The list returned may possibly have "holes" in it where previously-created command interpreters have been deleted. These holes can be identified by having a null `ci_name` field.

The index number of each element in the vector is the number which should be used as the third argument in `gbatch_cidel(3)` and `xb_ciupd(3)` calls.

# RETURN VALUES

The function returns 0 if successful otherwise one of the error codes listed in the start of this chapter.

# SEE ALSO

`gbatch_ciadd(3)`, `gbatch_cidel(3)`, `gbatch_ciupd(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.