AlkantarClanX12
Current Path : /opt/alt/cyrus-sasl/share/man/man3/ |
Current File : //opt/alt/cyrus-sasl/share/man/man3/sasl_getsimple_t.3 |
.\" Man page generated from reStructuredText. . .TH "SASL_GETSIMPLE_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getsimple_t \- 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_getsimple_t(void *context, int id, const char ** result, unsigned * len); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getsimple_t(void *context, .TP .B int id, .TP .B const char ** result, .TP .B unsigned * len); \fBsasl_getsimple_t\fP is used to retrieve simple things from the application. In practice this is authentication name, authorization name, and realm. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – SASL connection context .IP \(bu 2 \fBid\fP – .sp indicates which value is being requested. Possible values include: .INDENT 2.0 .IP \(bu 2 SASL_CB_USER ‐ Client user identity to login as .IP \(bu 2 SASL_CB_AUTHNAME ‐ Client authentication name .IP \(bu 2 SASL_CB_LANGUAGE ‐ Comma‐separated list of \fI\%RFC 1766\fP languages .IP \(bu 2 SASL_CB_CNONCE ‐ Client‐nonce (for testing mostly) .UNINDENT .IP \(bu 2 \fBresult\fP – value of the item requested .IP \(bu 2 \fBlen\fP – lenth of the result .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .