.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "idn2_to_ascii_4z" 3 "2.3.7" "libidn2" "libidn2"
.SH NAME
idn2_to_ascii_4z \- API function
.SH SYNOPSIS
.B #include <idn2.h>
.sp
.BI "int idn2_to_ascii_4z(const uint32_t * " input ", char ** " output ", int " flags ");"
.SH ARGUMENTS
.IP "const uint32_t * input" 12
zero terminated input Unicode (UCS\-4) string.
.IP "char ** output" 12
pointer to newly allocated zero\-terminated output string.
.IP "int flags" 12
optional \fBidn2_flags\fP to modify behaviour.
.SH "DESCRIPTION"
Convert UCS\-4 domain name to ASCII string using the IDNA2008
rules.  The domain name may contain several labels, separated by dots.
The output buffer must be deallocated by the caller.

The default behavior of this function (when flags are zero) is to apply
the IDNA2008 rules without the TR46 amendments. As the TR46
non\-transitional processing is nowadays ubiquitous, when unsure, it is
recommended to call this function with the \fBIDN2_NONTRANSITIONAL\fP
and the \fBIDN2_NFC_INPUT\fP flags for compatibility with other software.

Return value: Returns \fBIDN2_OK\fP on success, or error code.
.SH "SINCE"
2.0.0
.SH "REPORTING BUGS"
Report bugs to <help-libidn@gnu.org>.
.br
General guidelines for reporting bugs: https://www.gnu.org/gethelp/
.br
Libidn2 home page: https://www.gnu.org/software/libidn2/

.SH COPYRIGHT
Copyright \(co 2002-2024 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 libidn2
is maintained as a Texinfo manual.  If the
.B info
and
.B libidn2
programs are properly installed at your site, the command
.IP
.B info libidn2
.PP
should give you access to the complete manual.
As an alternative you may obtain the manual from:
.IP
.B https://www.gnu.org/software/libidn/libidn2/manual/
.PP