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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<?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_dav_exp">
<refmeta>
<refentrytitle>DAV_EXP</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>DAV_EXP</refname>
<refpurpose>Export a retrieved Web site to another WebDAV enabled server</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_dav_exp">
<funcprototype id="fproto_dav_exp">
<funcdef>WS.WS.<function>DAV_EXP</function></funcdef>
<paramdef>in <parameter>host</parameter> varchar</paramdef>
<paramdef>in <parameter>url</parameter> varchar</paramdef>
<paramdef>in <parameter>root</parameter> varchar</paramdef>
<paramdef>in <parameter>dst</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_dav_exp"><title>Description</title>
<para>This function is used to export local content retrieved from a Web Robot Copy
to the local file system.
</para>
</refsect1>
<refsect1 id="params_dav_exp"><title>Parameters</title>
<refsect2><title>host</title>
<para>The target host name</para></refsect2>
<refsect2><title>url</title>
<para>start path on target</para></refsect2>
<refsect2><title>root</title>
<para>local WebDAV collection that contains the retrieved content</para></refsect2>
<refsect2><title>dst</title>
<para>absolute URL to the WebDAV folder to export content to</para></refsect2>
</refsect1>
<refsect1 id="ret_dav_exp"><title>Return Types</title>
<para>The function returns a non-zero value (can be an error description) if an error occurred while exporting.</para></refsect1>
<refsect1 id="errors_dav_exp"><title>Errors</title>
<table><title>Errors signalled by DAV_* functions</title>
<tgroup cols="2">
<thead><row><entry>Error Code</entry><entry>Description</entry></row></thead>
<tbody>
<row><entry><errorcode>>=0</errorcode></entry>
<entry><errorname>success</errorname></entry></row>
<row><entry><errorcode>-1</errorcode></entry>
<entry><errorname>The path (target of operation) is not valid</errorname></entry></row>
<row><entry><errorcode>-2</errorcode></entry>
<entry><errorname>The destination (path) is not valid</errorname></entry></row>
<row><entry><errorcode>-3</errorcode></entry>
<entry><errorname>Overwrite flag is not set and destination exists</errorname></entry></row>
<row><entry><errorcode>-4</errorcode></entry>
<entry><errorname>The target is resource, but source is collection (in copy move operations)</errorname></entry></row>
<row><entry><errorcode>-5</errorcode></entry>
<entry><errorname>Permissions are not valid</errorname></entry></row>
<row><entry><errorcode>-6</errorcode></entry>
<entry><errorname>uid is not valid</errorname></entry></row>
<row><entry><errorcode>-7</errorcode></entry>
<entry><errorname>gid is not valid</errorname></entry></row>
<row><entry><errorcode>-8</errorcode></entry>
<entry><errorname>Target is locked</errorname></entry></row>
<row><entry><errorcode>-9</errorcode></entry>
<entry><errorname>Destination is locked</errorname></entry></row>
<row><entry><errorcode>-10</errorcode></entry>
<entry><errorname>Property name is reserved (protected or private)</errorname></entry></row>
<row><entry><errorcode>-11</errorcode></entry>
<entry><errorname>Property does not exist</errorname></entry></row>
<row><entry><errorcode>-12</errorcode></entry>
<entry><errorname>Authentication failed</errorname></entry></row>
<row><entry><errorcode>-13</errorcode></entry>
<entry><errorname>Operation is forbidden (the authenticated user do not have a permissions for the action)</errorname></entry></row>
<row><entry><errorcode>-14</errorcode></entry>
<entry><errorname>the target type is not valid</errorname></entry></row>
<row><entry><errorcode>-15</errorcode></entry>
<entry><errorname>The umask is not valid</errorname></entry></row>
<row><entry><errorcode>-16</errorcode></entry>
<entry><errorname>The property already exists</errorname></entry></row>
<row><entry><errorcode>-17</errorcode></entry>
<entry><errorname>Invalid property value</errorname></entry></row>
<row><entry><errorcode>-18</errorcode></entry>
<entry><errorname>no such user</errorname></entry></row>
<row><entry><errorcode>-19</errorcode></entry>
<entry><errorname>no home directory</errorname></entry></row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_dav_exp"><title>Examples</title>
<example id="ex_dav_exp"><title>Exporting to the Filesystem</title>
<programlisting>
WS.WS.LFS_EXP ('www.foo.com', '/help/', 'sites/www_foo_com', '/tmp/');
WS.WS.DAV_EXP ('www.foo.com', '/help/', 'sites/www_foo_com',
'http://www.mydrive.com:8990/DAV/sites/');
</programlisting>
</example>
</refsect1>
<refsect1 id="seealso_dav_exp"><title>See Also</title>
<para><link linkend="fn_lfs_exp"><function>WS.WS.LFS_EXP()</function></link></para>
<para><link linkend="fn_dav_api_add">DAV content add/update/delete functions</link></para>
<para><link linkend="fn_dav_api_change">DAV content manipulation functions</link></para>
<para><link linkend="fn_dav_api_search">DAV search functions</link></para>
<para><link linkend="fn_dav_api_user">DAV user management functions</link></para>
</refsect1>
</refentry>
|
