diff options
Diffstat (limited to 'doc/man/stringprep_profile.3')
-rw-r--r-- | doc/man/stringprep_profile.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/man/stringprep_profile.3 b/doc/man/stringprep_profile.3 new file mode 100644 index 0000000..4fec550 --- /dev/null +++ b/doc/man/stringprep_profile.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "stringprep_profile" 3 "1.15" "libidn" "libidn" +.SH NAME +stringprep_profile \- prepare internationalized string +.SH SYNOPSIS +.B #include <stringprep.h> +.sp +.BI "int stringprep_profile(const char * " in ", char ** " out ", const char * " profile ", Stringprep_profile_flags " flags ");" +.SH ARGUMENTS +.IP "const char * in" 12 +input array with UTF\-8 string to prepare. +.IP "char ** out" 12 +output variable with pointer to newly allocate string. +.IP "const char * profile" 12 +name of stringprep profile to use. +.IP "Stringprep_profile_flags flags" 12 +a \fBStringprep_profile_flags\fP value, or 0. +.SH "DESCRIPTION" +Prepare the input zero terminated UTF\-8 string according to the +stringprep profile, and return the result in a newly allocated +variable. + +Note that you must convert strings entered in the systems locale +into UTF\-8 before using this function, see +\fBstringprep_locale_to_utf8()\fP. + +The output \fIout\fP variable must be deallocated by the caller. + +The \fIflags\fP are one of \fBStringprep_profile_flags\fP values, or 0. + +The \fIprofile\fP specifies the name of the stringprep profile to use. +It must be one of the internally supported stringprep profiles. +.SH "RETURN VALUE" +Returns \fBSTRINGPREP_OK\fP iff successful, or an error code. +.SH "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/ +.SH COPYRIGHT +Copyright \(co 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Simon Josefsson. +.br +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. +.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. |