man-pages/man3/getnetent_r.3.html
2021-03-31 01:06:50 +01:00

242 lines
5.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GETNETENT_R</TITLE>
</HEAD><BODY>
<H1>GETNETENT_R</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
getnetent_r, getnetbyname_r, getnetbyaddr_r - get
network entry (reentrant)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/netdb.h">netdb.h</A>&gt;</B>
<B>int getnetent_r(struct netent *</B><I>result_buf</I><B>, char *</B><I>buf</I><B>,</B>
<B> size_t </B><I>buflen</I><B>, struct netent **</B><I>result</I><B>,</B>
<B> int *</B><I>h_errnop</I><B>);</B>
<B>int getnetbyname_r(const char *</B><I>name</I><B>,</B>
<B> struct netent *</B><I>result_buf</I><B>, char *</B><I>buf</I><B>,</B>
<B> size_t </B><I>buflen</I><B>, struct netent **</B><I>result</I><B>,</B>
<B> int *</B><I>h_errnop</I><B>);</B>
<B>int getnetbyaddr_r(uint32_t </B><I>net</I><B>, int </B><I>type</I><B>,</B>
<B> struct netent *</B><I>result_buf</I><B>, char *</B><I>buf</I><B>,</B>
<B> size_t </B><I>buflen</I><B>, struct netent **</B><I>result</I><B>,</B>
<B> int *</B><I>h_errnop</I><B>);</B>
</PRE>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>getnetent_r</B>(),
<B>getnetbyname_r</B>(),
<B>getnetbyaddr_r</B>():
<BR>&nbsp;&nbsp;&nbsp;&nbsp;Since&nbsp;glibc&nbsp;2.19:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_DEFAULT_SOURCE
<BR>&nbsp;&nbsp;&nbsp;&nbsp;Glibc&nbsp;2.19&nbsp;and&nbsp;earlier:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_BSD_SOURCE&nbsp;||&nbsp;_SVID_SOURCE
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>getnetent_r</B>(),
<B>getnetbyname_r</B>(),
and
<B>getnetbyaddr_r</B>()
functions are the reentrant equivalents of, respectively,
<B><A HREF="/cgi-bin/man/man2html?3+getnetent">getnetent</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+getnetbyname">getnetbyname</A></B>(3),
and
<B><A HREF="/cgi-bin/man/man2html?3+getnetbynumber">getnetbynumber</A></B>(3).
They differ in the way that the
<I>netent</I>
structure is returned,
and in the function calling signature and return value.
This manual page describes just the differences from
the nonreentrant functions.
<P>
Instead of returning a pointer to a statically allocated
<I>netent</I>
structure as the function result,
these functions copy the structure into the location pointed to by
<I>result_buf</I>.
<P>
The
<I>buf</I>
array is used to store the string fields pointed to by the returned
<I>netent</I>
structure.
(The nonreentrant functions allocate these strings in static storage.)
The size of this array is specified in
<I>buflen</I>.
If
<I>buf</I>
is too small, the call fails with the error
<B>ERANGE</B>,
and the caller must try again with a larger buffer.
(A buffer of length 1024 bytes should be sufficient for most applications.)
<P>
If the function call successfully obtains a network record, then
<I>*result</I>
is set pointing to
<I>result_buf</I>;
otherwise,
<I>*result</I>
is set to NULL.
<P>
The buffer pointed to by
<I>h_errnop</I>
is used to return the value that would be stored in the global variable
<I>h_errno</I>
by the nonreentrant versions of these functions.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success, these functions return 0.
On error, they return one of the positive error numbers listed in ERRORS.
<P>
On error, record not found
(<B>getnetbyname_r</B>(),
<B>getnetbyaddr_r</B>()),
or end of input
(<B>getnetent_r</B>())
<I>result</I>
is set to NULL.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="1"><B>ENOENT</B>
<DD>
(<B>getnetent_r</B>())
No more records in database.
<DT id="2"><B>ERANGE</B>
<DD>
<I>buf</I>
is too small.
Try again with a larger buffer
(and increased
<I>buflen</I>).
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>getnetent_r</B>(),
<B>getnetbyname_r</B>(),
<B>getnetbyaddr_r</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe locale<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
These functions are GNU extensions.
Functions with similar names exist on some other systems,
though typically with different calling signatures.
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+getnetent">getnetent</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?5+networks">networks</A></B>(5)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="7"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="8"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="9"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="10"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="11"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:44 GMT, March 31, 2021
</BODY>
</HTML>