stringprep_profile(3)

1stringprep_profile(3)               libidn               stringprep_profile(3)
2
3
4

NAME

6       stringprep_profile - prepare internationalized string
7

SYNOPSIS

9       #include <stringprep.h>
10
11       int  stringprep_profile(const char * in, char ** out, const char * pro‐
12       file, Stringprep_profile_flags flags);
13

ARGUMENTS

15       const char * in
16                   input array with UTF-8 string to prepare.
17
18       char ** out output variable with pointer to newly allocate string.
19
20       const char * profile
21                   name of stringprep profile to use.
22
23       Stringprep_profile_flags flags
24                   a Stringprep_profile_flags value, or 0.
25

DESCRIPTION

27       Prepare the input zero terminated UTF-8 string according to the string‐
28       prep profile, and return the result in a newly allocated variable.
29
30       Note  that  you must convert strings entered in the systems locale into
31       UTF-8 before using this function, see stringprep_locale_to_utf8().
32
33       The output out variable must be deallocated by the caller.
34
35       The flags are one of Stringprep_profile_flags values, or 0.
36
37       The profile specifies the name of the stringprep profile  to  use.   It
38       must be one of the internally supported stringprep profiles.
39

RETURN VALUE

41       Returns STRINGPREP_OK iff successful, or an error code.
42

REPORTING BUGS

44       Report bugs to <bug-libidn@gnu.org>.
45

COPYRIGHT

47       Copyright © 2002, 2003, 2004, 2005, 2006 Simon Josefsson.
48       Permission  is  granted  to make and distribute verbatim copies of this
49       manual provided the copyright notice and  this  permission  notice  are
50       preserved on all copies.
51