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

176 lines
4.5 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_rc_destroy()--Delete Replay Cache</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 -->
<!-- Created by Kent Hofer for V5R1 -->
<!-- Edited by Kersten Jan 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>krb5_rc_destroy()--Delete Replay Cache</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;krb5.h&gt;
krb5_error_code krb5_rc_destroy(
krb5_context <em>context</em>,
krb5_rcache <em>rcache</em>);
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QKRBGSS&nbsp;&nbsp;<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>krb5_rc_destroy()</strong> function closes and deletes a replay
cache. The cache handle may not be used once this routine completes.</p>
<br>
<h3>Authorities</h3>
<p>When the replay cache is of type "dfl" (see
<strong>krb5_rc_resolve()</strong> for more information on replay cache types),
the default behavior is that the replay cache file is created in the
/QIBM/UserData/OS400/NetworkAuthentication/replay directory. The placement of
the replay cache file can be changed by setting the KRB5RCACHEDIR or
KRB5RCACHENAME environment variable, or by specifying a different path with the
<strong>krb5_rc_resolve()</strong> function.</p>
<p>If the default directory is not used, the following authorities are
required:</p>
<table border cellpadding="5">
<tr>
<th align="left" valign="bottom">Object Referred to</th>
<th align="left" valign="bottom">Data Authority Required</th>
<th align="left" valign="bottom">Object Authority Required</th>
</tr>
<tr>
<td align="left" valign="top">Each directory in the path name preceding the
replay cache file</td>
<td align="center" valign="top">*X</td>
<td align="center" valign="top">None</td>
</tr>
<tr>
<td align="left" valign="top">Parent directory of the replay cache file</td>
<td align="center" valign="top">*WX</td>
<td align="center" valign="top">None</td>
</tr>
<tr>
<td align="left" valign="top">Replay cache file</td>
<td align="center" valign="top">*RW</td>
<td align="center" valign="top">*OBJEXIST</td>
</tr>
</table>
<p>If the default directory is used, the following authorities are
required:</p>
<table border cellpadding="5">
<!-- width="80" -->
<!-- cols="30 70" -->
<tr>
<th align="left" valign="bottom">Object Referred to</th>
<th align="center" valign="bottom">Data Authority Required</th>
</tr>
<tr>
<td align="left" valign="top">Each directory in the path name preceding the
replay cache file</td>
<td align="center" valign="top">*X</td>
</tr>
<tr>
<td align="left" valign="top">Replay cache file</td>
<td align="center" valign="top">*RW</td>
</tr>
</table>
<br>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>context</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The Kerberos context.<br>
<br>
</dd>
<dt><strong>rcache</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The replay cache handle.</dd>
</dl>
<br>
<h3>Return Value</h3>
<p>If no errors occur, the return value is 0. Otherwise, a Kerberos error code
is returned.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<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>
</body>
</html>