.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "idn2_to_ascii_8z" 3 "2.3.1.48-1925" "libidn2" "libidn2"
.SH NAME
idn2_to_ascii_8z \- API function
.SH SYNOPSIS
.B #include <idn2.h>
.sp
.BI "int idn2_to_ascii_8z(const char * " input ", char ** " output ", int " flags ");"
.SH ARGUMENTS
.IP "const char * input" 12
zero terminated input UTF\-8 string.
.IP "char ** output" 12
pointer to newly allocated output string.
.IP "int flags" 12
optional \fBidn2_flags\fP to modify behaviour.
.SH "DESCRIPTION"
Convert UTF\-8 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 "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