tld_check_4tz.3   [plain text]


.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "tld_check_4tz" 3 "0.6.14" "libidn" "libidn"
.SH NAME
tld_check_4tz \- verify that characters are permitted
.SH SYNOPSIS
.B #include <tld.h>
.sp
.BI "int tld_check_4tz(const uint32_t * " in ", size_t * " errpos ", const Tld_table * " tld ");"
.SH ARGUMENTS
.IP "const uint32_t * in" 12
Zero terminated array of unicode code points to process.
.IP "size_t * errpos" 12
Position of offending character is returned here.
.IP "const Tld_table * tld" 12
A \fBTld_table\fP data structure representing the restrictions for
which the input should be tested.
.SH "DESCRIPTION"
Test each of the code points in \fIin\fP for whether or not
they are allowed by the data structure in \fItld\fP, return
the position of the first character for which this is not
the case 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.