X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/8d138742ae268344f406cb75d79aa6bf853f9d87..5459351437f2b7b2a08457e5397f8a8381986ffe:/auth_enumerate.html diff --git a/auth_enumerate.html b/auth_enumerate.html index ee28dbb..4a354c2 100644 --- a/auth_enumerate.html +++ b/auth_enumerate.html @@ -1,23 +1,24 @@ -auth_enumerate

Name

auth_enumerate — Obtain list of accounts

Synopsis


+-->

Name

auth_enumerate — Obtain list of accounts

Synopsis


#include <courierauth.h>
-

auth_enumerate(int  (*callback_func)(const char *, uid_t, gid_t, const char *, const char *, const char *, void *),
 void * callback_arg);

DESCRIPTION

+

auth_enumerate(int (*callback_func) + (const char *, uid_t, gid_t, const char *, const char *, const char *, void *),
 void *callback_arg);
 

DESCRIPTION

auth_enumerate enumerates all of the available accounts. auth_enumerate repeatedly calls callback_func, once for each account. -callback_func receives the following arguments:

  • -Account name.

  • -Account's numeric userid.

  • -Account's numeric groupid.

  • -Account's home directory.

  • +callback_func receives the following arguments:

    • +Account name.

    • +Account's numeric userid.

    • +Account's numeric groupid.

    • +Account's home directory.

    • Account's mailbox (if defined, may be NULL, which -indicates the default mailbox location).

    • -Account's options string (if defined, may be NULL)

    • +indicates the default mailbox location).

    • +Account's options string (if defined, may be NULL)

    • callback_arg, verbatim.

    After invoking callback_func for the last account, auth_enumerate invokes callback_func @@ -29,7 +30,7 @@ This can be used to determine whether a partial list of accounts was received.

    Note

    Some back-end Courier authentication modules do not implement account enumeration, so this function may not be available in all -configurations.

SEE ALSO

+configurations.