dwww Home | Manual pages | Find package

stringprep_4zi(3)                   libidn                   stringprep_4zi(3)

NAME
       stringprep_4zi - API function

SYNOPSIS
       #include <stringprep.h>

       int  stringprep_4zi(uint32_t * ucs4, size_t maxucs4len, Stringprep_pro-
       file_flags flags, const Stringprep_profile * profile);

ARGUMENTS
       uint32_t * ucs4
                   input/output array with zero terminated string to prepare.

       size_t maxucs4len
                   maximum length of input/output array.

       Stringprep_profile_flags flags
                   a Stringprep_profile_flags value, or 0.

       const Stringprep_profile * profile
                   pointer to Stringprep_profile to use.

DESCRIPTION
       Prepare the input zero terminated UCS-4 string according to the string-
       prep profile, and write back the result to the input string.

       Since the stringprep operation can expand the string,  maxucs4len indi-
       cate how large the buffer holding the string is.   This  function  will
       not read or write to code points outside that size.

       The  flags are one of Stringprep_profile_flags values, or 0.

       The   profile  contain  the Stringprep_profile instructions to perform.
       Your application can define new profiles, possibly re-using the generic
       stringprep  tables  that always will be part of the library, or use one
       of the currently supported profiles.

       Return value: Returns STRINGPREP_OK iff successful, or an Stringprep_rc
       error code.

REPORTING BUGS
       Report bugs to <help-libidn@gnu.org>.
       General guidelines for reporting bugs: http://www.gnu.org/gethelp/
       GNU Libidn home page: http://www.gnu.org/software/libidn/

COPYRIGHT
       Copyright © 2002-2021 Simon Josefsson.
       Copying  and  distribution  of this file, with or without modification,
       are permitted in any medium without royalty provided the copyright  no-
       tice and this notice are preserved.

SEE ALSO
       The  full  documentation  for libidn is maintained as a Texinfo manual.
       If the info and libidn programs are properly installed  at  your  site,
       the command

              info libidn

       should  give  you access to the complete manual.  As an alternative you
       may obtain the manual from:

              http://www.gnu.org/software/libidn/manual/

libidn                               1.38                    stringprep_4zi(3)

Generated by dwww version 1.14 on Fri Jan 24 06:20:57 CET 2025.