Da

✏️ Editing: sasl_listmech.3

.\" Man page generated from reStructuredText.
.
.TH "SASL_LISTMECH" "3" "November 08, 2018" "2.1.27" "Cyrus SASL"
.SH NAME
sasl_listmech \- 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_listmech(sasl_conn_t *conn,
                 const char *user,
                 const char *prefix,
                 const char *sep,
                 const char *suffix,
                 const char **result,
                 unsigned *plen,
                 int *pcount);
.fi
.SH DESCRIPTION
.INDENT 0.0
.TP
.B int sasl_listmech(sasl_conn_t *conn,
.TP
.B const char *user,
.TP
.B const char *prefix,
.TP
.B const char *sep,
.TP
.B const char *suffix,
.TP
.B const char **result,
.TP
.B unsigned *plen,
.TP
.B int *pcount);
\fBsasl_listmech\fP returns a string listing the SASL names of
all the mechanisms available to the specified user. This
is typically given to the client through a capability command
or initial server response. Client applications need
this list so that they know what mechanisms the server
supports.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconn\fP – the SASL context for this connection
.IP \(bu 2
\fBuser\fP – (optional) restricts the mechanism list to only those
available to the user.
.IP \(bu 2
\fBprefix\fP – appended to beginning of result
.IP \(bu 2
\fBsep\fP – appended between mechanisms
.IP \(bu 2
\fBsuffix\fP – appended to end of result
.IP \(bu 2
\fBresult\fP – NULL terminated result string (allocated/freed by
library)
.IP \(bu 2
\fBplen\fP – length of result filled in by library. May be NULL
.IP \(bu 2
\fBpcount\fP – Number of mechanisms available (filled in by library).
May be NULL
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXAMPLE
.sp
.nf
sasl_listmech(conn,NULL,"(",",",")",&mechlist,NULL,NULL);
.fi
.sp
may give the following string as a result:
.INDENT 0.0
.INDENT 3.5
\fI(ANONYMOUS,KERBEROS_V4,DIGEST‐MD5)\fP
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
SASL 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_server_new(3),
sasl_errors(3), sasl_client_new(3)
.SH AUTHOR
The Cyrus Team
.SH COPYRIGHT
1993-2016, The Cyrus Team
.\" Generated by docutils manpage writer.
.

📁 Sid Gifari File Manager