=head1 NAME

gbatch_ciadd - add a command interpreter

=head1 SYNOPSIS

=for man
\&\fB#include <gbatch.h>\fR
.PP

=for html
<STRONG>#include &lt;gbatch.h&gt;</STRONG>
<br>

B<int gbatch_ciadd(const int>
I<fd>B<, const unsigned>
I<flags>B<, const Cmdint *>I<newci>B<, unsigned *>I<indx>B<)>

=head1 DESCRIPTION

The function B<gbatch_ciadd> is used to create a new command interpreter
on a B<GNUbatch> server. The invoking user must have I<special create>
permission or the call will be rejected.

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

I<flags> is currently unused, but reserved for future use.

I<newci> is a pointer to a structure containing the new command
interpreter details.

I<indx> is a pointer to an C<unsigned> location into which the index
number of the new command interpreter is placed.

=head1 RETURN VALUES

=for html
<P>The function returns 0 if successful otherwise one of the error codes
<A HREF="#Error_codes">listed at the start of this chapter</A>.</P>

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

=head1 SEE ALSO

gbatch_cidel(3),
gbatch_ciread(3),
gbatch_ciupd(3).

=head1 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.

=head1 AUTHOR

John M Collins, Xi Software Ltd.

=cut

## Local Variables:
## mode: nroff
## End:
