1stringprep_4zi(3) libidn stringprep_4zi(3)
2
3
4
6 stringprep_4zi - API function
7
9 #include <stringprep.h>
10
11 int stringprep_4zi(uint32_t * ucs4, size_t maxucs4len, Stringprep_pro‐
12 file_flags flags, const Stringprep_profile * profile);
13
15 uint32_t * ucs4
16 input/output array with zero terminated string to prepare.
17
18 size_t maxucs4len
19 maximum length of input/output array.
20
21 Stringprep_profile_flags flags
22 a Stringprep_profile_flags value, or 0.
23
24 const Stringprep_profile * profile
25 pointer to Stringprep_profile to use.
26
28 Prepare the input zero terminated UCS-4 string according to the string‐
29 prep profile, and write back the result to the input string.
30
31 Since the stringprep operation can expand the string, maxucs4len indi‐
32 cate how large the buffer holding the string is. This function will
33 not read or write to code points outside that size.
34
35 The flags are one of Stringprep_profile_flags values, or 0.
36
37 The profile contain the Stringprep_profile instructions to perform.
38 Your application can define new profiles, possibly re-using the generic
39 stringprep tables that always will be part of the library, or use one
40 of the currently supported profiles.
41
42 Return value: Returns STRINGPREP_OK iff successful, or an Stringprep_rc
43 error code.
44
46 Report bugs to <bug-libidn@gnu.org>.
47 General guidelines for reporting bugs: http://www.gnu.org/gethelp/
48 GNU Libidn home page: http://www.gnu.org/software/libidn/
49
50
52 Copyright © 2002-2016 Simon Josefsson.
53 Copying and distribution of this file, with or without modification,
54 are permitted in any medium without royalty provided the copyright
55 notice and this notice are preserved.
56
58 The full documentation for libidn is maintained as a Texinfo manual.
59 If the info and libidn programs are properly installed at your site,
60 the command
61
62 info libidn
63
64 should give you access to the complete manual. As an alternative you
65 may obtain the manual from:
66
67 http://www.gnu.org/software/libidn/manual/
68
69libidn 1.34 stringprep_4zi(3)