idna_to_unicode_44i.3   [plain text]

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "idna_to_unicode_44i" 3 "0.6.14" "libidn" "libidn"
.SH NAME
idna_to_unicode_44i \- convert domain name label to Unicode
.SH SYNOPSIS
.B #include <idna.h>
.sp
.BI "int idna_to_unicode_44i(const uint32_t * " in ", size_t " inlen ", uint32_t * " out ", size_t * " outlen ", int " flags ");"
.SH ARGUMENTS
.IP "const uint32_t * in" 12
input array with unicode code points.
.IP "size_t inlen" 12
length of input array with unicode code points.
.IP "uint32_t * out" 12
output array with unicode code points.
.IP "size_t * outlen" 12
on input, maximum size of output array with unicode code points,
on exit, actual size of output array with unicode code points.
.IP "int flags" 12
an \fBIdna_flags\fP value, e.g., \fBIDNA_ALLOW_UNASSIGNED\fP or
\fBIDNA_USE_STD3_ASCII_RULES\fP.
.SH "DESCRIPTION"
The ToUnicode operation takes a sequence of Unicode code points
that make up one label and returns a sequence of Unicode code
points. If the input sequence is a label in ACE form, then the
result is an equivalent internationalized label that is not in ACE
form, otherwise the original sequence is returned unaltered.

ToUnicode never fails. If any step fails, then the original input
sequence is returned immediately in that step.

The Punycode decoder can never output more code points than it
inputs, but Nameprep can, and therefore ToUnicode can.  Note that
the number of octets needed to represent a sequence of code points
depends on the particular character encoding used.

The inputs to ToUnicode are a sequence of code points, the
AllowUnassigned flag, and the UseSTD3ASCIIRules flag. The output of
ToUnicode is always a sequence of Unicode code points.
.SH "RETURN VALUE"
Returns \fBIdna_rc\fP error condition, but it must only be
used for debugging purposes.  The output buffer is always
guaranteed to contain the correct data according to the
specification (sans malloc induced errors).  NB!  This means that
you normally ignore the return code from this function, as
checking it means breaking the standard.
.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.