Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

idn2_to_ascii_4i (3)

Name

idn2_to_ascii_4i - API function

Synopsis

#include <idn2.h>

int  idn2_to_ascii_4i(const uint32_t * input, size_t inlen, char * out-
put, int flags);

Description

idn2_to_ascii_4i(3)                 libidn2                idn2_to_ascii_4i(3)



NAME
       idn2_to_ascii_4i - API function

SYNOPSIS
       #include <idn2.h>

       int  idn2_to_ascii_4i(const uint32_t * input, size_t inlen, char * out-
       put, int flags);

ARGUMENTS
       const uint32_t * input
                   zero terminated input Unicode (UCS-4) string.

       size_t inlen
                   number of elements in  input .

       char * output
                   pointer to newly allocated zero-terminated output string.

       int flags   optional idn2_flags to modify behaviour.

DESCRIPTION
       The ToASCII operation takes a sequence of Unicode code points that make
       up one domain label and transforms it into a sequence of code points in
       the ASCII range (0..7F). If ToASCII succeeds, the original sequence and
       the resulting sequence are equivalent labels.

       It  is  important to note that the ToASCII operation can fail.  ToASCII
       fails if any step of it fails. If any step  of  the  ToASCII  operation
       fails  on any label in a domain name, that domain name MUST NOT be used
       as an internationalized domain name.  The method for dealing with  this
       failure is application-specific.

       The inputs to ToASCII are a sequence of code points.

       ToASCII  never  alters  a  sequence  of code points that are all in the
       ASCII range to begin  with  (although  it  could  fail).  Applying  the
       ToASCII operation multiple effect as applying it just once.

       When unsure, it is recommended to call this function with the IDN2_NON-
       TRANSITIONAL and IDN2_NFC_INPUT flags.

       Return value: Returns IDN2_OK on success, or error code.

SINCE
       2.0.0


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libidn2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       The full documentation for libidn2 is maintained as a  Texinfo  manual.
       If  the  info and libidn2 programs are properly installed at your site,
       the command

              info libidn2

       should give you access to the complete manual.  As an  alternative  you
       may obtain the manual from:

              http://www.gnu.org/software/libidn2/manual/

NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source         was         downloaded         from         https://git-
       lab.com/libidn/libidn2/uploads/15020b7769a7c69cebd38654ddf0648a/libidn2-2.0.4.tar.gz

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



libidn2                              2.0.4                 idn2_to_ascii_4i(3)