<!-- $XConsortium: FontLstM.sgm /main/9 1996/09/08 20:43:58 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN234.rsml.1">
<RefMeta>
<RefEntryTitle>XmFontListEntryGetFont</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmFontListEntryGetFont</Function></RefName>
<RefPurpose>A font list function
that retrieves font information from a font list entry
<IndexTerm>
<Primary>XmFontListEntryGetFont</Primary>
</IndexTerm><IndexTerm>
<Primary>font list functions</Primary>
<Secondary>XmFontListEntryGetFont</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>XtPointer <Function>XmFontListEntryGetFont</Function></FuncDef>
<!--<ParamDef><Replaceable>entry, type_return</Replaceable></ParamDef>-->
<ParamDef>XmFontListEntry <Parameter>entry</Parameter></ParamDef>
<ParamDef>XmFontType *<Parameter>type_return</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmFontListEntryGetFont</Function> retrieves font information for a
specified font list entry. If the font list entry contains
a font, <Symbol Role="Variable">type_return</Symbol> returns <SystemItem Class="Constant">XmFONT_IS_FONT</SystemItem> and the
function returns a pointer to an <Symbol>XFontStruct</Symbol>. If the font list
entry contains a font set, <Symbol Role="Variable">type_return</Symbol> returns
<SystemItem Class="Constant">XmFONT_IS_FONTSET</SystemItem> and the function returns the <Symbol>XFontSet</Symbol>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">entry</Symbol></Term>
<ListItem>
<Para>Specifies the font list entry.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">type_return</Symbol></Term>
<ListItem>
<Para>Specifies a pointer to the type of the font element for the current
entry. Valid values are <SystemItem Class="Constant">XmFONT_IS_FONT</SystemItem> and
<SystemItem Class="Constant">XmFONT_IS_FONTSET</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The returned <Symbol>XFontSet</Symbol> or <Symbol>XFontStruct</Symbol> is not a copy of the
toolkit data and must not be freed.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns an <Symbol>XFontSet</Symbol> or a pointer to an <Symbol>XFontStruct</Symbol> structure.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmFontList;,
&cdeman.XmFontListEntryCreate;,
&cdeman.XmFontListEntryGetTag;
&cdeman.XmFontListEntryLoad;, and
&cdeman.XmFontListNextEntry;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
