stringprep_4i

TriggerTek Logo
abcdefghijklmnopqrstuvwxyz_
stringprep_4i(3)		    libidn		     stringprep_4i(3)



NAME
       stringprep_4i

SYNOPSIS
       #include <stringprep.h>

       int  stringprep_4i(uint32_t  *  ucs4, size_t * len, size_t maxucs4len,
       Stringprep_profile_flags flags, const Stringprep_profile * profile);

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

       size_t * len
		    on input, length of input array with Unicode code points,
		   on  exit, length of output array with Unicode code points.

       size_t maxucs4len
		    maximum length of input/output array.

       Stringprep_profile_flags flags
		    stringprep profile flags, or 0.

       const Stringprep_profile * profile
		    pointer to stringprep profile to use.

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

       The  input  is not required to be zero terminated ( ucs4 [ len ] = 0).
       The output will not be zero terminated  unless  ucs4  [	len  ]	=  0.
       Instead, see stringprep_4zi()
	if your input is zero terminated or if you want the output to be.

       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, or 0.

       The profile contain the 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 error code.

REPORTING BUGS
       Report bugs to <bug-libidn@gnu.org>.

COPYRIGHT
       Copyright © 2002, 2003, 2004 Simon Josefsson.
       Permission is granted to make and distribute verbatim copies  of	 this
       manual  provided	 the  copyright notice and this permission notice are
       preserved on all copies.

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.



libidn				    0.5.6		     stringprep_4i(3)