Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/if_nameindex.html
2024-02-19 00:21:47 -05:00

120 lines
3.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>if_nameindex</title>
</head>
<body bgcolor="white">
<basefont size="3"> <a name="if_nameindex"></a> <a name="tag_03_272"></a><!-- if_nameindex -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_272_01"></a>NAME</h4>
<blockquote>if_nameindex - return all network interface names and indexes</blockquote>
<h4><a name="tag_03_272_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/net/if.h.html">net/if.h</a>&gt;<br>
<br>
struct if_nameindex *</tt><i>if_nameindex</i><tt>(void);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_272_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>if_nameindex</i>() function shall return an array of <i>if_nameindex</i> structures, one structure per interface. The end
of the array is indicated by a structure with an <i>if_index</i> field of zero and an <i>if_name</i> field of NULL.</p>
<p>Applications should call <a href="../functions/if_freenameindex.html"><i>if_freenameindex</i>()</a> to release the memory that
may be dynamically allocated by this function, after they have finished using it.</p>
</blockquote>
<h4><a name="tag_03_272_04"></a>RETURN VALUE</h4>
<blockquote>
<p>An array of structures identifying local interfaces. A NULL pointer is returned upon an error, with <i>errno</i> set to indicate
the error.</p>
</blockquote>
<h4><a name="tag_03_272_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>if_nameindex</i>() function may fail if:</p>
<dl compact>
<dt>[ENOBUFS]</dt>
<dd>Insufficient resources are available to complete the function.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_272_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_272_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_272_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_272_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_272_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="getsockopt.html"><i>getsockopt</i>()</a> , <a href="if_freenameindex.html"><i>if_freenameindex</i>()</a> , <a href=
"if_indextoname.html"><i>if_indextoname</i>()</a> , <a href="if_nametoindex.html"><i>if_nametoindex</i>()</a> , <a href=
"setsockopt.html"><i>setsockopt</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/net/if.h.html"><i>&lt;net/if.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_272_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 6. Derived from the XNS, Issue 5.2 specification.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>