X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/dd184caf1b0d37f50ea0ddcc68822bd38da32105..4c84ffe42fc2303e8675ff7fffd063e5fe687828:/auth_getoption.html diff --git a/auth_getoption.html b/auth_getoption.html dissimilarity index 66% index 3006ee2..48faf37 100644 --- a/auth_getoption.html +++ b/auth_getoption.html @@ -1,48 +1,48 @@ - -auth_getoption

Name

auth_getoption — Search an option string

Synopsis


-#include <courierauth.h>
-

char *value=auth_getoption(const char * options,
 const char * keyword);

DESCRIPTION

-This is a convenience function for parsing account options, as received -by the callback function invoked by -auth_generic(3), -auth_login(3), -auth_getuserinfo(3), -and -auth_passwd(3).

-options is the -options field from -authinfo (which can be NULL). -As described in -auth_generic(3) -(and the others), it is a comma-separated list of -“keyword=value” -pairs.

-auth_getoption searches -options for a -keyword.

RETURNS

-If -options does not have the -keyword, -auth_getoption returns NULL with -errno set to ENOENT. -Otherwise -auth_getoption allocates a buffer for -value, and returns it. -It is the caller's responsibility to -free(3) -the returned buffer.

-auth_getoption returns NULL with -errno set to ENOMEM if it cannot -allocate a buffer.

+ +auth_getoption

Name

auth_getoption — Search an option string

Synopsis


+#include <courierauth.h>
+

char *value=auth_getoption(const char *options,
 const char *keyword);
 

DESCRIPTION

+This is a convenience function for parsing account options, as received +by the callback function invoked by +auth_generic(3), +auth_login(3), +auth_getuserinfo(3), +and +auth_passwd(3).

+options is the +options field from +authinfo (which can be NULL). +As described in +auth_generic(3) +(and the others), it is a comma-separated list of +“keyword=value” +pairs.

+auth_getoption searches +options for a +keyword.

RETURNS

+If +options does not have the +keyword, +auth_getoption returns NULL with +errno set to ENOENT. +Otherwise +auth_getoption allocates a buffer for +value, and returns it. +It is the caller's responsibility to +free(3) +the returned buffer.

+auth_getoption returns NULL with +errno set to ENOMEM if it cannot +allocate a buffer.