<?xml version="1.0"?>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>auth_getuserinfo</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"/><link rel="start" href="#auth-getuserinfo" title="auth_getuserinfo"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>auth_getuserinfo</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"/><link rel="start" href="#auth-getuserinfo" title="auth_getuserinfo"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--
Copyright 1998 - 2007 Double Precision, Inc. See COPYING for distribution
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 <courierauth.h><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><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>
+--></head><body><div class="refentry" lang="en" xml:lang="en"><a id="auth-getuserinfo"> </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/>
+#include <courierauth.h><br/>
+</p></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td
><code class="funcdef">int rc=<b class="fsfunc">auth_getuserinfo</b>(</code></td><td>const char * </td><td><var class="pdparam">userid</var>, </td></tr><tr><td> </td><td>int </td><td><var class="pdparam">(*callback_func)</var><code>(</code>struct authinfo *, void *<code>)</code>, </td></tr><tr><td> </td><td>void * </td><td><var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id500248"> </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="id
282341" 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="id
514042"> </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
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="id282589" 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="id478809"> </a><p class="title"><b>Example 1. struct authinfo</b></p><div class="example-contents"><pre class="programlisting">
struct authinfo {
const char *sysusername;
const uid_t *sysuserid;
const char *options;
} ;
-</pre></div></div><br class="example-break"
clear="none"/></blockquote></div><p>
+</pre></div></div><br class="example-break"/></blockquote></div><p>
Description of the above fields:</p><div class="variablelist"><dl><dt><span class="term">address</span></dt><dd><p>
The authenticated login ID.</p></dd><dt><span class="term">sysusername</span></dt><dd><p>
The authenticated account's userid and groupid can be looked up in the
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="id
325640" 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="id
523609"> </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
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="id
326137" 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>,
+characters.</p></dd></dl></div></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id
524061"> </a><h2>SEE ALSO</h2><p>
+<a class="ulink" href="authlib.html" target="_top"><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>,
+<a class="ulink" href="auth_generic.html" target="_top"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,
-<a href="auth_login.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_login</span>(3)</span></a>,
+<a class="ulink" href="auth_login.html" target="_top"><span class="citerefentry"><span class="refentrytitle">auth_login</span>(3)</span></a>,
-<a href="auth_enumerate.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_enumerate</span>(3)</span></a>,
+<a class="ulink" href="auth_enumerate.html" target="_top"><span class="citerefentry"><span class="refentrytitle">auth_enumerate</span>(3)</span></a>,
-<a href="auth_passwd.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_passwd</span>(3)</span></a>,
+<a class="ulink" href="auth_passwd.html" target="_top"><span class="citerefentry"><span class="refentrytitle">auth_passwd</span>(3)</span></a>,
-<a href="auth_getoption.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_getoption</span>(3)</span></a>.</p></div></div></body></html>
+<a class="ulink" href="auth_getoption.html" target="_top"><span class="citerefentry"><span class="refentrytitle">auth_getoption</span>(3)</span></a>.</p></div></div></body></html>
HCoop / hcoop / debian / courier-authlib.git / blobdiff