1 .\" <!-- $Id: auth_enumerate.sgml,v 1.4 2007/04/01 00:21:34 mrsam Exp $ -->
2 .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: auth_enumerate
6 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
11 .TH "AUTH_ENUMERATE" "3" "04/06/2007" "Double Precision, Inc." "Double Precision, Inc."
12 .\" disable hyphenation
14 .\" disable justification (adjust text to left margin only)
17 auth_enumerate \- Obtain list of accounts
22 #include <courierauth.h>
26 .BI "auth_enumerate(int\ (*" "callback_func" ")(const\ char\ *,\ uid_t,\ gid_t,\ const\ char\ *,\ const\ char\ *,\ const\ char\ *,\ void\ *), void\ *" "callback_arg" ");"
31 enumerates all of the available accounts.
34 \fBcallback_func\fR, once for each account.
36 receives the following arguments:
38 \h'-04'\(bu\h'+03'Account name.
41 \h'-04'\(bu\h'+03'Account's numeric userid.
44 \h'-04'\(bu\h'+03'Account's numeric groupid.
47 \h'-04'\(bu\h'+03'Account's home directory.
50 \h'-04'\(bu\h'+03'Account's mailbox (if defined, may be
51 NULL, which indicates the default mailbox location).
54 \h'-04'\(bu\h'+03'Account's options string (if defined, may be
59 \fIcallback_arg\fR, verbatim.
68 one more time with all parameters set to
74 encounters an error it will terminate without calling
78 or 0 parameters. This can be used to determine whether a partial list of accounts was received.
81 .nr an-no-space-flag 1
86 Some back\-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations.
90 \fI\fBauthlib\fR(3)\fR\&[1],
91 \fI\fBauth_generic\fR(3)\fR\&[2],
92 \fI\fBauth_login\fR(3)\fR\&[3],
93 \fI\fBauth_getuserinfo\fR(3)\fR\&[4],
94 \fI\fBauth_passwd\fR(3)\fR\&[5].
102 \fBauth_generic\fR(3)
112 \fBauth_getuserinfo\fR(3)
114 \%auth_getuserinfo.html