idna_strerror.3   [plain text]


.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "idna_strerror" 3 "0.6.14" "libidn" "libidn"
.SH NAME
idna_strerror \- return string describing idna error code
.SH SYNOPSIS
.B #include <idna.h>
.sp
.BI "const char * idna_strerror(Idna_rc " rc ");"
.SH ARGUMENTS
.IP "Idna_rc rc" 12
an \fBIdna_rc\fP return code.
.SH "DESCRIPTION"
Convert a return code integer to a text string.  This string can be
used to output a diagnostic message to the user.
.SH "IDNA_SUCCESS"
Successful operation.  This value is guaranteed to
always be zero, the remaining ones are only guaranteed to hold
non\-zero values, for logical comparison purposes.
.SH "IDNA_STRINGPREP_ERROR"
Error during string preparation.
.SH "IDNA_PUNYCODE_ERROR"
Error during punycode operation.
.SH "IDNA_CONTAINS_NON_LDH"
For IDNA_USE_STD3_ASCII_RULES, indicate that
the string contains non\-LDH ASCII characters.
.SH "IDNA_CONTAINS_MINUS"
For IDNA_USE_STD3_ASCII_RULES, indicate that
the string contains a leading or trailing hyphen\-minus (U+002D).
.SH "IDNA_INVALID_LENGTH"
The final output string is not within the
(inclusive) range 1 to 63 characters.
.SH "IDNA_NO_ACE_PREFIX"
The string does not contain the ACE prefix
(for ToUnicode).
.SH "IDNA_ROUNDTRIP_VERIFY_ERROR"
The ToASCII operation on output
string does not equal the input.
.SH "IDNA_CONTAINS_ACE_PREFIX"
The input contains the ACE prefix (for
ToASCII).
.SH "IDNA_ICONV_ERROR"
Could not convert string in locale encoding.
.SH "IDNA_MALLOC_ERROR"
Could not allocate buffer (this is typically a
fatal error).
.SH "IDNA_DLOPEN_ERROR"
Could not dlopen the libcidn DSO (only used
internally in libc).
.SH "RETURN VALUE"
Returns a pointer to a statically allocated string
containing a description of the error with the return code \fIrc\fP.
.SH "REPORTING BUGS"
Report bugs to <bug-libidn@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2002, 2003, 2004, 2005, 2006, 2007 Simon Josefsson.
.br
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
.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.