RemoveDirectory Method

Remove a directory on the remote host.

Syntax

object.RemoveDirectory( RemotePath )

Remarks

The RemoveDirectory method removes an existing directory on the remote host. You must have the appropriate permission to remove the directory, or an error will occur. Note that most operating systems will not permit you to remove a directory that contains files or other subdirectories.

RemotePath
A string that specifies the name of the directory to remove from the server. The naming and pathing conventions used for the directory must be compatible with what is used on the operating system that hosts the server.

Return Value

A value of zero is returned if the operation was successful, otherwise a non-zero error code is returned which indicates the cause of the failure.

See Also

ChangeDirectory Method, MakeDirectory Method


Copyright © 2008 Catalyst Development Corporation. All rights reserved.