IPWorks Cloud 2020 Java Edition

Questions / Feedback?

RemoteFile Property

The name of the remote file.

Syntax

public String getRemoteFile();
public void setRemoteFile(String remoteFile);

Default Value

""

Remarks

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

Example (Setting RemoteFile)

component.LocalFile = "C:\\test.txt";
component.RemoteFile = "test.txt";
component.Upload();

component.LocalFile = "C:\\test.txt";
component.RemoteFile = "/MyFolder/SubFolder/file.txt";
component.Upload();
Note: This property will also act as a file mask when calling ListDirectory.

Example (Using RemoteFile as a file mask):

component.RemoteFile = "*.txt"
component.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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Java Edition - Version 20.0 [Build 8265]