RemoteFile Property

The name of the remote file for uploading, downloading, etc.

Object Oriented Interface

public function getRemoteFile();
public function setRemoteFile($value);

Procedural Interface

ipworks_ftp_get($res, 26 );
ipworks_ftp_set($res, 26, $value );

Default Value

Remarks

This property contains the name of the remote file to upload, download, etc. and is either an absolute file path, or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example (Setting RemoteFile)

FTPControl.LocalFile = "C:\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Download()

FTPControl.LocalFile = "C:\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Download()

Note: This property will also act as a file mask when performing ListDirectory or ListDirectoryLong.

Example (Using RemoteFile as a file mask):

FTPControl.RemoteFile = "*.txt"
FTPControl.ListDirectory()

The RemoteFile property supports several pattern matching characters. The following special characters are supported for pattern matching:


?	Any single character.
*	Any characters or no characters. I.E., C*t matches Cat, Cot, Coast, Ct, etc)
[,-]	A range of characters. E.g.: [a-z], [a], [0-9], [0-9,a-d,f,r-z], etc.
\	The slash is ignored and exact matching is performed on the next character.

If the above characters need to be used as a literal in a FileMask then they must be escaped by surrounding them with a []. (Note, "]" and "-" do not need to be escaped) See below for the escape sequences:


Character	Escape Sequence
?	[?]
*	[*]
[	[[]
\	[\]

For example, if you wanted to download a file whose name was [Something].txt you could set the RemoteFile property to: [[]Something].txt

Data Type

String