<!-- $XConsortium: FetchWiB.sgm /main/10 1996/09/08 21:25:30 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.MAN14.rsml.1">
<RefMeta>
<RefEntryTitle>MrmFetchWidgetOverride</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>MrmFetchWidgetOverride</Function></RefName>
<RefPurpose>Fetches any indexed (UIL named) application widget.  It overrides the arguments specified for this application widget in UIL
<IndexTerm>
<Primary>MrmFetchWidgetOverride</Primary>
</IndexTerm><IndexTerm>
<Primary>uil functions</Primary>
<Secondary>MrmFetchWidgetOverride</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>MrmFetchWidgetOverride</Function></FuncDef>
<!--<ParamDef><Replaceable>hierarchy_id, index, parent_widget,
override_name, override_args, override_num_args, widget, class</Replaceable></ParamDef>-->
<ParamDef>MrmHierarchy <Parameter>hierarchy_id</Parameter></ParamDef>
<ParamDef>String <Parameter>index</Parameter></ParamDef>
<ParamDef>Widget <Parameter>parent_widget</Parameter></ParamDef>
<ParamDef>String <Parameter>override_name</Parameter></ParamDef>
<ParamDef>ArgList <Parameter>override_args</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>override_num_args</Parameter></ParamDef>
<ParamDef>Widget *<Parameter>widget</Parameter></ParamDef>
<ParamDef>MrmType *<Parameter>class</Parameter></ParamDef>
</FuncSynopsis><IndexTerm>
<Primary>MRM function</Primary>
<Secondary>MrmFetchWidgetOverride</Secondary>
</IndexTerm><IndexTerm>
<Primary>MrmFetchWidgetOverride</Primary>
<Secondary>definition</Secondary>
</IndexTerm>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The <Function>MrmFetchWidgetOverride</Function> function<IndexTerm>
<Primary>MrmFetchWidgetOverride</Primary>
<Secondary>description</Secondary>
</IndexTerm>
is the extended version of <Function>MrmFetchWidget</Function>.
It is identical to <Function>MrmFetchWidget</Function>, except that it
allows the caller to override the widget's name and any
arguments that <Function>MrmFetchWidget</Function>
would otherwise retrieve from the UID file or
one of the defaulting mechanisms.
That is, the override argument list is not
limited to those arguments in the UID file.
</Para>
<Para>The override arguments apply only to the widget fetched and
returned
by this function.
Its children (subtree) do not receive any
override
parameters.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">hierarchy_id</Symbol></Term>
<ListItem>
<Para>Specifies the ID of the UID hierarchy that contains
the interface definition.
The value of <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 widget to fetch.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">parent_widget</Symbol></Term>
<ListItem>
<Para>Specifies the parent widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">override_name</Symbol></Term>
<ListItem>
<Para>Specifies the name to override the widget name.
Use a NULL value if you do not want to override the widget name.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">override_args</Symbol></Term>
<ListItem>
<Para>Specifies the override argument list, exactly as given to
<Function>XtCreateWidget</Function>
(conversion complete and so forth).
Use a
NULL value if you do not want to override the argument list.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">override_num_args</Symbol></Term>
<ListItem>
<Para>Specifies the number of arguments in
<Symbol Role="Variable">override_args</Symbol>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Returns the widget ID of the created widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">class</Symbol></Term>
<ListItem>
<Para>Returns the class code identifying MRM's widget class.
Literals identifying MRM widget class codes are defined in
the include file <Filename>Mrm/MrmPublic.h</Filename>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</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 widget was not found in UID hierarchy.
</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.MrmOpenHierarchyPerDisplay;,
&cdeman.MrmFetchWidget;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
