stringprep(3)

1stringprep(3)                       libidn                       stringprep(3)
2
3
4

NAME

6       stringprep - prepare internationalized string
7

SYNOPSIS

9       #include <stringprep.h>
10
11       int  stringprep(char  *  in,  size_t  maxlen,  Stringprep_profile_flags
12       flags, const Stringprep_profile * profile);
13

ARGUMENTS

15       char * in   input/ouput array with string to prepare.
16
17       size_t maxlen
18                   maximum length of input/output array.
19
20       Stringprep_profile_flags flags
21                   a Stringprep_profile_flags value, or 0.
22
23       const Stringprep_profile * profile
24                   pointer to Stringprep_profile to use.
25

DESCRIPTION

27       Prepare the input zero terminated UTF-8 string according to the string‐
28       prep profile, and write back the result to the input string.
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       Since the stringprep operation can expand the string,  maxlen  indicate
34       how  large  the  buffer  holding the string is.  This function will not
35       read or write to characters outside that size.
36
37       The flags are one of Stringprep_profile_flags values, or 0.
38
39       The profile contain the  Stringprep_profile  instructions  to  perform.
40       Your application can define new profiles, possibly re-using the generic
41       stringprep tables that always will be part of the library, or  use  one
42       of the currently supported profiles.
43

RETURN VALUE

45       Returns STRINGPREP_OK iff successful, or an error code.
46

REPORTING BUGS

48       Report bugs to <bug-libidn@gnu.org>.
49

COPYRIGHT

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