=head1 NAME

gbatch_putarg - insert a new argument into a job structure

=head1 SYNOPSIS

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

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

B<int gbatch_putarg(apiBtjob *>I<jobp>B<, const unsigned>
I<indx>B<, const char *>I<newarg>B<)>

=head1 DESCRIPTION

The function B<gbatch_putarg> is used to replace or add a new argument to
the argument list of a job.

I<jobp> is a pointer to a structure containing the details of the job.

I<indx> is the number of the argument to be replaced or added. This
may be greater than any number of existing arguments if required, in
which case any intervening arguments are created as empty strings.

I<newarg> is the character string containing the new argument.

=head1 RETURN VALUES

The result is non-zero if successful or zero if the string table
overflowed.  In the latter case the contents of the string table
should not be relied upon. The job structure should be saved first if
in doubt.

=head1 SEE ALSO

gbatch_delarg(3),
gbatch_delenv(3),
gbatch_delredir(3),
gbatch_getarg(3),
gbatch_getdirect(3),
gbatch_getenv(3),
gbatch_getenvlist(3),
gbatch_getredir(3),
gbatch_gettitle(3),
gbatch_putdirect(3),
gbatch_putenv(3),
gbatch_putenvlist(3),
gbatch_putredir(3),
gbatch_putredirlist(3),
gbatch_puttitle(3),
gbatch_setqueue(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:
