1idn2_register_ul(3)                 libidn2                idn2_register_ul(3)
2
3
4

NAME

6       idn2_register_ul - API function
7

SYNOPSIS

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

ARGUMENTS

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

DESCRIPTION

28       Perform IDNA2008 register string conversion on domain label  ulabel and
29       alabel , as described in section 4 of RFC 5891.  Note  that  the  input
30       ulabel  is assumed to be encoded in the locale's default coding system,
31       and will be transcoded to UTF-8 and NFC normalized by this function.
32
33       It is recommended to supply both  ulabel and  alabel for  better  error
34       checking,  but  supplying  just one of them will work.  Passing in only
35       alabel is better than only  ulabel .  See RFC 5891 section 4  for  more
36       information.
37
38       After  version 0.11:  insertname may be NULL to test conversion of  src
39       without allocating memory.
40

RETURNS

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

SEE ALSO

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