Current File : //usr/man/man3/stringprep_profile.3

'\" te
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "stringprep_profile" 3 "1.19" "libidn" "libidn"
.SH NAME
stringprep_profile \- API function
.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, 2010 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.

.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	library/libidn
=
Stability	Uncommitted
.TE 
.PP
.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.


.SH NOTES

.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  http://ftp.gnu.org/gnu/libidn/libidn-1.19.tar.gz

Further information about this software can be found on the open source community website at http://www.gnu.org/software/libidn/.