'\" t
.\" RegisteC.sgm /main/8 1996/09/08 21:26:23 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 "MrmRegisterNamesInHierarchy" 3
.SH "NAME"
\fBMrmRegisterNamesInHierarchy\fP \(em Registers the values associated with the names referenced in UIL within a single hierarchy (for example, UIL callback function names or UIL identifier names)
"MrmRegisterNamesIn\\%Hierarchy"
"uil functions" "MrmRegisterNamesIn\\%Hierarchy"
.SH "SYNOPSIS"
.PP
.nf
#include <Mrm/MrmPublic\&.h>
\fBCardinal \fBMrmRegisterNamesInHierarchy\fP\fR(
\fBMrmHierarchy \fBhierarchy_id\fR\fR,
\fBMrmRegisterArglist \fBregister_list\fR\fR,
\fBMrmCount \fBregister_count\fR\fR);
.fi
"MRM function" "MrmRegisterNamesIn\\%Hierarchy"
"MrmRegisterNamesIn\\%Hierarchy" "definition"
.SH "DESCRIPTION"
.PP
The
\fBMrmRegisterNamesInHierarchy\fP
function
"MrmRegisterNamesIn\\%Hierarchy" "description"
registers a vector of names and associated values
for access in MRM\&.
The values can be callback functions, pointers
to user-defined data, or any other values\&.
The information provided is used to resolve symbolic references
occurring in UID files to their run-time
values\&. For callbacks, this information
provides the procedure address required
by the Motif Toolkit\&.
For names used as identifiers in UIL, this information
provides any
run-time mapping the application needs\&.
.PP
This function is similar to
\fBMrmRegisterNames\fP,
except that the scope of the names registered by
\fBMrmRegisterNamesInHierarchy\fP
is limited to the hierarchy specified by
\fIhierarchy_id\fP,
whereas the names registered by
\fBMrmRegisterNames\fP
have
global scope\&.
When MRM looks up a name, it first tries to find the name among those
registered for the given hierarchy\&.
If that lookup fails, it tries to find the name among those registered
globally\&.
.IP "\fIhierarchy_id\fP" 10
Specifies the hierarchy with which the names are to be associated\&.
.IP "\fIregister_list\fP" 10
Specifies a list of name/value pairs for the names to be registered\&.
Each name is a case-sensitive, NULL-terminated ASCII string\&.
Each value is a 32-bit quantity, interpreted as a procedure address if
the name is a callback function, and uninterpreted otherwise\&.
.IP "\fIregister_count\fP" 10
Specifies the number of entries in
\fIregister_list\fP\&.
.PP
The names in the list are case-sensitive\&.
The list can be either ordered or unordered\&.
.PP
Callback functions registered through
\fBMrmRegisterNamesInHierarchy\fP
can be either
regular or creation callbacks\&.
Regular callbacks have declarations determined by Motif Toolkit and user
requirements\&.
Creation callbacks have the same format as any other callback:
.PP
.nf
\fBvoid \fBCallBackProc\fP\fR(
\fBWidget *\fBwidget_id\fR\fR,
\fBOpaque \fBtag\fR\fR,
\fBXmAnyCallbackStruct *\fBcallback_data\fR\fR);
.fi
.IP "\fIwidget_id\fP" 10
Specifies the widget ID associated with the widget performing the
callback (as in any callback function)\&.
.IP "\fItag\fP" 10
Specifies the tag value (as in any callback function)\&.
.IP "\fIcallback_data\fP" 10
Specifies a widget-specific data structure\&.
This data structure has a minimum of two members: event and reason\&.
The reason member is always set to
\fBMrmCR_CREATE\fP\&.
.PP
Note that the widget name and parent are available from the widget
record accessible through
\fIwidget_id\fP\&.
.SH "RETURN"
"MrmSUCCESS"
"MrmFAILURE"
.PP
This function returns one of the following status return constants:
.IP "\fBMrmSUCCESS\fP" 10
The function executed successfully\&.
.IP "\fBMrmFAILURE\fP" 10
The function failed\&.
.\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:17