.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "stringprep" 3 "1.42" "libidn" "libidn"
.SH NAME
stringprep \- API function
.SH SYNOPSIS
.B #include <stringprep.h>
.sp
.BI "int stringprep(char * " in ", size_t " maxlen ", Stringprep_profile_flags " flags ", const Stringprep_profile * " profile ");"
.SH ARGUMENTS
.IP "char * in" 12
input/output array with string to prepare.
.IP "size_t maxlen" 12
maximum length of input/output array.
.IP "Stringprep_profile_flags flags" 12
a \fBStringprep_profile_flags\fP value, or 0.
.IP "const Stringprep_profile * profile" 12
pointer to \fBStringprep_profile\fP to use.
.SH "DESCRIPTION"
Prepare the input zero terminated UTF\-8 string according to the
stringprep profile, and write back the result to the input string.

Note that you must convert strings entered in the systems locale
into UTF\-8 before using this function, see
\fBstringprep_locale_to_utf8()\fP.

Since the stringprep operation can expand the string,  \fImaxlen\fP indicate how large the buffer holding the string is.  This function
will not read or write to characters outside that size.

The  \fIflags\fP are one of \fBStringprep_profile_flags\fP values, or 0.

The  \fIprofile\fP contain the \fBStringprep_profile\fP instructions to
perform.  Your application can define new profiles, possibly
re\-using the generic stringprep tables that always will be part of
the library, or use one of the currently supported profiles.

Return value: Returns \fBSTRINGPREP_OK\fP iff successful, or an error code.
.SH "REPORTING BUGS"
Report bugs to <help-libidn@gnu.org>.
.br
General guidelines for reporting bugs: https://www.gnu.org/gethelp/
.br
GNU Libidn home page: https://www.gnu.org/software/libidn/

.SH COPYRIGHT
Copyright \(co 2002-2024 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 libidn
is maintained as a Texinfo manual.  If the
.B info
and
.B libidn
programs are properly installed at your site, the command
.IP
.B info libidn
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B https://www.gnu.org/software/libidn/manual/
.PP