stringprep_4i(3)

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

NAME

6       stringprep_4i - API function
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).
36       The  output  will not be zero terminated unless  ucs4 [ len ] = 0.  In‐
37       stead, see stringprep_4zi() if your input is zero terminated or if  you
38       want the 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
51       Return value: Returns STRINGPREP_OK iff successful, or an Stringprep_rc
52       error code.
53

DESCRIPTION

55       Prepare the input UCS-4 string according to the stringprep profile, and
56       write back the result to the input string.
57
58       The input is not required to be zero terminated ( ucs4 [ len  ]  =  0).
59       The  output  will not be zero terminated unless  ucs4 [ len ] = 0.  In‐
60       stead, see stringprep_4zi() if your input is zero terminated or if  you
61       want the output to be.
62
63       Since the stringprep operation can expand the string,  maxucs4len indi‐
64       cate how large the buffer holding the string is.   This  function  will
65       not read or write to code points outside that size.
66
67       The  flags are one of Stringprep_profile_flags values, or 0.
68
69       The   profile  contain  the Stringprep_profile instructions to perform.
70       Your application can define new profiles, possibly re-using the generic
71       stringprep  tables  that always will be part of the library, or use one
72       of the currently supported profiles.
73
74       Return value: Returns STRINGPREP_OK iff successful, or an Stringprep_rc
75       error code.
76

REPORTING BUGS

78       Report bugs to <help-libidn@gnu.org>.
79       General guidelines for reporting bugs: https://www.gnu.org/gethelp/
80       GNU Libidn home page: https://www.gnu.org/software/libidn/
81
82

COPYRIGHT

84       Copyright © 2002-2022 Simon Josefsson.
85       Copying  and  distribution  of this file, with or without modification,
86       are permitted in any medium without royalty provided the copyright  no‐
87       tice and this notice are preserved.
88