stringprep_4i(3)

1stringprep_4i(3)                    libidn                    stringprep_4i(3)
2
3
4

NAME

6       stringprep_4i - prepare internationalized string
7

SYNOPSIS

9       #include <stringprep.h>
10
11       int  stringprep_4i(uint32_t  *  ucs4,  size_t * len, size_t maxucs4len,
12       Stringprep_profile_flags flags, const Stringprep_profile * profile);
13

ARGUMENTS

15       uint32_t * ucs4
16                   input/output array with string to prepare.
17
18       size_t * len
19                   on input, length of input array with Unicode  code  points,
20                   on exit, length of output array with Unicode code points.
21
22       size_t maxucs4len
23                   maximum length of input/output array.
24
25       Stringprep_profile_flags flags
26                   a Stringprep_profile_flags value, or 0.
27
28       const Stringprep_profile * profile
29                   pointer to Stringprep_profile to use.
30

DESCRIPTION

32       Prepare the input UCS-4 string according to the stringprep profile, and
33       write back the result to the input string.
34
35       The input is not required to be zero terminated (ucs4[len] =  0).   The
36       output  will not be zero terminated unless ucs4[len] = 0.  Instead, see
37       stringprep_4zi() if your input is zero terminated or if  you  want  the
38       output to be.
39
40       Since  the stringprep operation can expand the string, maxucs4len indi‐
41       cate how large the buffer holding the string is.   This  function  will
42       not read or write to code points outside that size.
43
44       The flags are one of Stringprep_profile_flags values, or 0.
45
46       The  profile  contain  the  Stringprep_profile instructions to perform.
47       Your application can define new profiles, possibly re-using the generic
48       stringprep  tables  that always will be part of the library, or use one
49       of the currently supported profiles.
50

RETURN VALUE

52       Returns STRINGPREP_OK iff successful, or an Stringprep_rc error code.
53

REPORTING BUGS

55       Report bugs to <bug-libidn@gnu.org>.
56

COPYRIGHT

58       Copyright © 2002, 2003, 2004, 2005, 2006 Simon Josefsson.
59       Permission is granted to make and distribute verbatim  copies  of  this
60       manual  provided  the  copyright  notice and this permission notice are
61       preserved on all copies.
62