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
|
<?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="fn_xml_template">
<refmeta>
<refentrytitle>xml_template</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xml_template</refname>
<refpurpose>Execute XML template from Virtuoso PL</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xml_template">
<funcprototype id="fproto_xml_template">
<funcdef><function>xml_template</function></funcdef>
<paramdef>in <parameter>xml_document_entity</parameter> any</paramdef>
<paramdef>in <parameter>parameters</parameter> vector</paramdef>
<paramdef><optional>inout <parameter>session</parameter> string_session</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xml_template">
<title>Description</title>
<para>The <function>xml_template()</function> function was introduced to
enable PL programming to make use of XML templates.
This function expects an XML entity for the first argument, that will be
the XML template file contents. Usually this entity is composed making
use of the <function>xtree_doc()</function> function from the XML
template file.</para>
<para>The second argument should be a vector of name-value pairs of the
parameters for XML template.</para>
<para>The last argument is an output string stream for the result. If the
output stream is not specified the HTTP internal stream will be used
if it is available, otherwise an error will be signalled.</para>
</refsect1>
<refsect1 id="params_xml_template">
<title>Parameters</title>
<refsect2><title>xml_document_entity</title>
<para>XML entity such as that returned by <function>xtree_doc()</function></para></refsect2>
<refsect2><title>parameters</title>
<para>Vector or name-value pairs: vector('name1', 'value1', 'name2', 'value2', ...).</para></refsect2>
<refsect2><title>session</title>
<para>Output stream for handling the results of XML template. If this
parameter is unspecified then the HTTP internal stream will be assumed,
which if not applicable will signal an error.</para></refsect2>
</refsect1>
<refsect1 id="ret_xml_template"><title>Return Types</title>
<para>A URL of the XSLT stylesheet for further transformation will be
returned. If xsl attribute was not specified in the XML template then the
return value will be NULL.</para>
</refsect1>
<!--
<refsect1 id="errors_">
<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="examples_xml_template">
<title>Examples</title>
<example id="ex_"><title></title>
<para></para>
<screen><![CDATA[
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_xml_template">
<title>See Also</title>
<para><link linkend="fn"><function></function></link></para>
</refsect1> -->
</refentry>
|
