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


.SH SYNOPSIS
void*
\fBmface_get_prop\fP (\fBMFace\fP *
\fIface\fP, MSymbol
\fIkey\fP)


.SH DESCRIPTION
.PP
Get the value of a face property\&. The
.ft B
mface_get_prop()
.ft R
function returns the value of the face property whose key is
.ft B
key
.ft R
in face
.ft B
face\fP\&.
.ft B
key
.ft R
must be one of the followings: 
.PP
.nf
#Mforeground, #Mbackground, #Mvideomode, #Mhline, #Mbox,
#Mfoundry, #Mfamily, #Mweight, #Mstyle, #Mstretch, #Madstyle,
#Msize, #Mfontset, #Mratio, #Mhook_func, #Mhook_arg

.fi
.fi
 
.PP
.SH RETURN VALUE
.PP
.RS 4
The actual type of the returned value depends of
.ft B
key\fP\&. See documentation of the above keys\&. If an error is detected, it returns
.ft C
NULL
.ft R
and assigns an error code to the external variable
.ft B
merror_code\fP\&. 
.br
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmface_put_prop()\fP,
.ft R
.ft B
mface_put_hook()
.ft R
.RE
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_FACE
.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>.