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
|
<?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_print_box">
<refmeta>
<refentrytitle>soap_print_box</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soap_print_box</refname>
<refpurpose>Formats an SQL value and returns it as a generated XML fragment.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_soap_print_box">
<funcprototype id="fproto_soap_print_box">
<funcdef><function>soap_print_box</function></funcdef>
<paramdef>in <parameter>value</parameter> any</paramdef>
<paramdef>in <parameter>enclosing_tag</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>date_encoding_type|soap_version</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_soap_print_box"><title>Description</title><para>
This function formats an SQL value as an XML fragment and returns it.
This is used internally by the SOAP server to encode the output parameter values and return values when
processing a SOAP request.
</para></refsect1>
<refsect1 id="params_soap_print_box"><title>Parameters</title>
<refsect2><title>value</title>
<para>Required. Any SQL value to be represented as an XML fragment.</para></refsect2>
<refsect2><title>enclosing_tag</title>
<para>Required. The XML tag to place the value into.</para></refsect2>
<refsect2><title>date_encoding_type</title>
<para>Optional. Valid only if a value is a datetime. If supplied, the <parameter>enclosing_tag</parameter>
is ignored and the date is printed out in one of the following formats:</para>
<simplelist>
<member>0 - ISO 8601</member>
<member>1 - RFC 1123</member>
<member>3 - Microsoft specific, recognized by some of the WebFolders clients</member></simplelist></refsect2>
<refsect2><title>soap_version</title>
<para>Optional(Default 1). Valid only if the value type is not a datetime. The soap_version (1 for SOAP 1.0, 11 for SOAP 1.1).</para></refsect2>
</refsect1>
<refsect1 id="ret_soap_print_box"><title>Return Types</title><para>Generated XML fragment.</para></refsect1>
</refentry>
|
