.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gsasl_stringprep_saslprep" 3 "1.10.0" "gsasl" "gsasl"
.SH NAME
gsasl_stringprep_saslprep \- API function
.SH SYNOPSIS
.B #include <gsasl.h>
.sp
.BI "char * gsasl_stringprep_saslprep(const char * " in ", int * " stringprep_rc ");"
.SH ARGUMENTS
.IP "const char * in" 12
input ASCII or UTF\-8 string with data to prepare according to SASLprep.
.IP "int * stringprep_rc" 12
pointer to output variable with stringprep error code,
or NULL to indicate that you don't care about it.
.SH "DESCRIPTION"
Process a Unicode string for comparison, according to the
"SASLprep" stringprep profile.  This function is intended to be
used by Simple Authentication and Security Layer (SASL) mechanisms
(such as PLAIN, CRAM\-MD5, and DIGEST\-MD5) as well as other
protocols exchanging user names and/or passwords.

Return value: Return a newly allocated string that is the
"SASLprep" processed form of the input string, or NULL on error,
in which case  \fIstringprep_rc\fP contain the stringprep library error
code.
.SH "DEPRECATED"
Use \fBgsasl_saslprep()\fP instead.
.SH "REPORTING BUGS"
Report bugs to <bug-gsasl@gnu.org>.
.br
General guidelines for reporting bugs: http://www.gnu.org/gethelp/
.br
GNU SASL home page: http://www.gnu.org/software/gsasl/

.SH COPYRIGHT
Copyright \(co 2002-2021 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gsasl
is maintained as a Texinfo manual.  If the
.B info
and
.B gsasl
programs are properly installed at your site, the command
.IP
.B info gsasl
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B http://www.gnu.org/software/gsasl/manual/
.PP