.\" 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_get_property" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_get_property \- 


.SH SYNOPSIS
\fBMTextProperty\fP*
\fBmtext_get_property\fP (\fBMText\fP *
\fImt\fP, int
\fIpos\fP, MSymbol
\fIkey\fP)


.SH DESCRIPTION
.PP
Get the topmost text property\&. The
.ft B
mtext_get_property()
.ft R
function searches the character at position
.ft B
pos
.ft R
in M\-text
.ft B
mt
.ft R
for a text property whose key is
.ft B
key\fP\&.
.PP
.SH RETURN VALUE
.PP
.RS 4
If a text property is found,
.ft B
mtext_get_property()
.ft R
returns it\&. If there are multiple text properties, it returns the topmost one\&. If no such property is found, it returns
.ft C
NULL
.ft R
without changing the external variable
.ft B
merror_code\fP\&.
.RE
.PP
If an error is detected,
.ft B
mtext_get_property()
.ft R
returns
.ft C
NULL
.ft R
and assigns an error code to the external variable
.ft B
merror_code\fP\&. 
.br
 
.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>.