Remove¶

Removes a file from a remote environment.

1

myFiles.Remove(options: FileTransferOptions):boolean

Parameters¶

FileTransferOptions options
    An instance of FileTransferOptions specifying the remote file.

Returns¶

true if the file was removed; otherwise, false.

Types¶

FileTransferOptions¶

Options for file transfer operations.

Password : string
The password to authenticate with on the remote environment. Optional.

Port : number
The port number of the remote environment. Optional.

Protocol : ( "FTP" | "FTPS" | "SFTP" | "HTTP" | "HTTPS" )
The protocol to use for file transfer. Optional. The default is

RemoteHost : string
The IP address or host name of the remote environment.

RemotePath : string
The path of the file on the remote environment.

UserName : string
The username to authenticate with on the remote environment. Optional.