'\" t
.\" FetchSet.sgm /main/9 1996/09/08 21:25:15 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "MrmFetchSetValues" 3
.SH "NAME"
\fBMrmFetchSetValues\fP \(em Fetches the values to be set from literals stored in
UID files
"MrmFetchSetValues"
"uil functions" "MrmFetchSetValues"
.SH "SYNOPSIS"
.PP
.nf
#include <Mrm/MrmPublic\&.h>
\fBCardinal \fBMrmFetchSetValues\fP\fR(
\fBMrmHierarchy \fBhierarchy_id\fR\fR,
\fBWidget \fBwidget\fR\fR,
\fBArgList \fBargs\fR\fR,
\fBCardinal \fBnum_args\fR\fR);
.fi
"MRM function" "MrmFetchSetValues"
"MrmFetchSetValues" "definition"
.SH "DESCRIPTION"
.PP
The
\fBMrmFetchSetValues\fP
function
is similar to
\fBXtSetValues\fP,
except that the values to be set are defined by the UIL named
values that are stored in the UID hierarchy\&.
"MrmFetchSetValues" "description"
\fBMrmFetchSetValues\fP
fetches the values to be set from literals stored in UID files\&.
.IP "\fIhierarchy_id\fP" 10
Specifies the ID of the UID hierarchy that contains the
specified literal\&.
The value of \fIhierarchy_id\fP
was returned in a previous call to \fBMrmOpenHierarchyPerDisplay\fP\&.
.IP "\fIwidget\fP" 10
Specifies the widget that is modified\&.
.IP "\fIargs\fP" 10
Specifies an argument list that identifies the widget arguments to be
modified as well as the index (UIL name) of the literal that
defines the value for that argument\&.
The name part of each argument (\fIargs[n]\&.name\fP) must begin with the string
\fBXmN\fP followed by the name that uniquely identifies this attribute tag\&.
For example, \fBXmNwidth\fP
is the attribute name associated with the core argument \fIwidth\fP\&.
The value part (\fIargs[n]\&.value\fP) must be a string
that gives the index (UIL name) of the literal\&.
You must define all literals in UIL as exported values\&.
.IP "\fInum_args\fP" 10
Specifies the number of entries in \fIargs\fP\&.
.PP
This function
sets the values
on a widget, evaluating the
values as public literal resource references resolvable from
a UID hierarchy\&.
Each literal is fetched from the hierarchy, and
its value is modified and converted as required\&.
This value is
then placed in the argument list and used as the actual value for an
\fBXtSetValues\fP
call\&.
\fBMrmFetchSetValues\fP
allows a widget to be modified
after creation using UID file values the same way
creation values are used in \fBMrmFetchWidget\fP\&.
.PP
As in
\fBMrmFetchWidget\fP,
each argument whose value can be evaluated
from
the UID hierarchy is set in the widget\&.
Values that are not
found
or values in which conversion errors occur are not modified\&.
.PP
Each entry in the argument list identifies an argument to be modified
in the widget\&.
The name part identifies the tag, which begins with
\fBXmN\fP\&.
The value part must be a string
whose value is the index of
the literal\&.
Thus, the following code would modify the label resource of the widget
to have the value of the literal accessed by the index
\fBOK_button_label\fP in the hierarchy:
.PP
.nf
\f(CWargs[n]\&.name = XmNlabel;
args[n]\&.value = "OK_button_label";\fR
.fi
.PP
.SH "RETURN VALUE"
"MrmSUCCESS"
"MrmPARTIAL_SUCCESS"
"MrmBAD_HIERARCHY"
"MrmFAILURE"
.PP
This function returns one of the following status return constants:
.IP "\fBMrmSUCCESS\fP" 10
The function executed successfully\&.
.IP "\fBMrmPARTIAL_SUCCESS\fP" 10
At least one literal was successfully fetched\&.
.IP "\fBMrmBAD_HIERARCHY\fP" 10
The hierarchy ID was invalid\&.
.IP "\fBMrmFAILURE\fP" 10
The function failed\&.
.SH "RELATED"
.PP
\fBMrmOpenHierarchyPerDisplay\fP(3),
\fBXtSetValues\fP(3)\&.
.\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:16