summaryrefslogtreecommitdiff
path: root/man/XtVaCreateArgsList.man
blob: 3c0a2d40252d8493f31027762cba789b1a0c2cfc (plain)
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
.\" Copyright 1993 X Consortium
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be
.\" included in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name of the X Consortium shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from the X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
.hw XtVa-Create-Args-List wid-get
.na
.TH XtVaCreateArgsList __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtVaCreateArgsList \- dynamically allocate a varargs list
.SH SYNTAX
#include <X11/Intrinsic.h>
.HP
XtVarArgsList XtVaCreateArgsList(XtPointer \fIunused\fP, ...\^);
.SH ARGUMENTS
.IP \fIunused\fP 1i
Must be specified as NULL.
.IP \fI...\fP 1i
Specifies a variable parameter list of resource name and value pairs.
.SH DESCRIPTION
The
.B XtVaCreateArgsList
function allocates memory and copies its arguments into a single list
pointer, which may be used with
.BR XtVaNestedList .
The end of both lists is identified by a \fIname\fP entry containing
NULL. Any entries of type
.B XtVaTypedArg
are copied as specified without applying conversions.
Data passed by
reference (including Strings) are not copied, only the pointers
themselves; the caller must ensure that the data remain valid for
the lifetime of the created varargs list.
The list should be freed
using
.B XtFree
when no longer needed.
.SH "SEE ALSO"
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP