ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/gnetadr.htm

238 lines
6.2 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>getnetbyaddr()--Get Network Information for IP Address</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- Unix8 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--End Header Records --><!-- Edited by Kersten Feb 02 -->
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>getnetbyaddr()--Get Network Information for IP Address</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;BSD 4.3 Syntax<br>
<pre>
#include &lt;netdb.h&gt;
struct netent *getnetbyaddr(long <em>network_address</em>,
int <em>address_type</em>)
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QSOSRV2<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No; see <a href="#USAGE_NOTES">Usage Notes</a>.<br>
<!-- iddvc RMBR -->
<br>
</div>
<br>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;<a href="_xopen_source.htm">UNIX 98 Compatible Syntax</a><br>
<pre>
#define _XOPEN_SOURCE 520
#include &lt;netdb.h&gt;
struct netent *getnetbyaddr(uint32_t <em>network_address</em>,
int <em>address_type</em>)
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QSOSRV2<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No; see <a href="#USAGE_NOTES">Usage Notes</a>.<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <em>getnetbyaddr()</em> function is used to retrieve information about a
network. The information is retrieved from the network database file.</p>
<p>There are two versions of the API, as shown above. The base i5/OS API uses BSD 4.3
structures and syntax. The other uses syntax and structures compatible with the UNIX 98
programming interface specifications. You can select the UNIX 98 compatible
interface with the <a href="_xopen_source.htm">_XOPEN_SOURCE</a> macro.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>network_address</strong></dt>
<dd>(Input) The 32-bit network IP address for which information is to be
retrieved.<br>
<br>
</dd>
<dt><strong>address_type</strong></dt>
<dd>(Input) An integer that indicates the type of
<em>network_address</em>.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>No authorization is required.</p>
<br>
<h3>Return Value</h3>
<p><em>getnetbyaddr()</em> returns a pointer. Possible values are: </p>
<ul>
<li>NULL (unsuccessful)<br>
<br>
</li>
<li>p (successful), where p is a pointer to <strong>struct
netent</strong>.</li>
</ul>
<p>The structure <strong>struct netent</strong> is defined in
<strong>&lt;netdb.h&gt;</strong>.</p>
<pre>
struct netent {
char *n_name;
char **n_aliases;
int n_addrtype;
unsigned long n_net;
};
</pre>
<p><em>n_name</em> points to the character string that contains the name of the
network. <em>n_aliases</em> is a pointer to a NULL-terminated array of
alternate names for the network. <em>n_addrtype</em> contains the address type
of the network. <em>n_net</em> is the 32-bit network address (an IP address
with host part set to zero).</p>
<br>
<h3><a name="USAGE_NOTES">Usage Notes</a></h3>
<ol>
<li>The iSeries Navigator or the following CL commands can be
used to access the network database file: <br><br>
<ul>
<li>WRKNETTBLE (Work with Network Table Entries)<br>
<br>
</li>
<li>ADDNETTBLE (Add Network Table Entry)<br>
<br>
</li>
<li>RMVNETTBLE (Remove Network Table Entry)</li>
</ul>
<br>
</li>
<li>The pointer returned by <em>getnetbyaddr()</em> points to static storage
that is overwritten on subsequent calls to the <em>getnetbyaddr()</em>,
<em>getnetbyname()</em>, or <em>getnetent()</em> functions.<br>
<br>
</li>
<li>When the network information is obtained from the network database file,
the file is opened and the network information is retrieved (if it exists) from
the file. The file is then closed only if a <em>setnetent()</em> with a nonzero
parameter value was not previously done.<br>
<br>
</li>
<li>A coded character set identifier (CCSID) of 65535 for the job requests that
no database translation be performed. For translation to occur for the network
names returned in the netent structure, the job CCSID must be something other
than 65535.<br>
<br>
</li>
<li>Do not use the <em>getnetbyaddr()</em> function in a multithreaded
environment. See the multithread alternative <em>getnetbyaddr_r()</em>
function.<br>
<br>
</li>
<li>When you develop in C-based languages and an application is compiled with the _XOPEN_SOURCE
macro defined to the value 520 or greater, the <em>getnetbyaddr()</em> API is mapped to
<em>qso_getnetbyaddr98()</em>.</li>
</ol>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="_xopen_source.htm">_XOPEN_SOURCE</a>--Using _XOPEN_SOURCE for the UNIX 98
compatible interface<br>
<br>
</li>
<li><a href="gnetnm.htm">getnetbyname()</a>--Get Network Information for Domain
Name<br>
<br>
</li>
<li><a href="gnetnt.htm">getnetent()</a>--Get Next Entry from Network
Database<br>
<br>
</li>
<li><a href="snetnt.htm">setnetent()</a>--Open Network Database<br>
<br>
</li>
<li><a href="enetnt.htm">endnetent()</a>--Close Network Database</li>
</ul>
<br>
<hr>
API introduced: V3R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a> </td>
</tr>
</table>
</center>
</body>
</html>