1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
'\" t
...\" FetchLit.sgm /main/11 1996/09/24 15:58:02 cdedoc $
.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 "MrmFetchLiteral" "library call"
.SH "NAME"
\fBMrmFetchLiteral\fP \(em Fetches a literal from a UID file
.iX "MrmFetchLiteral"
.iX "uil functions" "MrmFetchLiteral"
.SH "SYNOPSIS"
.PP
.nf
#include <Mrm/MrmPublic\&.h>
\fBCardinal \fBMrmFetchLiteral\fP\fR(
\fBMrmHierarchy \fBhierarchy_id\fR\fR,
\fBString \fBindex\fR\fR,
\fBDisplay *\fBdisplay\fR\fR,
\fBXtPointer *\fBvalue\fR\fR,
\fBMrmCode *\fBtype\fR\fR);
.fi
.iX "MRM function" "MrmFetchLiteral"
.iX "MrmFetchLiteral" "definition"
.SH "DESCRIPTION"
.PP
The
\fBMrmFetchLiteral\fP
function
.iX "MrmFetchLiteral" "description"
reads and returns the value and type of a literal (named value)
that is stored as
a public resource in a single UID file\&.
This function returns a pointer to the value of the literal\&.
For example, an integer is always returned as a pointer to an integer,
and a string is always returned as a pointer to a string\&.
.PP
Applications should not use
\fBMrmFetchLiteral\fP
for fetching icon or color literals\&.
If this is attempted,
\fBMrmFetchLiteral\fP
returns an error\&.
.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 "\fIindex\fP" 10
Specifies the UIL name of the literal (pixmap) to fetch\&.
You must define this name in UIL as an exported value\&.
.IP "\fIdisplay\fP" 10
Specifies the display used for the pixmap\&.
The
\fIdisplay\fP
argument specifies the connection to the X server\&.
For more information on the
\fBDisplay\fR structure, see the Xlib function
\fBXOpenDisplay\fP\&.
.IP "\fIvalue\fP" 10
Returns the ID of the named literal\&'s value\&.
The function allocates space for the returned value\&.
The application is responsible for managing the allocated space
by calling the appropriate deallocation function\&. For example,
if the returned ID symbolizes a pixmap, then the application can
recover the allocated space by calling \fBXmDestroyPixmap\fP\&.
.IP "\fItype\fP" 10
Returns the named literal\&'s data type\&.
Types are defined in the include file \fBMrm/MrmPublic\&.h\fP\&.
.SH "RETURN"
.iX "MrmSUCCESS"
.iX "MrmBAD_HIERARCHY"
.iX "MrmNOT_FOUND"
.iX "MrmFAILURE"
.PP
This function returns one of the following status return constants:
.IP "\fBMrmSUCCESS\fP" 10
The function executed successfully\&.
.IP "\fBMrmBAD_HIERARCHY\fP" 10
The hierarchy ID was invalid\&.
.IP "\fBMrmNOT_FOUND\fP" 10
The literal was not found in the UIL file\&.
.IP "\fBMrmWRONG_TYPE\fP" 10
The caller tried to fetch a literal of a type not supported by this
function\&.
.IP "\fBMrmFAILURE\fP" 10
The function failed\&.
.SH "RELATED"
.PP
\fBMrmFetchBitmapLiteral\fP(3),
\fBMrmOpenHierarchyPerDisplay\fP(3),
\fBMrmFetchIconLiteral\fP(3),
\fBMrmFetchColorLiteral\fP(3), and
\fBXOpenDisplay\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:16
|
