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
|
<?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_soap_box_structure">
<refmeta>
<refentrytitle>soap_box_structure</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soap_box_structure</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_soap_box_structure">
<funcprototype id="fproto_soap_box_structure">
<funcdef>any <function>soap_box_structure</function></funcdef>
<paramdef>in <parameter>elem1</parameter> varchar</paramdef>
<paramdef>in <parameter>value1</parameter> any</paramdef>
<paramdef>in <parameter>...</parameter> </paramdef>
<paramdef>in <parameter>elem1</parameter> varchar</paramdef>
<paramdef>in <parameter>value1</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_soap_box_structure"><title>Description</title>
<para>
This function provides a way to encapsulate a structure suitable for
soap serialization. It accepts a name/value pairs which represents name and
value of elements of a structure.
</para>
<para>For example structure :</para>
<programlisting><![CDATA[
{
varString 'hello',
varInt 1234
}]]></programlisting>
<para>
will be represented as soap_box_structure ('varString', 'hello', 'varInt', 1234);
furthermore value returned from soap_box_structure passed as an output parameter
to the procedure (named structname) working as SOAP method will return :
</para>
<programlisting><![CDATA[
<structName>
<varString>hello</varString>
<varInt>1234</varInt>
</structName> ]]></programlisting>
<para>
Please note that this is a one of possibilities to express structures
for SOAP request/response in Virtuoso/PL. The other way to express structure is to use
User Defined Types (see SOAP & WSDL section of the documentation).
</para>
</refsect1>
<refsect1 id="params_soap_box_structure">
<title>Parameters</title>
<refsect2>
<title>elem</title>
<para>name which represents name
of the member of a structure
</para>
</refsect2>
<refsect2>
<title>value</title>
<para>value which represents value
of the member of a structure
</para>
</refsect2>
</refsect1>
<refsect1 id="ret_soap_box_structure"><title>Return Types</title>
<para>The return type of <function>soap_box_structure()</function> is an array
representing a structure.
</para>
</refsect1>
</refentry>
|
