<?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_enumerate</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-enumerate" title="auth_enumerate"/><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_enumerate</title><link rel="stylesheet" type="text/css" href="style.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/><link rel="home" href="#auth-enumerate" title="auth_enumerate"/><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
+Copyright 1998 - 2009 Double Precision, Inc. See COPYING for distribution
information.
---></head><body><div class="refentry"
lang="en" xml:lang="en"><a id="auth-enumerate" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_enumerate — Obtain list of accounts</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="literallayout"><p><br clear="none"/>
+--></head><body><div class="refentry"><a id="auth-enumerate" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_enumerate — Obtain list of accounts</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"><b class="fsfunc">auth_enumerate</b>(</code></td><td rowspan="1" colspan="1">int </td><td rowspan="1" colspan="1"><var class="pdparam">(*callback_func)</var><code>(</code>const char *, uid_t, gid_t, const char *, const char *, const char *, 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="id398950" 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"><strong>auth_enumerate</strong>(</code></td><td rowspan="1" colspan="1">int <var class="pdparam">(*callback_func)</var>
+ <code>(</code>const char *, uid_t, gid_t, const char *, const char *, const char *, 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="idm247870751728" shape="rect"> </a><h2>DESCRIPTION</h2><p>
<code class="function">auth_enumerate</code> enumerates all of the available accounts.
<code class="function">auth_enumerate</code> repeatedly calls
<code class="function">callback_func</code>, once for each account.
-<code class="function">callback_func</code> receives the following arguments:</p><div class="itemizedlist"><ul
type="disc"><li><p>
-Account name.</p></li><li><p>
-Account's numeric userid.</p></li><li><p>
-Account's numeric groupid.</p></li><li><p>
-Account's home directory.</p></li><li><p>
+<code class="function">callback_func</code> receives the following arguments:</p><div class="itemizedlist"><ul
class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
+Account name.</p></li><li
class="listitem"><p>
+Account's numeric userid.</p></li><li
class="listitem"><p>
+Account's numeric groupid.</p></li><li
class="listitem"><p>
+Account's home directory.</p></li><li
class="listitem"><p>
Account's mailbox (if defined, may be <code class="literal">NULL</code>, which
-indicates the default mailbox location).</p></li><li><p>
-Account's options string (if defined, may be <code class="literal">NULL</code>)</p></li><li><p>
+indicates the default mailbox location).</p></li><li
class="listitem"><p>
+Account's options string (if defined, may be <code class="literal">NULL</code>)</p></li><li
class="listitem"><p>
<em class="parameter"><code>callback_arg</code></em>, verbatim.</p></li></ul></div><p>
After invoking <code class="function">callback_func</code> for the last account,
<code class="function">auth_enumerate</code> invokes <code class="function">callback_func</code>
received.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Some back-end Courier authentication modules do not implement account
enumeration, so this function may not be available in all
-configurations.</p></div></div><div class="refsect1"
lang="en" xml:lang="en"><a id="id374607" shape="rect"> </a><h2>SEE ALSO</h2><p>
+configurations.</p></div></div><div class="refsect1"
><a id="idm247867946192" 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>,
HCoop / hcoop / debian / courier-authlib.git / blobdiff