punycode_strerror.3   [plain text]

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "punycode_strerror" 3 "0.6.14" "libidn" "libidn"
.SH NAME
punycode_strerror \- return string describing punycode error code
.SH SYNOPSIS
.B #include <punycode.h>
.sp
.BI "const char * punycode_strerror(Punycode_status " rc ");"
.SH ARGUMENTS
.IP "Punycode_status rc" 12
an \fBPunycode_status\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 "PUNYCODE_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 "PUNYCODE_BAD_INPUT"
Input is invalid.
.SH "PUNYCODE_BIG_OUTPUT"
Output would exceed the space provided.
.SH "PUNYCODE_OVERFLOW"
Input needs wider integers to process.
.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.