Edit File: sasl_auxprop_request.3
.\" Man page generated from reStructuredText. . .TH "SASL_AUXPROP_REQUEST" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_auxprop_request \- Cyrus SASL documentation . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp .nf #include <sasl/sasl.h> int sasl_auxprop_request(sasl_conn_t *conn, const char ** propnames) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_auxprop_request(sasl_conn_t\fI\ *conn\fP, const char **\fI\ propnames\fP) \fBsasl_auxprop_request\fP will request that the SASL library obtain properties from any auxiliary property plugins that might be installed (such as the user’s home directory from an LDAP server for example). Such lookup occurs just after username canonicalization is complete. Therefore, the request should be made before the call to sasl_server_start(3), but after the call to sasl_server_new(3)\&. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – the \fBsasl_conn_t\fP for which the request is being made. .IP \(bu 2 \fBpropnames\fP – a NULL\-terminated array of property names to request. Note that this array must persist until a call to sasl_dispose(3) on the \fBsasl_conn_t\fP\&. .UNINDENT .TP .B Returns Returns \fBSASL_OK\fP on success. See sasl_errors(3) for meanings of other return codes. .UNINDENT .UNINDENT .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_auxprop(3), sasl_auxprop_getctx(3), sasl_server_new(3), sasl_server_start(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .
Back to File Manager