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
|
<?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_make_error">
<refmeta>
<refentrytitle>soap_make_error</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soap_make_error</refname>
<refpurpose>Creates a SOAP error reply XML message based on its parameters.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_soap_make_error">
<funcprototype id="fproto_soap_make_error">
<funcdef>varchar <function>soap_make_error</function></funcdef>
<paramdef>in <parameter>soap_code</parameter> varchar</paramdef>
<paramdef>in <parameter>sql_state</parameter> varchar</paramdef>
<paramdef>in <parameter>error_message</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>soap_version</parameter> integer</optional></paramdef>
<paramdef><optional>in <parameter>do_uddi</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_make_error"><title>Description</title><para>
This function creates a SOAP error reply based on the given parameters. It returns the generated XML
as a varchar value.
</para></refsect1>
<refsect1 id="params_make_error"><title>Parameters</title>
<refsect2><title>soap_code</title>
<para>Required. The fault code according to the SOAP specification.</para></refsect2>
<refsect2><title>sql_state</title>
<para>Required. The error's SQL state.</para></refsect2>
<refsect2><title>error_message</title>
<para>Required. The error text.</para></refsect2>
<refsect2><title>soap_version</title>
<para>Optional (default 11). The SOAP version used to encode the SOAP error reply.</para></refsect2>
<refsect2><title>do_uddi</title>
<para>Optional (default 0). 1 = produce UDDI error format; 0 = SOAP error format.</para></refsect2>
</refsect1>
<refsect1 id="ret_make_error"><title>Return Types</title><para>Returns generated XML as a varchar.</para></refsect1>
</refentry>
|
