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

200 lines
5.8 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>getprotobyname_r()--Get Protocol Information for Protocol Name</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>getprotobyname_r()--Get Protocol Information for Protocol Name</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;netdb.h&gt;
int getprotobyname_r(char *<em>protocol_name</em>,
struct protoent
*<em>protoent_struct_addr</em>,
struct protoent_data
*<em>protoent_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>getprotobyname_r()</em> function is used to retrieve information
about a protocol. The information is retrieved from the protocol database
file.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt>char *<strong>protocol_name</strong> &nbsp;(input)&nbsp;</dt>
<dd>Specifies the pointer to the character string that contains the name of the
protocol for which information is to be retrieved.<br>
<br>
</dd>
<dt>struct protoent *<strong>protoent_struct_addr</strong>
&nbsp;(input/output)&nbsp;</dt>
<dd>Specifies the pointer to a protoent structure where the results will be
placed. All results must be referenced through this structure.<br>
<br>
</dd>
<dt>struct protoent_data *<strong>protoent_data_struct_addr</strong>
&nbsp;(input/output)&nbsp;</dt>
<dd>Specifies the pointer to the protoent_data structure, which is used to pass
and preserve results between function calls. The field proto_control_blk in the
protoent_data structure must be initialized with hexadecimal zeros before its
initial use. If compatibility with other platforms is required, then the entire
protoent_data structure must be initialized with 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>getprotobyname_r()</em> returns an integer. Possible values are:</p>
<ul>
<li>-1 (unsuccessful call)</li>
<li>0 (successful call)</li>
</ul>
<p>The <strong>struct protoent</strong> denoted by
<strong><em>protoent_struct_addr</em></strong> and <strong>struct
protoent_data</strong> denoted by
<strong><em>protoent_data_struct_addr</em></strong> are both defined in
<strong>&lt;netdb.h&gt;</strong>. The structure <strong>struct
protoent</strong>is defined as:</p>
<pre>
struct protoent [
char *p_name;
char **p_aliases;
int p_proto;
];
</pre>
<p><em>p_name</em> points to the character string that contains the name of the
protocol. <em>p_aliases</em> is a pointer to a NULL-terminated list of
pointers, each of which points to a character string that represents an
alternative name for the protocol. <em>p_proto</em> is the protocol number.</p>
<br>
<h3>Error Conditions</h3>
<p>When the <em>getprotobyname_r()</em> function fails, <em>errno</em> can be
set to:</p>
<dl>
<dt><em>[EINVAL]</em></dt>
<dd><p>The protoent_data structure was not properly initialized with hexadecimal zeros before
initial use. For corrective action, see the description for structure protoent_data.</p></dd>
</dl>
<br>
<h3>Usage Notes</h3>
<ol>
<li>The iSeries Navigator or the following CL commands can be
used to access the protocol database file:<br>
<br>
<ul>
<li>WRKPCLTBLE (Work with Protocol Table Entries)</li>
<li>ADDPCLTBLE (Add Protocol Table Entry)</li>
<li>RMVPCLTBLE (Remove Protocol Table Entry)</li>
</ul>
<br>
</li>
<li>When the protocol information is obtained from the protocol database file,
the file is opened and the protocol information is retrieved (if it exists)
from the file. The file is then closed only if a <em>setprotoent_r()</em> call
with a non-zero 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 protocol
name specified by the <em>protocol_name</em> parameter, and for the protocol
names returned in the protoent structure, the job CCSID must be something other
than 65535.</li>
</ol>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="tsgprotd.htm">getprotobynumber_r(</a>)--Get Protocol<br>
<br>
</li>
<li><a href="tsgprote.htm">getprotoent_r()</a>--Get Next Entry from Protocol
Database<br>
<br>
</li>
<li><a href="tssprote.htm">setprotoent_r()</a>--Open Protocol Database<br>
<br>
</li>
<li><a href="tseprote.htm">endprotoent_r()</a>--Close Protocol 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>