Commit | Line | Data |
---|---|---|
dd184caf | 1 | .\" <!-- $Id: auth_enumerate.sgml,v 1.5 2007/07/21 20:05:53 mrsam Exp $ --> |
d9898ee8 | 2 | .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for --> |
3 | .\" <!-- distribution information. --> | |
4 | .\" Title: auth_enumerate | |
5 | .\" Author: | |
8d138742 CE |
6 | .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> |
7 | .\" Date: 08/23/2008 | |
d9898ee8 | 8 | .\" Manual: Double Precision, Inc. |
9 | .\" Source: Double Precision, Inc. | |
10 | .\" | |
8d138742 | 11 | .TH "AUTH_ENUMERATE" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc." |
d9898ee8 | 12 | .\" disable hyphenation |
13 | .nh | |
14 | .\" disable justification (adjust text to left margin only) | |
15 | .ad l | |
16 | .SH "NAME" | |
8d138742 | 17 | auth_enumerate - Obtain list of accounts |
d9898ee8 | 18 | .SH "SYNOPSIS" |
19 | .sp | |
20 | .RS 4 | |
21 | .nf | |
8d138742 | 22 | #include <courierauth\.h> |
d9898ee8 | 23 | .fi |
24 | .RE | |
25 | .HP 15 | |
dd184caf | 26 | .BI "auth_enumerate(int\ " "(*callback_func)" "\ (const\ char\ *,\ uid_t,\ gid_t,\ const\ char\ *,\ const\ char\ *,\ const\ char\ *,\ void\ *), void\ *" "callback_arg" ");" |
d9898ee8 | 27 | .SH "DESCRIPTION" |
28 | .PP | |
29 | ||
30 | \fBauth_enumerate\fR | |
8d138742 | 31 | enumerates all of the available accounts\. |
d9898ee8 | 32 | \fBauth_enumerate\fR |
33 | repeatedly calls | |
8d138742 | 34 | \fBcallback_func\fR, once for each account\. |
d9898ee8 | 35 | \fBcallback_func\fR |
36 | receives the following arguments: | |
8d138742 | 37 | .sp |
d9898ee8 | 38 | .RS 4 |
8d138742 | 39 | \h'-04'\(bu\h'+03'Account name\. |
d9898ee8 | 40 | .RE |
8d138742 | 41 | .sp |
d9898ee8 | 42 | .RS 4 |
8d138742 | 43 | \h'-04'\(bu\h'+03'Account\'s numeric userid\. |
d9898ee8 | 44 | .RE |
8d138742 | 45 | .sp |
d9898ee8 | 46 | .RS 4 |
8d138742 | 47 | \h'-04'\(bu\h'+03'Account\'s numeric groupid\. |
d9898ee8 | 48 | .RE |
8d138742 | 49 | .sp |
d9898ee8 | 50 | .RS 4 |
8d138742 | 51 | \h'-04'\(bu\h'+03'Account\'s home directory\. |
d9898ee8 | 52 | .RE |
8d138742 | 53 | .sp |
d9898ee8 | 54 | .RS 4 |
8d138742 CE |
55 | \h'-04'\(bu\h'+03'Account\'s mailbox (if defined, may be |
56 | NULL, which indicates the default mailbox location)\. | |
d9898ee8 | 57 | .RE |
8d138742 | 58 | .sp |
d9898ee8 | 59 | .RS 4 |
8d138742 | 60 | \h'-04'\(bu\h'+03'Account\'s options string (if defined, may be |
d9898ee8 | 61 | NULL) |
62 | .RE | |
8d138742 | 63 | .sp |
d9898ee8 | 64 | .RS 4 |
65 | \h'-04'\(bu\h'+03' | |
8d138742 | 66 | \fIcallback_arg\fR, verbatim\. |
d9898ee8 | 67 | .RE |
68 | .PP | |
69 | After invoking | |
70 | \fBcallback_func\fR | |
71 | for the last account, | |
72 | \fBauth_enumerate\fR | |
73 | invokes | |
74 | \fBcallback_func\fR | |
75 | one more time with all parameters set to | |
76 | NULL | |
8d138742 | 77 | or 0\. |
d9898ee8 | 78 | .PP |
79 | If | |
80 | \fBauth_enumerate\fR | |
81 | encounters an error it will terminate without calling | |
82 | \fBcallback_func\fR | |
83 | with all | |
84 | NULL | |
8d138742 | 85 | or 0 parameters\. This can be used to determine whether a partial list of accounts was received\. |
d9898ee8 | 86 | .sp |
87 | .it 1 an-trap | |
88 | .nr an-no-space-flag 1 | |
89 | .nr an-break-flag 1 | |
90 | .br | |
8d138742 | 91 | Note |
d9898ee8 | 92 | .PP |
8d138742 | 93 | Some back\-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations\. |
d9898ee8 | 94 | .SH "SEE ALSO" |
95 | .PP | |
96 | ||
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], | |
8d138742 CE |
101 | \fI\fBauth_passwd\fR(3)\fR\&[5]\. |
102 | .SH "NOTES" | |
d9898ee8 | 103 | .IP " 1." 4 |
104 | \fBauthlib\fR(3) | |
105 | .RS 4 | |
106 | \%authlib.html | |
107 | .RE | |
108 | .IP " 2." 4 | |
109 | \fBauth_generic\fR(3) | |
110 | .RS 4 | |
111 | \%auth_generic.html | |
112 | .RE | |
113 | .IP " 3." 4 | |
114 | \fBauth_login\fR(3) | |
115 | .RS 4 | |
116 | \%auth_login.html | |
117 | .RE | |
118 | .IP " 4." 4 | |
119 | \fBauth_getuserinfo\fR(3) | |
120 | .RS 4 | |
121 | \%auth_getuserinfo.html | |
122 | .RE | |
123 | .IP " 5." 4 | |
124 | \fBauth_passwd\fR(3) | |
125 | .RS 4 | |
126 | \%auth_passwd.html | |
127 | .RE |