.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "idna_to_ascii_4i" 3 "1.38" "libidn" "libidn"
.SH NAME
idna_to_ascii_4i \- API function
.SH SYNOPSIS
.B #include <idna.h>
.sp
.BI "int idna_to_ascii_4i(const uint32_t * " in ", size_t " inlen ", char * " out ", 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 "char * out" 12
output zero terminated string that must have room for at
least 63 characters plus the terminating zero.
.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 ToASCII operation takes a sequence of Unicode code points that
make up one domain label and transforms it into a sequence of code
points in the ASCII range (0..7F). If ToASCII succeeds, the
original sequence and the resulting sequence are equivalent labels.

It is important to note that the ToASCII operation can fail. ToASCII
fails if any step of it fails. If any step of the ToASCII operation
fails on any label in a domain name, that domain name MUST NOT be used
as an internationalized domain name. The method for deadling with this
failure is application\-specific.

The inputs to ToASCII are a sequence of code points, the AllowUnassigned
flag, and the UseSTD3ASCIIRules flag. The output of ToASCII is either a
sequence of ASCII code points or a failure condition.

ToASCII never alters a sequence of code points that are all in the ASCII
range to begin with (although it could fail). Applying the ToASCII
operation multiple times has exactly the same effect as applying it just
once.

Return value: Returns 0 on success, or an \fBIdna_rc\fP error code.
.SH "REPORTING BUGS"
Report bugs to <help-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-2021 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
