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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="xpf_list">
<refmeta>
<refentrytitle>list()</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>list()</refname>
<refpurpose>Selects the first item of every argument sequence and returns the sequence of the selected items</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_list">
<funcprototype id="xpf_proto_list">
<funcdef>sequence <function>list()</function></funcdef>
<paramdef><parameter>seq1</parameter> sequence</paramdef>
<paramdef><parameter>seq2</parameter> sequence</paramdef>
<paramdef><parameter>...</parameter></paramdef>
<paramdef><parameter>seqN</parameter> sequence</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_list"><title>Description</title>
<para>
This function calculates all given arguments from left to right,
and creates a sequence which contains the first item of the first calculated sequence,
then the first item of the second calculated sequence and so on.
If the value of an argument is not a sequence, but a scalar,
the scalar is treated as one-element sequence so it is added into the result.
If the value of an argument is an empry sequence, nothing is
added into the result (unlike function <link linkend="xpf_tuple">tuple()</link> that
adds an empty string in this case).
</para>
<para>
This function is not a part of XPATH 1.0 or XQUERY 1.0 libraries of standard functions.
</para>
</refsect1>
<refsect1 id="xpf_params_list"><title>Parameters</title>
<refsect2><title>SeqI</title>
<para>The sequence of items, first of its items will be used as I-tn item of the resulting sequence</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_list"><title>Return Types</title><para>Sequence</para></refsect1>
<refsect1 id="xpf_examples_list"><title>Examples</title>
<example id="xpf_ex_list"><title></title>
<para>Compose a sequence of the first title in the document, then the first abstract, then the first introduction</para>
<screen>list(/title, /abstract, /intro)</screen>
</example>
</refsect1>
<refsect1 id="xpf_seealso_list"><title>See Also</title>
<para><link linkend="xpf_append">append()</link><link linkend="xpf_tuple">tuple()</link></para>
</refsect1>
</refentry>
|
