---

Manual Reference Pages  - stringprep (3)

---

stringprep

CONTENTS

Synopsis
Arguments
Copyright

#include <stringprep.h>

int stringprep(char * in, size_t maxlen, Stringprep_profile_flags flags, const Stringprep_profile * profile);

char * in	input/ouput array with string to prepare.
size_t maxlen	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.

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

Note that you must convert strings entered in the systems locale into UTF-8 before using this function, see

stringprep_locale_to_utf8()

Since the stringprep operation can expand the string, maxlen indicate how large the buffer holding the string is. This function will not read or write to characters 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.

Returns STRINGPREP_OK
iff successful, or an error code.

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

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.

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.

Jump to page    or go to Top of page |  Section 3 |  Main Index.