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

179 lines
4.7 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>endhostent_r()--Close Host Database</title>
<!-- 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. -->
<!-- Begin Header Records ========================================== -->
<!-- Unix8 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!--End Header Records -->
<!-- Edited by Kersten Feb 02 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>endhostent_r()--Close Host Database</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;netdb.h&gt;
void endhostent_r(struct hostent_data
*<em>hostent_data_struct_addr</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: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <em>endhostent_r()</em> function is used to close the host database
file. The file is opened by those functions that retrieve information about a
host (for example, <em>gethostent_r()</em>).</p>
<h3>Parameters</h3>
<dl>
<dt>struct hostent_data *<strong>hostent_data_struct_addr</strong>
&nbsp;(input)&nbsp;</dt>
<dd>Specifies the pointer to the hostent_data structure, which is used to pass
and preserve results between function calls. The field host_control_blk in the
hostent_data structure must be initialized with hexadecimal zeros before its
initial use. If compatibility with other platforms is required, then the entire
hostent_data structure must be initialized to hexadecimal zeros before initial
use.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>No authorization is required.</p>
<br>
<h3>Return Value</h3>
<p>The <em>endhostent_r()</em> function returns an integer. Possible values
are:</p>
<ul>
<li>-1 (unsuccessful call)</li>
<li>0 (successful call)</li>
</ul>
<p>The <strong>struct hostent_data</strong>denoted by
<strong><em>hostent_data_struct_addr</em></strong> is defined in
<strong>&lt;netdb.h&gt;</strong>.</p>
<br>
<h3>Error Conditions</h3>
<p>When the <em>endhostent_r()</em> function fails, <em>errno</em> can be set
to:</p>
<dl>
<dt><em><samp>[EINVAL]</samp></em></dt>
<dd><p>The hostent_data structure was not properly
initialized to hexadecimal zeros before initial use. For corrective action, see
the description for structure hostent_data.</p></dd>
</dl>
<h3>Usage Notes</h3>
<ol>
<li>When the _XOPEN_SOURCE
macro defined to the value 520 or greater, the host file is always closed. When
the _XOPEN_SOURCE macro is not so defined, the host file will not be closed if a
<em>sethostent_r()</em> call with a nonzero parameter value was previously done.<br>
<br>
</li>
<li>The iSeries Navigator or the following CL commands can be
used to access the host database file:<br>
<br>
<ul>
<li>ADDTCPHTE (Add TCP/IP Host Table Entry)</li>
<li>RMVTCPHTE (Remove TCP/IP Host Table Entry)</li>
<li>CHGTCPHTE (Change TCP/IP Host Table Entry)</li>
<li>RNMTCPHTE (Rename TCP/IP Host Table Entry)</li>
<li>MRGTCPHT (Merge TCP/IP Host Tables)</li>
</ul>
<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>endhostent_r()</em>
API is mapped to <em>qso_endhostent_r98()</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="tsghosta.htm">gethostbyaddr_r()</a>--Get Host Information for IP
Address<br>
<br>
</li>
<li><a href="tsghostb.htm">gethostbyname_r()</a>--Get Host Information for Host
Name<br>
<br>
</li>
<li><a href="tsghoste.htm">gethostent_r()</a>--Get Next Entry from Host
Database<br>
<br>
</li>
<li><a href="tsshoste.htm">sethostent_r()</a>--Open Host Database</li>
</ul>
<br>
<hr>
API introduced: V4R2
<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>