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  be‐
34       fore 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  re‐
47       turned, when either of the input labels are too long IDN2_TOO_BIG_LABEL
48       is returned, when  alabel does does not appear to be a  proper  A-label
49       IDN2_INVALID_ALABEL is returned, or another error code is returned.
50

REPORTING BUGS

52       Report bugs to <help-libidn@gnu.org>.
53       General guidelines for reporting bugs: https://www.gnu.org/gethelp/
54       Libidn2 home page: https://www.gnu.org/software/libidn2/
55
56
58       Copyright © 2002-2022 Simon Josefsson.
59       Copying  and  distribution  of this file, with or without modification,
60       are permitted in any medium without royalty provided the copyright  no‐
61       tice and this notice are preserved.
62

SEE ALSO

64       The  full  documentation for libidn2 is maintained as a Texinfo manual.
65       If the info and libidn2 programs are properly installed at  your  site,
66       the command
67
68              info libidn2
69
70       should  give  you access to the complete manual.  As an alternative you
71       may obtain the manual from:
72
73              https://www.gnu.org/software/libidn/libidn2/manual/
74
75libidn2                              2.3.4                 idn2_register_u8(3)
Impressum