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
|
<?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_sdl">
<refmeta>
<refentrytitle>soap_sdl</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soap_sdl</refname>
<refpurpose>Generate SDL document for a PL module and return it as a varchar.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_soap_sdl">
<funcprototype id="fproto_soap_sdl">
<funcdef><function>soap_sdl</function></funcdef>
<paramdef>in <parameter>module_name</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>URL</parameter> varchar</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_soap_sdl"><title>Description</title>
<para>This function generates a SDL for the procedures in a PL module the same way as
/SOAP/services.xml is generated for the procedures in WS.SOAP.</para>
</refsect1>
<refsect1 id="params_soap_sdl"><title>Parameters</title>
<refsect2><title>module</title>
<para>Required. The name of the module to describe. This can be partial name.</para>
</refsect2>
<refsect2><title>URL</title>
<para>Optional (default is the current VSP path if in VSP context. Otherwise error).
The URL to include in the SDL file</para>
</refsect2>
</refsect1>
<refsect1 id="ret"><title>Return Types</title><para>Returns the SDL document describing the module as an varchar value.</para></refsect1>
</refentry>
|