group__kim__credential__iterator__reference.html [plain text]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Kerberos Identity Management: KIM Credential Iterator Reference Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>KIM Credential Iterator Reference Documentation</h1>
<p>
<h2>Functions</h2>
<ul>
<li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__credential__iterator__reference.html#g5211e3c0c8881cd869eb20c03881304a">kim_credential_iterator_create</a> (<a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> *out_credential_iterator, <a class="el" href="group__kim__types__reference.html#gaecf0d1ae48c995038dd20b21e3781c2">kim_ccache</a> in_ccache)
<dl class="el"><dd class="mdescRight">Get a credential iterator to enumerate credentials in a ccache. <a href="#g5211e3c0c8881cd869eb20c03881304a"></a><br></dl><li><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> <a class="el" href="group__kim__credential__iterator__reference.html#g68e99dbf9a54dff3f47a0852b17efd1f">kim_credential_iterator_next</a> (<a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> in_credential_iterator, <a class="el" href="group__kim__types__reference.html#ge57b4df3376c4a34a119078a7f4a0030">kim_credential</a> *out_credential)
<dl class="el"><dd class="mdescRight">Get the next credential in a ccache. <a href="#g68e99dbf9a54dff3f47a0852b17efd1f"></a><br></dl><li>void <a class="el" href="group__kim__credential__iterator__reference.html#gd6c2fc4ec6698769434ad6ed28828933">kim_credential_iterator_free</a> (<a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> *io_credential_iterator)
<dl class="el"><dd class="mdescRight">Free memory associated with a credential iterator. <a href="#gd6c2fc4ec6698769434ad6ed28828933"></a><br></dl></ul>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g5211e3c0c8881cd869eb20c03881304a"></a><!-- doxytag: member="kim_credential.h::kim_credential_iterator_create" ref="g5211e3c0c8881cd869eb20c03881304a" args="(kim_credential_iterator *out_credential_iterator, kim_ccache in_ccache)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_credential_iterator_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> * </td>
<td class="paramname"> <em>out_credential_iterator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gaecf0d1ae48c995038dd20b21e3781c2">kim_ccache</a> </td>
<td class="paramname"> <em>in_ccache</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a credential iterator to enumerate credentials in a ccache.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>out_credential_iterator</em> </td><td>on exit, a credential iterator object for <em>in_ccache</em>. Must be freed with <a class="el" href="group__kim__credential__iterator__reference.html#gd6c2fc4ec6698769434ad6ed28828933" title="Free memory associated with a credential iterator.">kim_credential_iterator_free()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>in_ccache</em> </td><td>a ccache object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g68e99dbf9a54dff3f47a0852b17efd1f"></a><!-- doxytag: member="kim_credential.h::kim_credential_iterator_next" ref="g68e99dbf9a54dff3f47a0852b17efd1f" args="(kim_credential_iterator in_credential_iterator, kim_credential *out_credential)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__kim__types__reference.html#g40f5fe10ab395bddc34286e0c2ff76eb">kim_error</a> kim_credential_iterator_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> </td>
<td class="paramname"> <em>in_credential_iterator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#ge57b4df3376c4a34a119078a7f4a0030">kim_credential</a> * </td>
<td class="paramname"> <em>out_credential</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next credential in a ccache.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in_credential_iterator</em> </td><td>a credential iterator object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>out_credential</em> </td><td>on exit, the next credential in the ccache iterated by <em>in_credential_iterator</em>. Must be freed with <a class="el" href="group__kim__credential__reference.html#g5609d3883f82eb3938a2d80e06bd0845" title="Free memory associated with a credential object.">kim_credential_free()</a>. If there are no more credentials this argument will be set to NULL. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>On success, <a class="el" href="group__kim__types__reference.html#g8712727bab9e6b02712a8a01285441d1">KIM_NO_ERROR</a>. On failure, an error code representing the failure. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gd6c2fc4ec6698769434ad6ed28828933"></a><!-- doxytag: member="kim_credential.h::kim_credential_iterator_free" ref="gd6c2fc4ec6698769434ad6ed28828933" args="(kim_credential_iterator *io_credential_iterator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kim_credential_iterator_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__kim__types__reference.html#gdd760f1db624009792f1b5100cd6c4e3">kim_credential_iterator</a> * </td>
<td class="paramname"> <em>io_credential_iterator</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Free memory associated with a credential iterator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>io_credential_iterator</em> </td><td>a credential iterator object to be freed. Set to NULL on exit. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 3 17:45:44 2008 for Kerberos Identity Management by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>