.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2003
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file si aprt 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, Front-Cover Texts "The m17n library documentation",
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mtext_push_prop" 3m17n "14 Jul 2007" "" "Version 1.4.0" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_push_prop - Push a text property. 


.SH SYNOPSIS
int
\fBmtext_push_prop\fP (\fBMText\fP *
\fImt\fP, int
\fIfrom\fP, int
\fIto\fP, \fBMSymbol\fP
\fIkey\fP, void *
\fIval\fP)


.SH DESCRIPTION
The
.ft B
mtext_push_prop()
.ft R
function pushes a text property whose key is
.ft B
key
.ft R
and value is
.ft B
val
.ft R
to the characters between
.ft B
from
.ft R
(inclusive) and
.ft B
to
.ft R
(exclusive) in M-text
.ft B
mt\fP.
.ft R
With this function,
.PP
.PP
.nf

                    FROM                    TO
M-text: |<------------|-------- MT ---------|------------>|
PROP  :  <------------------ OLD_VAL -------------------->
.fi
.fi
.PP
becomes
.PP
.PP
.nf

                    FROM                    TO
M-text: |<------------|-------- MT ---------|------------>|
PROP  :  <------------------- OLD_VAL ------------------->
PROP  :               <-------- VAL ------->
.fi
.fi
.PP
.SH RETURN VALUE
.PP.RS 4
If the operation was successful,
.ft B
mtext_push_prop()
.ft R
returns 0. Otherwise it returns -1 and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP
.SH ERRORS
.PP.RS 4
\fCMERROR_RANGE\fP,
.ft R
.ft C
MERROR_SYMBOL
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP.RS 4
\fBmtext_put_prop()\fP,
.ft R
.ft B
mtext_put_prop_values()\fP,
.ft R
.ft B
mtext_get_prop()\fP,
.ft R
.ft B
mtext_get_prop_values()\fP,
.ft R
.ft B
mtext_pop_prop()\fP,
.ft R
.ft B
mtext_prop_range()
.ft R
.RE
.PP