RemoteFile Property

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


ANSI (Cross Platform)
char* GetRemoteFile();
int SetRemoteFile(const char* lpszRemoteFile); Unicode (Windows) LPWSTR GetRemoteFile();
INT SetRemoteFile(LPCWSTR lpszRemoteFile);
@property (nonatomic,readwrite,assign,getter=remoteFile,setter=setRemoteFile:) NSString* remoteFile;
- (NSString*)remoteFile;
- (void)setRemoteFile:(NSString*)newRemoteFile;

IPWORKSSFTP_EXTERNAL void* IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value



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.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"

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

Example (Using RemoteFile as a file mask):

SFTPControl.RemoteFile = "*.txt"

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


Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]