<!-- $XConsortium: FetchIco.sgm /main/11 1996/09/24 15:57:52 cdedoc $ -->
<!-- (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.MAN10.rsml.1">
<RefMeta>
<RefEntryTitle>MrmFetchIconLiteral</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>MrmFetchIconLiteral</Function></RefName>
<RefPurpose>Fetches an icon literal from a hierarchy
<IndexTerm>
<Primary>MrmFetchIconLiteral</Primary>
</IndexTerm><IndexTerm>
<Primary>uil functions</Primary>
<Secondary>MrmFetchIconLiteral</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;Mrm/MrmPublic.h>
</FuncSynopsisInfo>
<FuncDef>Cardinal <Function>MrmFetchIconLiteral</Function></FuncDef>
<!--<ParamDef><Replaceable>hierarchy_id, index, screen, display, fgpix, bgpix, pixmap</Replaceable></ParamDef>-->
<ParamDef>MrmHierarchy <Parameter>hierarchy_id</Parameter></ParamDef>
<ParamDef>String <Parameter>index</Parameter></ParamDef>
<ParamDef>Screen *<Parameter>screen</Parameter></ParamDef>
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
<ParamDef>Pixel <Parameter>fgpix</Parameter></ParamDef>
<ParamDef>Pixel <Parameter>bgpix</Parameter></ParamDef>
<ParamDef>Pixmap *<Parameter>pixmap</Parameter></ParamDef>
</FuncSynopsis><IndexTerm>
<Primary>MRM function</Primary>
<Secondary>MrmFetchIconLiteral</Secondary>
</IndexTerm><IndexTerm>
<Primary>MrmFetchIconLiteral</Primary>
<Secondary>definition</Secondary>
</IndexTerm>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>MrmFetchIconLiteral</Function>
function<IndexTerm>
<Primary>MrmFetchIconLiteral</Primary>
<Secondary>description</Secondary>
</IndexTerm>
fetches an icon literal from an MRM hierarchy and converts the
icon literal to an X pixmap.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">hierarchy_id</Symbol></Term>
<ListItem>
<Para>Specifies the ID of the UID hierarchy that contains the
specified icon literal.
The <Symbol Role="Variable">hierarchy_id</Symbol> was returned in a previous call to
<Function>MrmOpenHierarchyPerDisplay</Function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">index</Symbol></Term>
<ListItem>
<Para>Specifies the UIL name of the icon literal to fetch.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">screen</Symbol></Term>
<ListItem>
<Para>Specifies the screen used for the pixmap.
The
<Symbol Role="Variable">screen</Symbol>
argument specifies a pointer to the
Xlib structure
<StructName Role="typedef">Screen</StructName>,
which contains the information about that screen and is linked to the
<StructName Role="typedef">Display</StructName>
structure.
For more information on the
<StructName Role="typedef">Display</StructName>
and
<StructName Role="typedef">Screen</StructName>
structures, see the Xlib function
<Function>XOpenDisplay</Function>
and the associated screen information macros.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">display</Symbol></Term>
<ListItem>
<Para>Specifies the display used for the pixmap.
The
<Symbol Role="Variable">display</Symbol>
argument specifies the connection to the X server.
For more information on the
<StructName Role="typedef">Display</StructName> structure, see the Xlib function
<Function>XOpenDisplay</Function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">fgpix</Symbol></Term>
<ListItem>
<Para>Specifies the foreground color for the pixmap.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">bgpix</Symbol></Term>
<ListItem>
<Para>Specifies the background color for the pixmap.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">pixmap</Symbol></Term>
<ListItem>
<Para>Returns the resulting X pixmap value.
The function allocates space for this pixmap.
The application is responsible for managing the allocated space.
The application can recover the allocated space by calling <Function>XmDestroyPixmap</Function>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<IndexTerm>
<Primary>MrmSUCCESS</Primary>
</IndexTerm><IndexTerm>
<Primary>MrmBAD_HIERARCHY</Primary>
</IndexTerm><IndexTerm>
<Primary>MrmNOT_FOUND</Primary>
</IndexTerm><IndexTerm>
<Primary>MrmFAILURE</Primary>
</IndexTerm>
<Para>This function returns one of the following status return constants:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="Constant">MrmSUCCESS</SystemItem></Term>
<ListItem>
<Para>The function executed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">MrmBAD_HIERARCHY</SystemItem></Term>
<ListItem>
<Para>The hierarchy ID was invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">MrmNOT_FOUND</SystemItem></Term>
<ListItem>
<Para>The icon literal was not found in the hierarchy.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">MrmWRONG_TYPE</SystemItem></Term>
<ListItem>
<Para>The caller tried to fetch a literal of a type not supported by this
function.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">MrmFAILURE</SystemItem></Term>
<ListItem>
<Para>The function failed.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.MrmFetchBitmapLiteral;,
&cdeman.MrmOpenHierarchyPerDisplay;,
&cdeman.MrmFetchLiteral;,
&cdeman.MrmFetchColorLiteral;, and
<Filename MoreInfo="RefEntry">XOpenDisplay</Filename>(3).
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
