Import Upstream version 0.66.4
[hcoop/debian/courier-authlib.git] / auth_getuserinfo.html
index 3505ea2..befb2a0 100644 (file)
@@ -6,10 +6,10 @@ information.
 
 --></head><body><div class="refentry"><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"/>
 
 --></head><body><div class="refentry"><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" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<strong>auth_getuserinfo</strong>(</code></td><td rowspan="1" colspan="1">const char *<var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int <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 *<var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm247888221120" shape="rect"> </a><h2>DESCRIPTION</h2><p>
+</p></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<strong>auth_getuserinfo</strong>(</code></td><td rowspan="1" colspan="1">const char *<var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int <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 *<var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm255228309696" 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
 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"><a id="idm247890066064" shape="rect"> </a><h2>RETURNS</h2><p>
+<em class="parameter"><code>callback_func</code></em>.</p></div><div class="refsect1"><a id="idm255225665504" 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
 <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 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="idm247892386352" shape="rect"> </a><p class="title"><strong>Example 1. struct authinfo</strong></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="idm255229873440" shape="rect"> </a><p class="title"><strong>Example 1. struct authinfo</strong></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
 struct authinfo {
        const char *sysusername;
        const uid_t *sysuserid;
 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.
 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"><a id="idm247886973360" shape="rect"> </a><h3>Account options</h3><p>
+See below for more information.</p></dd></dl></div><div class="refsect2"><a id="idm255224460816" 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
 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
@@ -127,7 +127,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 "|"
 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"><a id="idm247886886992" shape="rect"> </a><h2>SEE ALSO</h2><p>
+characters.</p></dd></dl></div></div></div><div class="refsect1"><a id="idm255224373824" shape="rect"> </a><h2>SEE ALSO</h2><p>
 <a class="ulink" href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
  
 <a class="ulink" href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,
 <a class="ulink" href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
  
 <a class="ulink" href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,