1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libidn-tld">
<refmeta>
<refentrytitle role="top_of_page" id="libidn-tld.top_of_page">tld</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBIDN Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>tld</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="libidn-tld.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="IDNAPI--CAPS">IDNAPI</link>
typedef <link linkend="Tld-table-element">Tld_table_element</link>;
typedef <link linkend="Tld-table">Tld_table</link>;
enum <link linkend="Tld-rc">Tld_rc</link>;
const <link linkend="char">char</link> * <link linkend="tld-strerror">tld_strerror</link> (<link linkend="Tld-rc">Tld_rc</link> rc);
<link linkend="int">int</link> <link linkend="tld-get-4">tld_get_4</link> (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> inlen,
<link linkend="char">char</link> **out);
<link linkend="int">int</link> <link linkend="tld-get-4z">tld_get_4z</link> (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="char">char</link> **out);
<link linkend="int">int</link> <link linkend="tld-get-z">tld_get_z</link> (const <link linkend="char">char</link> *in,
<link linkend="char">char</link> **out);
const <link linkend="Tld-table">Tld_table</link> * <link linkend="tld-get-table">tld_get_table</link> (const <link linkend="char">char</link> *tld,
const <link linkend="Tld-table">Tld_table</link> **tables);
const <link linkend="Tld-table">Tld_table</link> * <link linkend="tld-default-table">tld_default_table</link> (const <link linkend="char">char</link> *tld,
const <link linkend="Tld-table">Tld_table</link> **overrides);
<link linkend="int">int</link> <link linkend="tld-check-4t">tld_check_4t</link> (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> inlen,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> *tld);
<link linkend="int">int</link> <link linkend="tld-check-4tz">tld_check_4tz</link> (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> *tld);
<link linkend="int">int</link> <link linkend="tld-check-4">tld_check_4</link> (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> inlen,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);
<link linkend="int">int</link> <link linkend="tld-check-4z">tld_check_4z</link> (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);
<link linkend="int">int</link> <link linkend="tld-check-8z">tld_check_8z</link> (const <link linkend="char">char</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);
<link linkend="int">int</link> <link linkend="tld-check-lz">tld_check_lz</link> (const <link linkend="char">char</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libidn-tld.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libidn-tld.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="IDNAPI--CAPS" role="macro">
<title>IDNAPI</title>
<indexterm zone="IDNAPI--CAPS"><primary sortas="IDNAPI">IDNAPI</primary></indexterm><programlisting>#define IDNAPI</programlisting>
<para>
</para></refsect2>
<refsect2 id="Tld-table-element" role="typedef">
<title>Tld_table_element</title>
<indexterm zone="Tld-table-element"><primary sortas="Tld_table_element">Tld_table_element</primary></indexterm><programlisting> typedef struct Tld_table_element Tld_table_element;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="Tld-table" role="typedef">
<title>Tld_table</title>
<indexterm zone="Tld-table"><primary sortas="Tld_table">Tld_table</primary></indexterm><programlisting> typedef struct Tld_table Tld_table;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="Tld-rc" role="enum">
<title>enum Tld_rc</title>
<indexterm zone="Tld-rc"><primary sortas="Tld_rc">Tld_rc</primary></indexterm><programlisting> typedef enum
{
TLD_SUCCESS = 0,
TLD_INVALID = 1, /* Invalid character found. */
TLD_NODATA = 2, /* Char, domain or inlen = 0. */
TLD_MALLOC_ERROR = 3,
TLD_ICONV_ERROR = 4,
TLD_NO_TLD = 5,
/* Workaround typo in earlier versions. */
TLD_NOTLD = TLD_NO_TLD
} Tld_rc;
</programlisting>
<para>
Enumerated return codes of the TLD checking functions.
The value 0 is guaranteed to always correspond to success.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="TLD-SUCCESS--CAPS" role="constant">
<term><literal>TLD_SUCCESS</literal></term>
<listitem><simpara> Successful operation. This value is guaranteed to
always be zero, the remaining ones are only guaranteed to hold
non-zero values, for logical comparison purposes.
</simpara></listitem>
</varlistentry>
<varlistentry id="TLD-INVALID--CAPS" role="constant">
<term><literal>TLD_INVALID</literal></term>
<listitem><simpara> Invalid character found.
</simpara></listitem>
</varlistentry>
<varlistentry id="TLD-NODATA--CAPS" role="constant">
<term><literal>TLD_NODATA</literal></term>
<listitem><simpara> No input data was provided.
</simpara></listitem>
</varlistentry>
<varlistentry id="TLD-MALLOC-ERROR--CAPS" role="constant">
<term><literal>TLD_MALLOC_ERROR</literal></term>
<listitem><simpara> Error during memory allocation.
</simpara></listitem>
</varlistentry>
<varlistentry id="TLD-ICONV-ERROR--CAPS" role="constant">
<term><literal>TLD_ICONV_ERROR</literal></term>
<listitem><simpara> Error during iconv string conversion.
</simpara></listitem>
</varlistentry>
<varlistentry id="TLD-NO-TLD--CAPS" role="constant">
<term><literal>TLD_NO_TLD</literal></term>
<listitem><simpara> No top-level domain found in domain string.
</simpara></listitem>
</varlistentry>
<varlistentry id="TLD-NOTLD--CAPS" role="constant">
<term><literal>TLD_NOTLD</literal></term>
<listitem><simpara>
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-strerror" role="function">
<title>tld_strerror ()</title>
<indexterm zone="tld-strerror"><primary sortas="tld_strerror">tld_strerror</primary></indexterm><programlisting>const <link linkend="char">char</link> * tld_strerror (<link linkend="Tld-rc">Tld_rc</link> rc);</programlisting>
<para>
Convert a return code integer to a text string. This string can be
used to output a diagnostic message to the user.
</para>
<para>
TLD_SUCCESS: Successful operation. This value is guaranteed to
always be zero, the remaining ones are only guaranteed to hold
non-zero values, for logical comparison purposes.
TLD_INVALID: Invalid character found.
TLD_NODATA: No input data was provided.
TLD_MALLOC_ERROR: Error during memory allocation.
TLD_ICONV_ERROR: Error during iconv string conversion.
TLD_NO_TLD: No top-level domain found in domain string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rc</parameter> :</term>
<listitem><simpara> tld return code
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns a pointer to a statically allocated string
containing a description of the error with the return code <parameter>rc</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-get-4" role="function">
<title>tld_get_4 ()</title>
<indexterm zone="tld-get-4"><primary sortas="tld_get_4">tld_get_4</primary></indexterm><programlisting><link linkend="int">int</link> tld_get_4 (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> inlen,
<link linkend="char">char</link> **out);</programlisting>
<para>
Isolate the top-level domain of <parameter>in</parameter> and return it as an ASCII
string in <parameter>out</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Array of unicode code points to process. Does not need to be
zero terminated.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>inlen</parameter> :</term>
<listitem><simpara> Number of unicode code points.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> Zero terminated ascii result string pointer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Return <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> on success, or the corresponding
<link linkend="Tld-rc"><type>Tld_rc</type></link> error code otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-get-4z" role="function">
<title>tld_get_4z ()</title>
<indexterm zone="tld-get-4z"><primary sortas="tld_get_4z">tld_get_4z</primary></indexterm><programlisting><link linkend="int">int</link> tld_get_4z (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="char">char</link> **out);</programlisting>
<para>
Isolate the top-level domain of <parameter>in</parameter> and return it as an ASCII
string in <parameter>out</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Zero terminated array of unicode code points to process.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> Zero terminated ascii result string pointer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Return <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> on success, or the corresponding
<link linkend="Tld-rc"><type>Tld_rc</type></link> error code otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-get-z" role="function">
<title>tld_get_z ()</title>
<indexterm zone="tld-get-z"><primary sortas="tld_get_z">tld_get_z</primary></indexterm><programlisting><link linkend="int">int</link> tld_get_z (const <link linkend="char">char</link> *in,
<link linkend="char">char</link> **out);</programlisting>
<para>
Isolate the top-level domain of <parameter>in</parameter> and return it as an ASCII
string in <parameter>out</parameter>. The input string <parameter>in</parameter> may be UTF-8, ISO-8859-1 or
any ASCII compatible character encoding.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Zero terminated character array to process.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter> :</term>
<listitem><simpara> Zero terminated ascii result string pointer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Return <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> on success, or the corresponding
<link linkend="Tld-rc"><type>Tld_rc</type></link> error code otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-get-table" role="function">
<title>tld_get_table ()</title>
<indexterm zone="tld-get-table"><primary sortas="tld_get_table">tld_get_table</primary></indexterm><programlisting>const <link linkend="Tld-table">Tld_table</link> * tld_get_table (const <link linkend="char">char</link> *tld,
const <link linkend="Tld-table">Tld_table</link> **tables);</programlisting>
<para>
Get the TLD table for a named TLD by searching through the given
TLD table array.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tld</parameter> :</term>
<listitem><simpara> TLD name (e.g. "com") as zero terminated ASCII byte string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tables</parameter> :</term>
<listitem><simpara> Zero terminated array of <link linkend="Tld-table"><type>Tld_table</type></link> info-structures for
TLDs.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Return structure corresponding to TLD <parameter>tld</parameter> by going
thru <parameter>tables</parameter>, or return <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no such structure is found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-default-table" role="function">
<title>tld_default_table ()</title>
<indexterm zone="tld-default-table"><primary sortas="tld_default_table">tld_default_table</primary></indexterm><programlisting>const <link linkend="Tld-table">Tld_table</link> * tld_default_table (const <link linkend="char">char</link> *tld,
const <link linkend="Tld-table">Tld_table</link> **overrides);</programlisting>
<para>
Get the TLD table for a named TLD, using the internal defaults,
possibly overrided by the (optional) supplied tables.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tld</parameter> :</term>
<listitem><simpara> TLD name (e.g. "com") as zero terminated ASCII byte string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>overrides</parameter> :</term>
<listitem><simpara> Additional zero terminated array of <link linkend="Tld-table"><type>Tld_table</type></link>
info-structures for TLDs, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to only use library deault
tables.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Return structure corresponding to TLD <parameter>tld_str</parameter>, first
looking through <parameter>overrides</parameter> then thru built-in list, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if
no such structure found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-check-4t" role="function">
<title>tld_check_4t ()</title>
<indexterm zone="tld-check-4t"><primary sortas="tld_check_4t">tld_check_4t</primary></indexterm><programlisting><link linkend="int">int</link> tld_check_4t (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> inlen,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> *tld);</programlisting>
<para>
Test each of the code points in <parameter>in</parameter> for whether or not
they are allowed by the data structure in <parameter>tld</parameter>, return
the position of the first character for which this is not
the case in <parameter>errpos</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Array of unicode code points to process. Does not need to be
zero terminated.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>inlen</parameter> :</term>
<listitem><simpara> Number of unicode code points.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>errpos</parameter> :</term>
<listitem><simpara> Position of offending character is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tld</parameter> :</term>
<listitem><simpara> A <link linkend="Tld-table"><type>Tld_table</type></link> data structure representing the restrictions for
which the input should be tested.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns the <link linkend="Tld-rc"><type>Tld_rc</type></link> value <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> if all code
points are valid or when <parameter>tld</parameter> is null, <link linkend="TLD-INVALID--CAPS"><literal>TLD_INVALID</literal></link> if a
character is not allowed, or additional error codes on general
failure conditions.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-check-4tz" role="function">
<title>tld_check_4tz ()</title>
<indexterm zone="tld-check-4tz"><primary sortas="tld_check_4tz">tld_check_4tz</primary></indexterm><programlisting><link linkend="int">int</link> tld_check_4tz (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> *tld);</programlisting>
<para>
Test each of the code points in <parameter>in</parameter> for whether or not
they are allowed by the data structure in <parameter>tld</parameter>, return
the position of the first character for which this is not
the case in <parameter>errpos</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Zero terminated array of unicode code points to process.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>errpos</parameter> :</term>
<listitem><simpara> Position of offending character is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tld</parameter> :</term>
<listitem><simpara> A <link linkend="Tld-table"><type>Tld_table</type></link> data structure representing the restrictions for
which the input should be tested.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns the <link linkend="Tld-rc"><type>Tld_rc</type></link> value <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> if all code
points are valid or when <parameter>tld</parameter> is null, <link linkend="TLD-INVALID--CAPS"><literal>TLD_INVALID</literal></link> if a
character is not allowed, or additional error codes on general
failure conditions.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-check-4" role="function">
<title>tld_check_4 ()</title>
<indexterm zone="tld-check-4"><primary sortas="tld_check_4">tld_check_4</primary></indexterm><programlisting><link linkend="int">int</link> tld_check_4 (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> inlen,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);</programlisting>
<para>
Test each of the code points in <parameter>in</parameter> for whether or not they are
allowed by the information in <parameter>overrides</parameter> or by the built-in TLD
restriction data. When data for the same TLD is available both
internally and in <parameter>overrides</parameter>, the information in <parameter>overrides</parameter> takes
precedence. If several entries for a specific TLD are found, the
first one is used. If <parameter>overrides</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, only the built-in
information is used. The position of the first offending character
is returned in <parameter>errpos</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Array of unicode code points to process. Does not need to be
zero terminated.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>inlen</parameter> :</term>
<listitem><simpara> Number of unicode code points.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>errpos</parameter> :</term>
<listitem><simpara> Position of offending character is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>overrides</parameter> :</term>
<listitem><simpara> A <link linkend="Tld-table"><type>Tld_table</type></link> array of additional domain restriction
structures that complement and supersede the built-in information.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns the <link linkend="Tld-rc"><type>Tld_rc</type></link> value <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> if all code
points are valid or when <parameter>tld</parameter> is null, <link linkend="TLD-INVALID--CAPS"><literal>TLD_INVALID</literal></link> if a
character is not allowed, or additional error codes on general
failure conditions.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-check-4z" role="function">
<title>tld_check_4z ()</title>
<indexterm zone="tld-check-4z"><primary sortas="tld_check_4z">tld_check_4z</primary></indexterm><programlisting><link linkend="int">int</link> tld_check_4z (const <link linkend="uint32-t">uint32_t</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);</programlisting>
<para>
Test each of the code points in <parameter>in</parameter> for whether or not they are
allowed by the information in <parameter>overrides</parameter> or by the built-in TLD
restriction data. When data for the same TLD is available both
internally and in <parameter>overrides</parameter>, the information in <parameter>overrides</parameter> takes
precedence. If several entries for a specific TLD are found, the
first one is used. If <parameter>overrides</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, only the built-in
information is used. The position of the first offending character
is returned in <parameter>errpos</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Zero-terminated array of unicode code points to process.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>errpos</parameter> :</term>
<listitem><simpara> Position of offending character is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>overrides</parameter> :</term>
<listitem><simpara> A <link linkend="Tld-table"><type>Tld_table</type></link> array of additional domain restriction
structures that complement and supersede the built-in information.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns the <link linkend="Tld-rc"><type>Tld_rc</type></link> value <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> if all code
points are valid or when <parameter>tld</parameter> is null, <link linkend="TLD-INVALID--CAPS"><literal>TLD_INVALID</literal></link> if a
character is not allowed, or additional error codes on general
failure conditions.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-check-8z" role="function">
<title>tld_check_8z ()</title>
<indexterm zone="tld-check-8z"><primary sortas="tld_check_8z">tld_check_8z</primary></indexterm><programlisting><link linkend="int">int</link> tld_check_8z (const <link linkend="char">char</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);</programlisting>
<para>
Test each of the characters in <parameter>in</parameter> for whether or not they are
allowed by the information in <parameter>overrides</parameter> or by the built-in TLD
restriction data. When data for the same TLD is available both
internally and in <parameter>overrides</parameter>, the information in <parameter>overrides</parameter> takes
precedence. If several entries for a specific TLD are found, the
first one is used. If <parameter>overrides</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, only the built-in
information is used. The position of the first offending character
is returned in <parameter>errpos</parameter>. Note that the error position refers to the
decoded character offset rather than the byte position in the
string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Zero-terminated UTF8 string to process.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>errpos</parameter> :</term>
<listitem><simpara> Position of offending character is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>overrides</parameter> :</term>
<listitem><simpara> A <link linkend="Tld-table"><type>Tld_table</type></link> array of additional domain restriction
structures that complement and supersede the built-in information.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns the <link linkend="Tld-rc"><type>Tld_rc</type></link> value <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> if all
characters are valid or when <parameter>tld</parameter> is null, <link linkend="TLD-INVALID--CAPS"><literal>TLD_INVALID</literal></link> if a
character is not allowed, or additional error codes on general
failure conditions.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tld-check-lz" role="function">
<title>tld_check_lz ()</title>
<indexterm zone="tld-check-lz"><primary sortas="tld_check_lz">tld_check_lz</primary></indexterm><programlisting><link linkend="int">int</link> tld_check_lz (const <link linkend="char">char</link> *in,
<link linkend="size-t">size_t</link> *errpos,
const <link linkend="Tld-table">Tld_table</link> **overrides);</programlisting>
<para>
Test each of the characters in <parameter>in</parameter> for whether or not they are
allowed by the information in <parameter>overrides</parameter> or by the built-in TLD
restriction data. When data for the same TLD is available both
internally and in <parameter>overrides</parameter>, the information in <parameter>overrides</parameter> takes
precedence. If several entries for a specific TLD are found, the
first one is used. If <parameter>overrides</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, only the built-in
information is used. The position of the first offending character
is returned in <parameter>errpos</parameter>. Note that the error position refers to the
decoded character offset rather than the byte position in the
string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>in</parameter> :</term>
<listitem><simpara> Zero-terminated string in the current locales encoding to process.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>errpos</parameter> :</term>
<listitem><simpara> Position of offending character is returned here.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>overrides</parameter> :</term>
<listitem><simpara> A <link linkend="Tld-table"><type>Tld_table</type></link> array of additional domain restriction
structures that complement and supersede the built-in information.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Returns the <link linkend="Tld-rc"><type>Tld_rc</type></link> value <link linkend="TLD-SUCCESS--CAPS"><literal>TLD_SUCCESS</literal></link> if all
characters are valid or when <parameter>tld</parameter> is null, <link linkend="TLD-INVALID--CAPS"><literal>TLD_INVALID</literal></link> if a
character is not allowed, or additional error codes on general
failure conditions.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
