1idn2_register_u8(3)                 libidn2                idn2_register_u8(3)
2
3
4

NAME

6       idn2_register_u8 - API function
7

SYNOPSIS

9       #include <idn2.h>
10
11       int  idn2_register_u8(const  uint8_t  * ulabel, const uint8_t * alabel,
12       uint8_t ** insertname, int flags);
13

ARGUMENTS

15       const uint8_t * ulabel
16                   input zero-terminated UTF-8  and  Unicode  NFC  string,  or
17                   NULL.
18
19       const uint8_t * alabel
20                   input zero-terminated ACE encoded string (xn--), or NULL.
21
22       uint8_t ** insertname
23                   newly  allocated  output  variable with name to register in
24                   DNS.
25
26       int flags   optional idn2_flags to modify behaviour.
27

DESCRIPTION

29       Perform IDNA2008 register string conversion on domain label  ulabel and
30       alabel  ,  as  described in section 4 of RFC 5891.  Note that the input
31       ulabel must be encoded in UTF-8 and be in Unicode NFC form.
32
33       Pass IDN2_NFC_INPUT in  flags to convert  input   ulabel  to  NFC  form
34       before further processing.
35
36       It  is  recommended to supply both  ulabel and  alabel for better error
37       checking, but supplying just one of them will work.   Passing  in  only
38       alabel  is  better than only  ulabel .  See RFC 5891 section 4 for more
39       information.
40
41       After version 0.11:  insertname may be NULL to test conversion of   src
42       without allocating memory.
43

RETURNS

45       On  successful  conversion  IDN2_OK is returned, when the given  ulabel
46       and   alabel  does  not  match  each  other  IDN2_UALABEL_MISMATCH   is
47       returned,   when   either   of   the   input   labels   are   too  long
48       IDN2_TOO_BIG_LABEL is returned, when  alabel does does not appear to be
49       a proper A-label IDN2_INVALID_ALABEL is returned, or another error code
50       is returned.
51

SEE ALSO

53       The full documentation for libidn2 is maintained as a  Texinfo  manual.
54       If  the  info and libidn2 programs are properly installed at your site,
55       the command
56
57              info libidn2
58
59       should give you access to the complete manual.  As an  alternative  you
60       may obtain the manual from:
61
62              http://www.gnu.org/software/libidn/libidn2/manual/
63
64libidn2                              2.2.0                 idn2_register_u8(3)
Impressum