stringprep_4zi(3)

1stringprep_4zi(3)                   libidn                   stringprep_4zi(3)
2
3
4

NAME

6       stringprep_4zi - prepare internationalized string
7

SYNOPSIS

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

ARGUMENTS

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

DESCRIPTION

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

RETURN VALUE

43       Returns STRINGPREP_OK iff successful, or an Stringprep_rc error code.
44

REPORTING BUGS

46       Report bugs to <bug-libidn@gnu.org>.
47

COPYRIGHT

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