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

142 lines
3.3 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>krb5_address_search()--Search a List of Addresses</title>
<!-- Begin Header Records --><!-- Created by Kent Hofer for V5R1 -->
<!-- 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 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- End Header Records --><!-- Edited by Kersten Jan 02 -->
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>krb5_address_search()--Search a List of Addresses</h2>
<div class="box" style="width: 60%;">
<br>
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;krb5.h&gt;
krb5_boolean krb5_address_search(
krb5_context <em>context</em>,
krb5_const krb5_address * <em>addr</em>,
krb5_address * krb5_const * <em>addrlist</em>);
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QKRBGSS<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>krb5_address_search()</strong> function allows an application to
search a list of addresses for a specific address.</p>
<br>
<h3>Authorities</h3>
<p>No authorities are required.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>context</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The Kerberos context.<br>
<br>
</dd>
<dt><strong>addr</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The search address.<br>
<br>
</dd>
<dt><strong>addrlist</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The address list as an array of addresses. The last entry in the array must
be a <strong>NULL</strong> pointer. Specify <strong>NULL</strong> for this
parameter if no address list is present.</dd>
</dl>
<br>
<h3>Return Value</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><strong>TRUE</strong></td>
<td valign="top">The search address was found in the address list, or the
address list was not provided.</td>
</tr>
<tr>
<td valign="top"><strong>FALSE</strong></td>
<td valign="top">The search address was not found in the address list.</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<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">CPE3418 E</td>
<td width="85%" valign="top">Possible APAR condition or hardware failure.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a><br>
<a href="unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
<br>
<br>
</body>
</html>