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

128 lines
3.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>gai_strerror--Retrieve Address Information Runtime Error Message
API</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: -->
<!-- Created for V5R2 by Chris Gloe -->
<!-- Edited by Kersten Feb 02 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- End Header Records -->
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>gai_strerror()--Retrieve
Address Information Runtime Error Message</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;sys/socket.h&gt;
#include &lt;netdb.h&gt;
char *gai_strerror(int ecode);
</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 <strong><em>gai_strerror()</em></strong> function retrieves a text
string that describes a return value received from calling the <a href=
"getaddrinfo.htm">getaddrinfo()</a> or <a href=
"getnameinfo.htm">getnameinfo()</a> API.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>ecode</strong></dt>
<dd>(Input) The return value received from <a href=
"getaddrinfo.htm">getaddrinfo()</a> or <a href=
"getnameinfo.htm">getnameinfo()</a>.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>No authorization is required.</p>
<br>
<h3>Return Value</h3>
<p><strong>gai_strerror()</strong> returns a pointer to the return value
text.</p>
<br>
<h3>Usage Notes</h3>
<ol>
<li><strong>gai_strerror()</strong> returns a pointer to the string. The
null-terminated string is stored in the CCSID of the job. If the job is 65535
and the string is something other than EBCDIC single byte or EBCDIC mixed, the
text is converted to the default job CCSID.<br><br></li>
<li>If an <em>ecode</em> is specified for which there is no corresponding
description, an Unknown Error string is returned.<br><br></li>
<li>The null-terminated string addressed by the pointer returned is overlayed
by subsequent invocations of the <strong>gai_strerror()</strong> API from
within the same thread.</li>
</ol>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="getaddrinfo.htm">getaddrinfo()</a>--Get Address Information<br>
<br>
</li>
<li><a href="getnameinfo.htm">getnameinfo()</a>--Get Name Information for Socket
Address<br>
<br>
</li>
</ul>
<br>
<br>
<hr>
API introduced: V5R2
<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>