1
.\" $Xorg: XtGetClExt.man,v 1.3 2000/08/17 19:42:00 cpqbld Exp $
3
.\" Copyright (c) 1993, 1994 X Consortium
5
.\" Permission is hereby granted, free of charge, to any person obtaining a
6
.\" copy of this software and associated documentation files (the "Software"),
7
.\" to deal in the Software without restriction, including without limitation
8
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
9
.\" and/or sell copies of the Software, and to permit persons to whom the
10
.\" Software furnished to do so, subject to the following conditions:
12
.\" The above copyright notice and this permission notice shall be included in
13
.\" all copies or substantial portions of the Software.
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18
.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19
.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
20
.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
.\" Except as contained in this notice, the name of the X Consortium shall not
24
.\" be used in advertising or otherwise to promote the sale, use or other
25
.\" dealing in this Software without prior written authorization from the
28
.\" $XFree86: xc/doc/man/Xt/XtGetClExt.man,v 1.3 2001/02/09 03:47:51 tsi Exp $
31
.ds xT X Toolkit Intrinsics \- C Language Interface
33
.ds xW X Toolkit Athena Widgets \- C Language Interface
34
.ds xL Xlib \- C Language X Interface
35
.ds xC Inter-Client Communication Conventions Manual
38
.hw XtGet-Class-Extension wid-get
45
.\".if \\n(VS>=40 .vs \\n(VSu
46
.\".if \\n(VS<=39 .vs \\n(VSp
69
.de IN \" send an index entry to the stderr
76
.\" choose appropriate monospace font
77
.\" the imagen conditional, 480,
78
.\" may be changed to L if LB is too
79
.\" heavy for your eyes...
81
.ie "\\*(.T"480" .ft L
82
.el .ie "\\*(.T"300" .ft L
83
.el .ie "\\*(.T"202" .ft PO
84
.el .ie "\\*(.T"aps" .ft CW
87
.ie \\n(VS>40 .vs \\n(VSu
95
.ie t \\$1\fB\^\\$2\^\fR\\$3
96
.el \\$1\fI\^\\$2\^\fP\\$3
99
.ie t \fB\^\\$1\^\fR\\$2
100
.el \fI\^\\$1\^\fP\\$2
105
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
106
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
120
. \" Note End -- doug kraft 3/85
129
.TH XtGetClassExtension 3Xt __xorgversion__ "XT FUNCTIONS"
131
XtGetClassExtension \- locate a class extension record
133
XtPointer XtGetClassExtension(\fIobject_class\fP, \fIbyte_offset\fP
134
\fItype\fP, \fIversion\fP, \fIrecord_size\fP)
136
WidgetClass \fIobject_class\fP;
138
Cardinal \fIbyte_offset\fP;
144
Cardinal \fIrecord_size\fP;
147
.IP \fIobject_class\fP 1i
148
Specifies the widget class containing the extension list to be searched.
149
.IP \fIbyte_offset\fP 1i
150
Specifies the offset in bytes form the base of the widget class of the
151
extension field to be searched.
153
Specifies the name of the class extension to be located.
155
Specifies the minimum acceptable version of the class extension
156
required for a match.
157
.IP \fIrecord_size\fP 1i
158
Specifies the minimum acceptable length of the class extension record
159
required for match, or 0.
161
The list of extension records at the specified offset in the specified
162
\fIwidget_class\fP will be searched for a match on the specified
163
\fItype\fP, a version greater than or equal to the specified \fIversion\fP,
164
and a record size greater than or equal the specified \fIrecord_size\fP
166
.ZN XtGetClassExtension
167
returns a pointer to a matching extension record or NULL if no match
168
is found. The returned extension record is owned by the widget class
169
and must not be modified or freed by the caller, except possibly to
170
be modified by the widget class owner.