stringprep

NAME

stringprep_4zi

SYNOPSIS

#include <stringprep.h>

int stringprep_4zi(uint32_t * ucs4, size_t maxucs4len, Stringprep_profile_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: stringprep profile flags, or 0.
const Stringprep_profile * profile: pointer to stringprep profile to use.

DESCRIPTION

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

Since the stringprep operation can expand the string, maxucs4len indicate 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.