Imported upstream version 0.60.1
[hcoop/debian/courier-authlib.git] / auth_getuserinfo.html
index 5ac279b..faaa3c4 100644 (file)
@@ -6,10 +6,10 @@ information.
 
 --></head><body><div class="refentry" lang="en" xml:lang="en"><a id="auth-getuserinfo" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_getuserinfo — Obtain account information</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="literallayout"><p><br clear="none"/>
 #include &lt;courierauth.h&gt;<br clear="none"/>
-</p></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<b class="fsfunc">auth_getuserinfo</b>(</code></td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int (* </td><td rowspan="1" colspan="1"><var class="pdparam">callback_func</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">void * </td><td rowspan="1" colspan="1"><var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id282427" shape="rect"> </a><h2>DESCRIPTION</h2><p>
+</p></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<b class="fsfunc">auth_getuserinfo</b>(</code></td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int  </td><td rowspan="1" colspan="1"><var class="pdparam">(*callback_func)</var><code>(</code>struct authinfo *, void *<code>)</code>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">void * </td><td rowspan="1" colspan="1"><var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id282319" shape="rect"> </a><h2>DESCRIPTION</h2><p>
 If <em class="parameter"><code>userid</code></em> is a valid account name,
 retrieve the account particulars and invoke
-<em class="parameter"><code>callback_func</code></em>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id282448" shape="rect"> </a><h2>RETURNS</h2><p>
+<em class="parameter"><code>callback_func</code></em>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id282341" shape="rect"> </a><h2>RETURNS</h2><p>
 <code class="function">callback_func</code> will be invoked if
 <em class="replaceable"><code>userid</code></em> exists,
 and <code class="function">callback_func</code>'s return value becomes
@@ -25,7 +25,7 @@ return value indicates that this request was processed, but it failed
 The second argument to <code class="function">callback_func</code> will be
 <code class="function">callback_arg</code>, which is not interpreted by this
 function in any way.
-The first argument will be a pointer to the following structure:</p><div class="blockquote"><blockquote class="blockquote"><div class="example"><a id="id282831" shape="rect"> </a><p class="title"><b>Example 1. struct authinfo</b></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
+The first argument will be a pointer to the following structure:</p><div class="blockquote"><blockquote class="blockquote"><div class="example"><a id="id282589" shape="rect"> </a><p class="title"><b>Example 1. struct authinfo</b></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
 struct authinfo {
        const char *sysusername;
        const uid_t *sysuserid;
@@ -78,7 +78,7 @@ The account's cleartext password, if available.
 If the account has an encrypted password defined, this field
 can be set to <code class="literal">NULL</code>.</p></dd><dt><span class="term">options</span></dt><dd><p>
 A comma-separated list of miscellaneous account options.
-See below for more information.</p></dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id325704" shape="rect"> </a><h3>Account options</h3><p>
+See below for more information.</p></dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id325640" shape="rect"> </a><h3>Account options</h3><p>
 Depending on the configuration of the Courier authentication library,
 accounts may have individual options associated with them.
 If the authentication library configuration does not implement account
@@ -122,7 +122,7 @@ account could possibly access (and that's on top of whatever else the
 access control lists say). See the virtual shared folder documentation
 for more information.</p><p>
 For technical reasons, group names may not include comma, tab, "/" or "|"
-characters.</p></dd></dl></div></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id326201" shape="rect"> </a><h2>SEE ALSO</h2><p>
+characters.</p></dd></dl></div></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id326137" shape="rect"> </a><h2>SEE ALSO</h2><p>
 <a href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
  
 <a href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,