.\" 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" "9" "09 October 2005" "" ""

.SH NAME
ntfs_collate \- collate two data items using a specified collation rule
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int ntfs_collate  (ntfs_volume * \fIvol\fB, COLLATION_RULE \fIcr\fB, const void * \fIdata1\fB, const int \fIdata1_len\fB, const void * \fIdata2\fB, const int \fIdata2_len\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIvol\fB\fR
ntfs volume to which the data items belong
.TP
\fB\fIcr\fB\fR
collation rule to use when comparing the items
.TP
\fB\fIdata1\fB\fR
first data item to collate
.TP
\fB\fIdata1_len\fB\fR
length in bytes of \fIdata1\fR
.TP
\fB\fIdata2\fB\fR
second data item to collate
.TP
\fB\fIdata2_len\fB\fR
length in bytes of \fIdata2\fR
.SH "DESCRIPTION"
.PP
Collate the two data items \fIdata1\fR and \fIdata2\fR using the collation rule \fIcr\fR
and return -1, 0, ir 1 if \fIdata1\fR is found, respectively, to collate before,
to match, or to collate after \fIdata2\fR\&.
.PP
For speed we use the collation rule \fIcr\fR as an index into two tables of
function pointers to call the appropriate collation function.