????
Current Path : /proc/thread-self/root/opt/alt/cyrus-sasl/share/man/man3/ |
Current File : //proc/thread-self/root/opt/alt/cyrus-sasl/share/man/man3/sasl_client_init.3 |
.\" Man page generated from reStructuredText. . .TH "SASL_CLIENT_INIT" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_client_init \- 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_client_init(const sasl_callback_t *callbacks ) .fi .SH DESCRIPTION .sp \fBsasl_client_init\fP initializes SASL. .sp It must be called before any calls to sasl_client_start(3)\&. This call initializes all SASL client drivers (e.g. authentication mechanisms). These are usually found in the \fI/usr/lib/sasl2\fP directory but the directory may be overridden with the \fISASL_PATH\fP environment variable. .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .sp The following return codes indicate errors and should either be handled or the authentication session should be quit: .INDENT 0.0 .IP \(bu 2 \fBSASL_BADVERS\fP: Mechanism version mismatch .IP \(bu 2 \fBSASL_BADPARAM\fP: Error in config file .IP \(bu 2 \fBSASL_NOMEM\fP: Not enough memory to complete operation .UNINDENT .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_client_new(3), sasl_client_start(3), sasl_client_step(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .