www.LinuxHowtos.org

stringprep_4zi

Section: libidn (3)
Updated: 1.33
Index Return to Main Contents

NAME

stringprep_4zi - API function

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: 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 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 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 <bug-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-2016 Simon Josefsson.
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.