.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "tld_check_lz" 3 "1.42" "libidn" "libidn"
.SH NAME
tld_check_lz \- API function
.SH SYNOPSIS
.B #include <tld.h>
.sp
.BI "int tld_check_lz(const char * " in ", size_t * " errpos ", const Tld_table ** " overrides ");"
.SH ARGUMENTS
.IP "const char * in" 12
Zero\-terminated string in the current locales encoding to process.
.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 characters 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 .  Note that the error position refers to the
decoded character offset rather than the byte position in the
string.

Return value: Returns the \fBTld_rc\fP value \fBTLD_SUCCESS\fP if all
characters 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 <help-libidn@gnu.org>.
.br
General guidelines for reporting bugs: https://www.gnu.org/gethelp/
.br
GNU Libidn home page: https://www.gnu.org/software/libidn/

.SH COPYRIGHT
Copyright \(co 2002-2024 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.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.
As an alternative you may obtain the manual from:
.IP
.B https://www.gnu.org/software/libidn/manual/
.PP