1 .\" <!-- $Id: auth_enumerate.sgml,v 1.5 2007/07/21 20:05:53 mrsam Exp $ -->
2 .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: auth_enumerate
6 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
11 .TH "AUTH_ENUMERATE" "3" "08/23/2008" "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:
39 \h'-04'\(bu\h'+03'Account name\.
43 \h'-04'\(bu\h'+03'Account\'s numeric userid\.
47 \h'-04'\(bu\h'+03'Account\'s numeric groupid\.
51 \h'-04'\(bu\h'+03'Account\'s home directory\.
55 \h'-04'\(bu\h'+03'Account\'s mailbox (if defined, may be
56 NULL, which indicates the default mailbox location)\.
60 \h'-04'\(bu\h'+03'Account\'s options string (if defined, may be
66 \fIcallback_arg\fR, verbatim\.
75 one more time with all parameters set to
81 encounters an error it will terminate without calling
85 or 0 parameters\. This can be used to determine whether a partial list of accounts was received\.
88 .nr an-no-space-flag 1
93 Some back\-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations\.
97 \fI\fBauthlib\fR(3)\fR\&[1],
98 \fI\fBauth_generic\fR(3)\fR\&[2],
99 \fI\fBauth_login\fR(3)\fR\&[3],
100 \fI\fBauth_getuserinfo\fR(3)\fR\&[4],
101 \fI\fBauth_passwd\fR(3)\fR\&[5]\.
109 \fBauth_generic\fR(3)
119 \fBauth_getuserinfo\fR(3)
121 \%auth_getuserinfo.html