.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2009
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mtext_coll" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_coll \- Compare two M\-texts using the current locale. 


.SH SYNOPSIS
int
\fBmtext_coll\fP (\fBMText\fP *
\fImt1\fP, \fBMText\fP *
\fImt2\fP)


.SH DESCRIPTION
Compare two M\-texts using the current locale. 
.PP
The
.ft B
mtext_coll()
.ft R
function compares the two M\-texts
.ft B
mt1
.ft R
and
.ft B
mt2\fP.
.ft R
It returns an integer less than, equal to, or greater than zero if
.ft B
mt1
.ft R
is found, respectively, to be less than, to match, or to be greater than
.ft B
mt2\fP.
.ft R
The comparison is based on texts as appropriate for the current locale (LC_COLLATE).
.PP
This function makes use of information that is automatically cached in the M\-texts as a text property. So, the second call of this function with
.ft B
mt1
.ft R
or
.ft B
mt2
.ft R
finishes faster than the first call. 
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2009 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.
