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

269 lines
6.9 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>netdir_getbyaddr()--Translate a Netbuf Address to a Host</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: -->
<!-- YYMMDD USERID Change description -->
<!-- RPCMST SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
<!-- RCHVMW2 on 7 Oct 1998 at 23:43:14 -->
<!-- Edited by Kersten Feb 02 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>netdir_getbyaddr()--Translate a Netbuf Address to a Host</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<!-- iddvc RMBR -->
<br>
<pre>
#include &lt;netdir.h&gt;
int netdir_getbyaddr(struct netconfig *nconf,
struct nd_hostservlist
**service,
struct netbuf *netaddr);
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QZNFTRPC<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>netdir_getbyaddr()</strong> function maps addresses into host
names and service names.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>nconf</strong> &nbsp;(Input)&nbsp;</dt>
<dd>A pointer to a netconfig structure that is returned by either
<strong>getnetconfig()</strong> or <strong>getnetconfigent()</strong>.<br><br></dd>
<dt><strong>service</strong> &nbsp;(Output)&nbsp;</dt>
<dd>A pointer to a list of service names.<br><br></dd>
<dt><strong>netaddr</strong> &nbsp;(Input)&nbsp;</dt>
<dd>A pointer to the address.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>No authorization is required.</p>
<br>
<h3>Return Value</h3>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top"><strong>netdir_getbyaddr()</strong> was successful. A list of
host names and service name pairs is returned in <em>service</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top"><strong>netdir_getbyaddr()</strong> was not successful. The
<em>nd_errno</em> (defined in <strong>&lt;netdir.h&gt;</strong>) is set to
indicate the error.</td>
</tr>
</table>
<br>
<br>
<h3>Error Conditions</h3>
<p>If <strong>netdir_getbyaddr()</strong> is not successful, <em>nd_errno</em>
usually indicates one of the following errors:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>[ND_BADARG]</em></td>
<td align="left" valign="top">Bad argument passed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ND_NO_DATA]</em></td>
<td align="left" valign="top">The host name is a valid name but there is no corresponding IP
address.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ND_NOHOST]</em></td>
<td align="left" valign="top">The host name that the user specified by the host address was
not found.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ND_NOMEM]</em></td>
<td align="left" valign="top">Not enough memory left.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ND_NO_RECOVERY]</em></td>
<td align="left" valign="top">An unrecoverable error has occurred.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ND_SYSTEM]</em></td>
<td align="left" valign="top">A damaged object was encountered. The damaged object cannot be
used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[ND_TRY_AGAIN]</em></td>
<td align="left" valign="top">The local server did not receive a response from an
authoritative server. An attempt at a later time may succeed.</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF9872 E</td>
<td width="85%" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<br>
<h3>Usage Notes</h3>
<p><strong>netdir_getbyaddr()</strong> is called with an address in the
<em>netaddr</em> structure.</p>
<p>The caller is responsible to free the storage allocated by
<strong>netdir_getbyaddr()</strong> by using the function
<strong>netdir_free()</strong>.</p>
<br>
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example shows how <strong>netdir_getbyaddr()</strong> is
used:</p>
<pre>
#include &lt;netdir.h&gt;
void findhost(void)
{
void *handlep;
struct netconfig *nconf;
struct nd_hostservlist *nd_hostserv;
struct netbuf nbuf;
char uaddr[16];
/* Initialize the network selection mechanism */
if (handlep = setnetconfig()) == (void *)NULL)
{
exit(1);
}
/* Get the netconfig handle */
if ((nconf = getnetconfig(handlep)) == (struct netconf *)NULL)
{
printf(&quot;Error getting the netconfig handle\n&quot;);
exit(1);
}
memset(uaddr, NULL, 16);
printf(&quot;Enter the host IP address appended by low and high order
port numbers:\n&quot;);
scanf(&quot;%s&quot;, uaddr);
/* Convert universal address notation into transport-specific
* address format.
*/
nbuf = uaddr2taddr(nconf, uaddr);
/* Get the hostname from the address over the transport */
/* provider specified in the netconfig structure */
if (netdir_getbyaddr(nconf, &amp;nd_hostserv, &amp;nbuf)
!= ND_OK)
{
printf(&quot;Cannot determine the host\n&quot;);
exit(1);
}
printf(&quot;The host name is: %s\n&quot;,
nd_hostserv-&gt;h_hostservs-&gt;h_host);
printf(&quot;The Service is: %s\n&quot;, nd_hostserv-&gt;h_hostservs-&gt;h_serv);
/* Free the netdir structure allocated by netdir_getbyname() */
netdir_free(nd_hostserv, ND_HOSTSERVLIST);
/* Release the netconfig handle allocated by set setnetconfig() */
endnetconfig(handlep);
}
</pre>
<br>
<hr>
API introduced: V4R2
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"rpc1.htm">Remote Procedure Call (RPC) APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>