TElHTTPSWebDAVClient.Move method

TElHTTPSWebDAVClient.Move

Moves a remote resource to another location.

Declaration

[C#]
int Move(string SrcURL, string DestURL, TSBWebDAVDepth Depth, bool Overwrite, string IfHeader);

[VB.NET]
Function Move(ByVal SrcURL As String, ByVal DestURL As String, ByVal Depth As TSBWebDAVDepth, ByVal Overwrite As Boolean, ByVal IfHeader As String) As Integer

[Pascal]
function Move(const SrcURL, DestURL : string; Depth : TSBWebDAVDepth = wddInfinity; Overwrite : boolean = true; const IfHeader : string = '') : integer;

[C++]
int32_t Move(const std::string &SrcURL, const std::string &DestURL, TSBWebDAVDepth Depth, bool Overwrite, const std::string &IfHeader);

[PHP]
integer Move(string $SrcURL, string $DestURL, integer $Depth, bool $Overwrite, string $IfHeader)

[Java]
int move(String SrcURL, String DestURL, TSBWebDAVDepth Depth, boolean Overwrite, String IfHeader);

Parameters

SrcURL - URL of the resource to be moved.
DestURL - destination URL.
Depth - specifies the depth of the request.
Overwrite - specifies whether to overwrite existing resources.
IfHeader - specifies the If header of the request.

Depth values:

[.NET] [C++]	[Pascal]	Description
wddZero = 0	wddZero	The request applies only to the resource specified in the request URI
wddOne = 1	wddOne	The request applies to the resource and its children
wddInfinity = 2	wddInfinity	The request applies to the resource specified in the request URI along with all its members, all the way down the hierarchy

Return value

On success, returns server status code, otherwise returns -1.

Description

Use this method to send MOVE request to the server. The actual operation, performed by the server, depends on the type of the resource, e.g., move of a non-collection resource is the logical equivalent of a copy (COPY), followed by consistency maintenance processing, followed by a delete of the source, where all three actions are performed in a single operation.