stringprep_strerror.3   [plain text]

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "stringprep_strerror" 3 "0.6.14" "libidn" "libidn"
.SH NAME
stringprep_strerror \- return string describing stringprep error code
.SH SYNOPSIS
.B #include <stringprep.h>
.sp
.BI "const char * stringprep_strerror(Stringprep_rc " rc ");"
.SH ARGUMENTS
.IP "Stringprep_rc rc" 12
a \fBStringprep_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 "STRINGPREP_OK"
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 "STRINGPREP_CONTAINS_UNASSIGNED"
String contain unassigned Unicode
code points, which is forbidden by the profile.
.SH "STRINGPREP_CONTAINS_PROHIBITED"
String contain code points
prohibited by the profile.
.SH "STRINGPREP_BIDI_BOTH_L_AND_RAL"
String contain code points with
conflicting bidirection category.
.SH "STRINGPREP_BIDI_LEADTRAIL_NOT_RAL"
Leading and trailing character
in string not of proper bidirectional category.
.SH "STRINGPREP_BIDI_CONTAINS_PROHIBITED"
Contains prohibited code
points detected by bidirectional code.
.SH "STRINGPREP_TOO_SMALL_BUFFER"
Buffer handed to function was too
small.  This usually indicate a problem in the calling
application.
.SH "STRINGPREP_PROFILE_ERROR"
The stringprep profile was inconsistent.
This usually indicate an internal error in the library.
.SH "STRINGPREP_FLAG_ERROR"
The supplied flag conflicted with profile.
This usually indicate a problem in the calling application.
.SH "STRINGPREP_UNKNOWN_PROFILE"
The supplied profile name was not
known to the library.
.SH "STRINGPREP_NFKC_FAILED"
The Unicode NFKC operation failed.  This
usually indicate an internal error in the library.
.SH "STRINGPREP_MALLOC_ERROR"
The \fBmalloc()\fP was out of memory.  This is
usually a fatal error.
.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.