Current File : //usr/share/man/man3/idna_to_unicode_44i.3

'\" te
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "idna_to_unicode_44i" 3 "1.19" "libidn" "libidn"
.SH NAME
idna_to_unicode_44i \- API function
.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 domain 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>.
GNU Libidn home page: http://www.gnu.org/software/libidn/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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.

.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	library/libidn
=
Stability	Uncommitted
.TE 
.PP
.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.


.SH NOTES

.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  http://ftp.gnu.org/gnu/libidn/libidn-1.19.tar.gz

Further information about this software can be found on the open source community website at http://www.gnu.org/software/libidn/.