stringprep_strerror(3) libidn stringprep_strerror(3)NAME
stringprep_strerror - API function
SYNOPSIS
#include <stringprep.h>
const char * stringprep_strerror(Stringprep_rc rc);
ARGUMENTS
Stringprep_rc rc
a Stringprep_rc return code.
DESCRIPTION
Convert a return code integer to a text string. This string can be used to output a diagnostic message to the user.
STRINGPREP_OK
Successful operation. This value is guaranteed to always be zero, the remaining ones are only guaranteed to hold non-zero values, for log-
ical comparison purposes.
STRINGPREP_CONTAINS_UNASSIGNED
String contain unassigned Unicode code points, which is forbidden by the profile.
STRINGPREP_CONTAINS_PROHIBITED
String contain code points prohibited by the profile.
STRINGPREP_BIDI_BOTH_L_AND_RAL
String contain code points with conflicting bidirection category.
STRINGPREP_BIDI_LEADTRAIL_NOT_RAL
Leading and trailing character in string not of proper bidirectional category.
STRINGPREP_BIDI_CONTAINS_PROHIBITED
Contains prohibited code points detected by bidirectional code.
STRINGPREP_TOO_SMALL_BUFFER
Buffer handed to function was too small. This usually indicate a problem in the calling application.
STRINGPREP_PROFILE_ERROR
The stringprep profile was inconsistent. This usually indicate an internal error in the library.
STRINGPREP_FLAG_ERROR
The supplied flag conflicted with profile. This usually indicate a problem in the calling application.
STRINGPREP_UNKNOWN_PROFILE
The supplied profile name was not known to the library.
STRINGPREP_NFKC_FAILED
The Unicode NFKC operation failed. This usually indicate an internal error in the library.
STRINGPREP_MALLOC_ERROR
The malloc() was out of memory. This is usually a fatal error.
RETURN VALUE
Returns a pointer to a statically allocated string containing a description of the error with the return code rc.
REPORTING BUGS
Report bugs to <bug-libidn@gnu.org>. GNU Libidn home page: http://www.gnu.org/software/libidn/ General help using GNU software:
http://www.gnu.org/gethelp/
COPYRIGHT
Copyright (C) 2002-2012 Simon Josefsson.
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
SEE ALSO
The full documentation for libidn is maintained as a Texinfo manual. If the info and libidn programs are properly installed at your site,
the command
info libidn
should give you access to the complete manual.
libidn 1.25 stringprep_strerror(3)
Check Out this Related Man Page
stringprep_4zi(3) libidn stringprep_4zi(3)NAME
stringprep_4zi - prepare internationalized string
SYNOPSIS
#include <stringprep.h>
int stringprep_4zi(uint32_t * ucs4, size_t maxucs4len, Stringprep_profile_flags flags, const Stringprep_profile * profile);
ARGUMENTS
uint32_t * ucs4
input/output array with zero terminated string to prepare.
size_t maxucs4len
maximum length of input/output array.
Stringprep_profile_flags flags
a Stringprep_profile_flags value, or 0.
const Stringprep_profile * profile
pointer to Stringprep_profile to use.
DESCRIPTION
Prepare the input zero terminated UCS-4 string according to the stringprep profile, and write back the result to the input string.
Since the stringprep operation can expand the string, maxucs4len indicate how large the buffer holding the string is. This function will
not read or write to code points outside that size.
The flags are one of Stringprep_profile_flags values, or 0.
The profile contain the Stringprep_profile instructions to perform. Your application can define new profiles, possibly re-using the
generic stringprep tables that always will be part of the library, or use one of the currently supported profiles.
RETURN VALUE
Returns STRINGPREP_OK iff successful, or an Stringprep_rc error code.
REPORTING BUGS
Report bugs to <bug-libidn@gnu.org>. GNU Libidn home page: http://www.gnu.org/software/libidn/ General help using GNU software:
http://www.gnu.org/gethelp/
COPYRIGHT
Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Simon Josefsson.
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
SEE ALSO
The full documentation for libidn is maintained as a Texinfo manual. If the info and libidn programs are properly installed at your site,
the command
info libidn
should give you access to the complete manual.
libidn 1.15 stringprep_4zi(3)