Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

stringprep_profile (3)

Name

stringprep_profile - API function

Synopsis

#include <stringprep.h>

int  stringprep_profile(const char * in, char ** out, const char * pro-
file, Stringprep_profile_flags flags);

Description

stringprep_profile(3)               libidn               stringprep_profile(3)



NAME
       stringprep_profile - API function

SYNOPSIS
       #include <stringprep.h>

       int  stringprep_profile(const char * in, char ** out, const char * pro-
       file, Stringprep_profile_flags flags);

ARGUMENTS
       const char * in
                   input array with UTF-8 string to prepare.

       char ** out output variable with pointer to newly allocate string.

       const char * profile
                   name of stringprep profile to use.

       Stringprep_profile_flags flags
                   a Stringprep_profile_flags value, or 0.

DESCRIPTION
       Prepare the input zero terminated UTF-8 string according to the string-
       prep profile, and return the result in a newly allocated variable.

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

       The output  out variable must be deallocated by the caller.

       The  flags are one of Stringprep_profile_flags values, or 0.

       The  profile specifies the name of the stringprep profile to  use.   It
       must be one of the internally supported stringprep profiles.

       Return value: Returns STRINGPREP_OK iff successful, or an 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 (C) 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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libidn   |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

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/

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source                was                downloaded                from
       https://ftp.gnu.org/gnu/libidn/libidn-1.34.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.gnu.org/software/libidn.



libidn                               1.34                stringprep_profile(3)