RemoteFile Property

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

Object Oriented Interface

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

Procedural Interface

ipworkssftp_sftp_get($res, 36 );
ipworkssftp_sftp_set($res, 36, $value );

Default Value

''

Remarks

The RemoteFile 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)


SFTPControl.Localfile = "C:\localfile.txt"
SFTPControl.RemoteFile = "remotefile.txt"
SFTPControl.Download()

SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()

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

Example (Using RemoteFile as a file mask):

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

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 pattern then they must be escaped by surrounding them with a []. (Note, "]" and "-" do not need to be escaped) See below for the escape sequences:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

For example, to match the value [Something].txt specify the pattern [[]Something].txt

Data Type

String

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks SFTP 2020 PHP Edition - Version 20.0 [Build 7941]