.\" 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_get_properties" 3m17n "14 Jul 2007" "" "Version 1.4.0" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_get_properties - Get multiple text properties. 


.SH SYNOPSIS
int
\fBmtext_get_properties\fP (\fBMText\fP *
\fImt\fP, int
\fIpos\fP, \fBMSymbol\fP
\fIkey\fP, \fBMTextProperty\fP **
\fIprops\fP, int
\fInum\fP)


.SH DESCRIPTION
The
.ft B
mtext_get_properties()
.ft R
function searches the character at
.ft B
pos
.ft R
in M-text
.ft B
mt
.ft R
for properties whose key is
.ft B
key\fP.
.ft R
If such properties are found, they are stored in the memory area pointed to by
.ft B
props\fP.
.ft R
.ft B
num
.ft R
limits the maximum number of stored properties.
.PP
.SH RETURN VALUE
.PP.RS 4
If the operation was successful,
.ft B
mtext_get_properties()
.ft R
returns the number of actually stored properties. If the character at
.ft B
pos
.ft R
does not have a property whose key is
.ft B
key\fP,
.ft R
the return value is 0. If an error is detected,
.ft B
mtext_get_properties()
.ft R
returns -1 and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP