=head1 NAME

gbatch_getenv - extract an environment varible from a job structure.

=head1 SYNOPSIS

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

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

B<const char *gbatch_getenv(const apiBtjob *>I<jobp>B<, const char *>I<name>B<)>

=head1 DESCRIPTION

The function B<gbatch_getenv> is used to extract an environment variable from a job string table.

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

I<name> is the environment varible required.

=head1 RETURN VALUES

The result is the environment variable value as a C<const> character
string or C<NULL> if the variable does not exist in the job (perhaps
because it is in the static environment file).

=head1 SEE ALSO

gbatch_delarg(3),
gbatch_delenv(3),
gbatch_delredir(3),
gbatch_getarg(3),
gbatch_getdirect(3),
gbatch_getenvlist(3),
gbatch_gethenv(3),
gbatch_getredir(3),
gbatch_gettitle(3),
gbatch_putarg(3),
gbatch_putarglist(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:
