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


.SH SYNOPSIS
void*
\fBmfont_get_prop\fP (\fBMFont\fP *
\fIfont\fP, \fBMSymbol\fP
\fIkey\fP)


.SH DESCRIPTION
The
.ft B
mfont_get_prop()
.ft R
function gets the value of
.ft B
key
.ft R
property of font
.ft B
font\fP.
.ft R
.ft B
key
.ft R
must be one of the following symbols:
.PP
\fCMfoundry\fP,
.ft R
.ft C
Mfamily\fP,
.ft R
.ft C
Mweight\fP,
.ft R
.ft C
Mstyle\fP,
.ft R
.ft C
Mstretch\fP,
.ft R
.ft C
Madstyle\fP,
.ft R
.ft C
Mregistry\fP,
.ft R
.ft C
Msize\fP,
.ft R
.ft C
Mresolution\fP,
.ft R
.ft C
Mspacing\fP.
.ft R
.PP
If
.ft B
font
.ft R
is a return value of
.ft B
mfont_find()\fP,
.ft R
.ft B
key
.ft R
can also be one of the following symbols:
.PP
.SS Mfont_ascent\fP,
.ft R
.ft B
Mfont_descent\fP,
.ft R
.ft B
Mmax_advanc.
.PP
.SS Return value: If
.ft B
key
.ft R
is
.ft C
Mfoundry\fP,
.ft R
.ft C
Mfamily\fP,
.ft R
.ft C
Mweight\fP,
.ft R
.ft C
Mstyle\fP.RS 4
\fCMstretch\fP,
.ft R
.ft C
Madstyle\fP,
.ft R
.ft C
Mregistry\fP,
.ft R
or
.ft C
Mspacing\fP,
.ft R
this function returns the corresponding value as a symbol. If the font does not have
.ft B
key
.ft R
property, it returns
.ft C
Mnil\fP.
.ft R
If
.ft B
key
.ft R
is
.ft C
Msize\fP,
.ft R
.ft C
Mresolution\fP,
.ft R
.ft B
Mfont_ascent\fP,
.ft R
Mfont_descent, or
.ft B
Mmax_advance\fP,
.ft R
this function returns the corresponding value as an integer. If the font does not have
.ft B
key
.ft R
property, it returns 0. If
.ft B
key
.ft R
is something else, 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