.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   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_character" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_character \- 


.SH SYNOPSIS
int
\fBmtext_character\fP (\fBMText\fP *
\fImt\fP, int
\fIfrom\fP, int
\fIto\fP, int
\fIc\fP)


.SH DESCRIPTION
.PP
Search a character in an M\-text\&. The
.ft B
mtext_character()
.ft R
function searches M\-text
.ft B
mt
.ft R
for character
.ft B
c\fP\&. If
.ft B
from
.ft R
is less than
.ft B
to\fP,
.ft R
the search begins at position
.ft B
from
.ft R
and goes forward but does not exceed (\fBto
.ft R
\- 1)\&. Otherwise, the search begins at position (\fBfrom
.ft R
\- 1) and goes backward but does not exceed
.ft B
to\fP\&. An invalid position specification is regarded as both
.ft B
from
.ft R
and
.ft B
to
.ft R
being 0\&.
.PP
.SH RETURN VALUE
.PP
.RS 4
If
.ft B
c
.ft R
is found,
.ft B
mtext_character()
.ft R
returns the position of its first occurrence\&. Otherwise it returns \-1 without changing the external variable
.ft B
merror_code\fP\&. If an error is detected, it returns \-1 and assigns an error code to the external variable
.ft B
merror_code\fP\&. 
.br
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmtext_chr()\fP,
.ft R
.ft B
mtext_rchr()
.ft R
.br
 
.RE
.PP

.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 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>.