Blame doc/manpages/gnutls_idna_map.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_idna_map" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_idna_map \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/gnutls.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_idna_map(const char * " input ", unsigned " ilen ", gnutls_datum_t * " out ", unsigned " flags ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "const char * input" 12
Packit aea12f
contain the UTF\-8 formatted domain name
Packit aea12f
.IP "unsigned ilen" 12
Packit aea12f
the length of the provided string
Packit aea12f
.IP "gnutls_datum_t * out" 12
Packit aea12f
the result in an null\-terminated allocated string
Packit aea12f
.IP "unsigned flags" 12
Packit aea12f
should be zero
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will convert the provided UTF\-8 domain name, to
Packit aea12f
its IDNA mapping in an allocated variable. Note that depending on the flags the used gnutls
Packit aea12f
library was compiled with, the output of this function may vary (i.e.,
Packit aea12f
may be IDNA2008, or IDNA2003).
Packit aea12f
Packit aea12f
To force IDNA2008 specify the flag \fBGNUTLS_IDNA_FORCE_2008\fP. In
Packit aea12f
the case GnuTLS is not compiled with the necessary dependencies,
Packit aea12f
\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP will be returned to indicate that
Packit aea12f
gnutls is unable to perform the requested conversion.
Packit aea12f
Packit aea12f
Note also, that this function will return an empty string if an
Packit aea12f
empty string is provided as input.
Packit aea12f
.SH "RETURNS"
Packit aea12f
\fBGNUTLS_E_INVALID_UTF8_STRING\fP on invalid UTF\-8 data, or 0 on success.
Packit aea12f
.SH "SINCE"
Packit aea12f
3.5.8
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit Service 991b93
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP