aboutsummaryrefslogtreecommitdiff
path: root/doc/doxyout/krb5/html/structkrb5plugin__an2ln__ftable__desc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/doxyout/krb5/html/structkrb5plugin__an2ln__ftable__desc.html')
-rw-r--r--doc/doxyout/krb5/html/structkrb5plugin__an2ln__ftable__desc.html61
1 files changed, 61 insertions, 0 deletions
diff --git a/doc/doxyout/krb5/html/structkrb5plugin__an2ln__ftable__desc.html b/doc/doxyout/krb5/html/structkrb5plugin__an2ln__ftable__desc.html
new file mode 100644
index 000000000000..4c3d3c2f1ec8
--- /dev/null
+++ b/doc/doxyout/krb5/html/structkrb5plugin__an2ln__ftable__desc.html
@@ -0,0 +1,61 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>krb5plugin_an2ln_ftable_desc Struct Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<p>
+<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
+</p>
+<!-- end of header marker -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',false,false,'search.php','Search');
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">krb5plugin_an2ln_ftable_desc Struct Reference<div class="ingroups"><a class="el" href="group__krb5__support.html">Heimdal Kerberos 5 support functions</a></div></div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Description of the krb5_aname_to_lname(3) plugin facility.
+ <a href="structkrb5plugin__an2ln__ftable__desc.html#details">More...</a></p>
+
+<p><code>#include &lt;an2ln_plugin.h&gt;</code></p>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Description of the krb5_aname_to_lname(3) plugin facility. </p>
+<p>The krb5_aname_to_lname(3) function is pluggable. The plugin is named KRB5_PLUGIN_AN2LN ("an2ln"), with a single minor version, KRB5_PLUGIN_AN2LN_VERSION_0 (0).</p>
+<p>The plugin for krb5_aname_to_lname(3) consists of a data symbol referencing a structure of type krb5plugin_an2ln_ftable, with four fields:</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">init</td><td>Plugin initialization function (see krb5-plugin(7))</td></tr>
+ <tr><td class="paramname">minor_version</td><td>The plugin minor version number (0)</td></tr>
+ <tr><td class="paramname">fini</td><td>Plugin finalization function</td></tr>
+ <tr><td class="paramname">an2ln</td><td>Plugin aname_to_lname function</td></tr>
+ </table>
+ </dd>
+</dl>
+<p>The an2ln field is the plugin entry point that performs the traditional aname_to_lname operation however the plugin desires. It is invoked in no particular order relative to other an2ln plugins, but it has a 'rule' argument that indicates which plugin is intended to act on the rule. The plugin an2ln function must return KRB5_PLUGIN_NO_HANDLE if the rule is not applicable to it.</p>
+<p>The plugin an2ln function has the following arguments, in this order:</p>
+<ol type="1">
+<li>plug_ctx, the context value output by the plugin's init function</li>
+<li>context, a krb5_context</li>
+<li>rule, the aname_to_lname rule being evaluated (from krb5.conf(5))</li>
+<li>aname, the krb5_principal to be mapped to an lname</li>
+<li>set_res_f, a function the plugin must call to set its result</li>
+<li>set_res_ctx, the first argument to set_res_f (the second is the result lname string) </li>
+</ol>
+</div><hr/>The documentation for this struct was generated from the following file:<ul>
+<li>/Volumes/gitvol/viktor/heimdal/lib/krb5/an2ln_plugin.h</li>
+</ul>
+</div><!-- contents -->
+<hr size="1"><address style="text-align: right;"><small>
+Generated on Fri Dec 8 2017 03:48:59 for HeimdalKerberos5library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.13</small></address>
+</body>
+</html>