Edit File: sasl_setprop.3
.\" Man page generated from reStructuredText. . .TH "SASL_SETPROP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_setprop \- 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_setprop(sasl_conn_t *conn, int propnum, const void * pvalue) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_setprop(sasl_conn_t *conn, .TP .B int propnum, .TP .B const void * pvalue) \fBsasl_setprop\fP sets the value of a SASL property. For example an application should tell the SASL library about any external negotiated security layer (i.e. TLS). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBpropnum\fP – is the identifier for the property requested .IP \(bu 2 \fBpvalue\fP – .sp contains a pointer to the data. It is the applications job to make sure this type is correct. This is an easy way to crash a program. .INDENT 2.0 .IP \(bu 2 SASL_AUTH_EXTERNAL ‐ external authentication ID (const char *) .IP \(bu 2 SASL_SSF_EXTERNAL ‐ external SSF active ‐‐ (sasl_ssf_t) .IP \(bu 2 SASL_DEFUSERREALM ‐ user realm (const char *) .IP \(bu 2 SASL_SEC_PROPS ‐ \fIsasl_security_properties_t\fP (may be freed after call) .IP \(bu 2 .INDENT 2.0 .TP .B SASL_IPLOCALPORT ‐ string describing the local ip and port in the form ”a.b.c.d;p”, or “e:f:g:h:i:j:k:l;port” .UNINDENT .IP \(bu 2 .INDENT 2.0 .TP .B SASL_IPREMOTEPORT ‐ string describing the remote ip and port in the form ”a.b.c.d;p”, or “e:f:g:h:i:j:k:l;port” .UNINDENT .UNINDENT .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. .sp Other return codes indicate errors and should be handled. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .
Back to File Manager