stringprep_utf8_to_ucs4.3   [plain text]


.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "stringprep_utf8_to_ucs4" 3 "0.6.14" "libidn" "libidn"
.SH NAME
stringprep_utf8_to_ucs4 \- convert UTF-8 string to UCS-4
.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, assuming valid UTF\-8 input.
This function does no error checking on the input.
.SH "RETURN VALUE"
a pointer to a newly allocated UCS\-4 string.
This value must be freed with \fBfree()\fP.
.SH "REPORTING BUGS"
Report bugs to <bug-libidn@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2002, 2003, 2004, 2005, 2006, 2007 Simon Josefsson.
.br
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
.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.