.\" 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 "mface_get_prop" 3m17n "14 Jul 2007" "" "Version 1.4.0" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mface_get_prop - Get the value of a face property. 


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


.SH DESCRIPTION
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 R
.ft B
key
.ft R
must be one of the followings:
.PP
.SS Mforeground\fP,
.ft R
.ft B
Mbackground\fP,
.ft R
.ft B
Mvideomode\fP,
.ft R
.ft B
Mhline\fP,
.ft R
.ft B
Mbox\fP,
.ft R
.ft B
Mfoundry\fP,
.ft R
.ft B
Mfamily\fP,
.ft R
.ft B
Mweight\fP,
.ft R
.ft B
Mstyle\fP,
.ft R
.ft B
Mstretch\fP,
.ft R
.ft B
Madstyle\fP,
.ft R
.ft B
Msize\fP,
.ft R
.ft B
Mfontset\fP,
.ft R
.ft B
Mratio\fP,
.ft R
.ft B
Mhook_func\fP,
.ft R
.ft B
Mhook_ar
.PP
.SH RETURN VALUE
.PP.RS 4
The actual type of the returned value depends of
.ft B
key\fP.
.ft R
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.
.ft R
.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
.RE
.PP