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
|
<?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_progn">
<refmeta>
<refentrytitle>progn()</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>progn()</refname>
<refpurpose>Calculates all given expressions and returns the result produced by the last one.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_progn">
<funcprototype id="xpf_proto_progn">
<funcdef>any <function>progn()</function></funcdef>
<paramdef><parameter>expn1</parameter> any</paramdef>
<paramdef><parameter>expn2</parameter> any</paramdef>
<paramdef>...</paramdef>
<paramdef><parameter>expnN</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_progn"><title>Description</title>
<para>
This function calculates its first argument, then second argument and so on.
The results of these calculations are not used, except the result of the last expression which
is returned. The only useful application for this function is calling XPath extension functions
for side effects.
</para>
<para>
This function is not a part of library of standard XQuery 1.0 functions.
</para>
</refsect1>
<refsect1 id="xpf_params_progn"><title>Parameters</title>
<refsect2><title>expn1, expn2, ... expnN</title>
<para>Expressions to be calculated.</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_progn"><title>Return Types</title><para>Any (according to the type of <parameter>expnN</parameter>)</para></refsect1>
<!-- <refsect1 id="xpf_errors_progn"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
-->
<refsect1 id="xpf_examples_progn"><title>Examples</title>
<example id="xpf_ex_progn"><title></title>
<para></para>
<screen>
[xmlns:fileio='http://www.example.com/file-io']
if (function-available ('fileio:printf'),
progn (
fileio:open('greeting.txt', 'wt'),
fileio:printf('Hello %s', /userinfo/name),
fileio:close(),
'File greeting.txt saved' ),
'File greeting.txt not saved' ) )
</screen>
</example>
</refsect1>
<refsect1 id="xpf_seealso_progn"><title>See Also</title>
<para><link linkend="xpf_if">if</link></para>
<para><link linkend="xpf_for">for</link></para>
<para><link linkend="xpf_let">let</link></para>
</refsect1>
</refentry>
|