Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SASL_LISTMECH(3)		   Cyrus SASL			SASL_LISTMECH(3)

NAME
     sasl_listmech - Cyrus SASL documentation

SYNOPSIS
     #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);

DESCRIPTION
     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);
	    sasl_listmech  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 re-
	    sponse. Client applications need this list so that	they  know  what
	    mechanisms the server supports.

	    Parameters

		   * conn a the SASL context for this connection

		   * user  a  (optional)  restricts  the  mechanism list to only
		     those available to the user.

		   * prefix a appended to beginning of result

		   * sep a appended between mechanisms

		   * suffix a appended to end of result

		   * result a NULL terminated result string (allocated/freed  by
		     library)

		   * plen a length of result filled in by library. May be NULL

		   * pcount  a	Number of mechanisms available (filled in by li-
		     brary).  May be NULL

EXAMPLE
     sasl_listmech(conn,NULL,"(",",",")",&mechlist,NULL,NULL);

     may give the following string as a result:
	(ANONYMOUS,KERBEROS_V4,DIGEST^aMD5)

RETURN VALUE
     SASL functions should return SASL return codes.  See sasl.h for a	complete
     list. SASL_OK indicates success.

SEE ALSO
     RFC      4422,:saslman:sasl(3),	 sasl_server_new(3),	 sasl_errors(3),
     sasl_client_new(3)

AUTHOR
     The Cyrus Team

COPYRIGHT
     1993-2016, The Cyrus Team

2.1.28				February 18, 2022		SASL_LISTMECH(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sasl_listmech&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help