FTPStatus
- Last UpdatedOct 29, 2026
- 2 minute read
FTPStatus is a built-in function that gets the current status of any file transfers that were started by the functions FTPGet and FTPPut.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
FTPStatus |
FTP |
Synchronous |
Yes |
Supported |
Supported |
Not supported |
Supported (see Notes below) |
Not supported |
Syntax
FTPStatus("optStrTagStatus")
optStrTagStatus
The name of the string tag that will receive a text description of the current status of the file transfer(s). The description corresponds to the actual status code returned by the function (see "Returned value" below). However, this parameter is optional; if no value is specified, the description will not be received.
Note: If this parameter is enclosed in quotes, the string literal will be used. Otherwise, the value of the tag/expression will be used.
Returned value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
-9 |
Transfer pending |
|
-8 |
Error receiving the file (see status string for details) |
|
-7 |
Error establishing connection (see status string for details) |
|
-6 |
Error opening connection (see status string for details) |
|
-2 |
Invalid strStatusTag |
|
0 |
No transaction is being executed |
|
1 |
Transaction executed successfully |
|
2 |
Resolving name |
|
3 |
Name resolved |
|
4 |
Connecting to server |
|
5 |
Connected to server |
|
6 |
Closing connection |
|
7 |
Connection closed |
|
8 |
Sending request |
|
9 |
Request sent |
|
10 |
Receiving response |
|
11 |
Intermediate response received |
|
12 |
Response received |
|
13 |
Request completed |
|
15 |
Data Protection is enabled (see Notes below). |
Notes
Unlike the other FTP functions, you can call this function at any time, but it will not provide useful information unless you have previously called FTPGet or FTPPut.
This function cannot be executed on thin clients (in the Viewer module) when Data Protection is enabled. It must be executed on the project runtime server. For more information, see Enable Data Protection to encrypt sensitive information.
Examples
Get the current status of a file transfer, and then store a text description of the status in the string tag named "StatusDescription":
FTPStatus("StatusDescription")