.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "stringprep_utf8_to_ucs4" 3 "1.33" "libidn" "libidn"
.SH NAME
stringprep_utf8_to_ucs4 \- API function
.SH SYNOPSIS
.B #include <stringprep.h>
.sp
.BI "uint32_t * stringprep_utf8_to_ucs4(const char * " str ", ssize_t " len ", size_t * " items_written ");"
.SH ARGUMENTS
.IP "const char * str" 12
a UTF\-8 encoded string
.IP "ssize_t len" 12
the maximum length of  \fIstr\fP to use. If  \fIlen\fP < 0, then
the string is nul\-terminated.
.IP "size_t * items_written" 12
location to store the number of characters in the
result, or \fBNULL\fP.
.SH "DESCRIPTION"
Convert a string from UTF\-8 to a 32\-bit fixed width representation
as UCS\-4.  The function now performs error checking to verify that
the input is valid UTF\-8 (before it was documented to not do error
checking).

Return value: a pointer to a newly allocated UCS\-4 string.
This value must be deallocated by the caller.
.SH "REPORTING BUGS"
Report bugs to <bug-libidn@gnu.org>.
.br
General guidelines for reporting bugs: http://www.gnu.org/gethelp/
.br
GNU Libidn home page: http://www.gnu.org/software/libidn/

.SH COPYRIGHT
Copyright \(co 2002-2016 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 http://www.gnu.org/software/libidn/manual/
.PP