.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "NTFS_COLLATE_NAMES" "9" "09 October 2005" "" ""

.SH NAME
ntfs_collate_names \- collate two Unicode names
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int ntfs_collate_names  (const ntfschar * \fIname1\fB, const u32 \fIname1_len\fB, const ntfschar * \fIname2\fB, const u32 \fIname2_len\fB, const int \fIerr_val\fB, const IGNORE_CASE_BOOL \fIic\fB, const ntfschar * \fIupcase\fB, const u32 \fIupcase_len\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIname1\fB\fR
first Unicode name to compare
.TP
\fB\fIname1_len\fB\fR
-- undescribed --
.TP
\fB\fIname2\fB\fR
second Unicode name to compare
.TP
\fB\fIname2_len\fB\fR
-- undescribed --
.TP
\fB\fIerr_val\fB\fR
if \fIname1\fR contains an invalid character return this value
.TP
\fB\fIic\fB\fR
either CASE_SENSITIVE or IGNORE_CASE
.TP
\fB\fIupcase\fB\fR
upcase table (ignored if \fIic\fR is CASE_SENSITIVE)
.TP
\fB\fIupcase_len\fB\fR
upcase table size (ignored if \fIic\fR is CASE_SENSITIVE)
.SH "NTFS_COLLATE_NAMES COLLATES TWO UNICODE NAMES AND RETURNS"
.PP
.PP
-1 if the first name collates before the second one,
0 if the names match,
1 if the second name collates before the first one, or
\fIerr_val\fR if an invalid character is found in \fIname1\fR during the comparison.
.SH "THE FOLLOWING CHARACTERS ARE CONSIDERED INVALID"
.PP
'"', '*', '<\&', '>\&' and '?'.