tld_check_4.3   [plain text]


.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "tld_check_4" 3 "0.6.14" "libidn" "libidn"
.SH NAME
tld_check_4 \- verify that characters are permitted
.SH SYNOPSIS
.B #include <tld.h>
.sp
.BI "int tld_check_4(const uint32_t * " in ", size_t " inlen ", size_t * " errpos ", const Tld_table ** " overrides ");"
.SH ARGUMENTS
.IP "const uint32_t * in" 12
Array of unicode code points to process. Does not need to be
zero terminated.
.IP "size_t inlen" 12
Number of unicode code points.
.IP "size_t * errpos" 12
Position of offending character is returned here.
.IP "const Tld_table ** overrides" 12
A \fBTld_table\fP array of additional domain restriction
structures that complement and supersede the built-in information.
.SH "DESCRIPTION"
Test each of the code points in \fIin\fP for whether or not they are
allowed by the information in \fIoverrides\fP or by the built\-in TLD
restriction data. When data for the same TLD is available both
internally and in \fIoverrides\fP, the information in \fIoverrides\fP takes
precedence. If several entries for a specific TLD are found, the
first one is used.  If \fIoverrides\fP is \fBNULL\fP, only the built\-in
information is used.  The position of the first offending character
is returned in \fIerrpos\fP.
.SH "RETURN VALUE"
Returns the \fBTld_rc\fP value \fBTLD_SUCCESS\fP if all code
points are valid or when \fItld\fP is null, \fBTLD_INVALID\fP if a
character is not allowed, or additional error codes on general
failure conditions.
.SH "REPORTING BUGS"
Report bugs to <bug-libidn@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2002, 2003, 2004, 2005, 2006, 2007 Simon Josefsson.
.br
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
.SH "SEE ALSO"
The full documentation for
.B libidn
is maintained as a Texinfo manual.  If the
.B info
and
.B libidn
programs are properly installed at your site, the command
.IP
.B info libidn
.PP
should give you access to the complete manual.