ftpFileSend (Function)

Top  Previous  Next

Architecture:

X32 / NX32 / NX32L

Device support:

All

Firmware version:

2.10 / 1.00.00


This function transfers a file from the device to the FTP server.

The file system must already be open with fsMediaOpen or the send will fail.

 

Note:

The length of the remote file name is restricted by the server.

 

Note:

If the file already exists and the user is allowed to overwrite it, the file will be replaced without warnings.

 

Input:

ID : INT

The ID returned from ftpConnect.

 

Name : STRING

Name to save the file as. Both absolute and relative paths are allowed.

 

Local : STRING (Optional)

Alternative local name of file to send if not the same name (without any path).

Both absolute and relative paths are allowed.

 

Returns: INT

0


- Success.

- 1


- Failed to send, see ftpLastResponse.

- 2


- Invalid ID.

- 3


- Invalid name, or it could not be used to generate a local name.

- 4


- Session is busy with another operation.

- 5


- FTP not open, use ftpOpen to open interface.

- 10


- Communication with server not possible

 

Declaration:

FUNCTION ftpFileSend : INT;
VAR_INPUT
  ID   : INT;
  Name : STRING;
  Local : STRING;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM example;
VAR
  open : BOOL;
  host : STRING := "ftp.domain.com";
  usr   : STRING := "ftpuser";
  pwd   : STRING := "user pwd";
 
  name   : STRING := "test.txt";
 
  id   : INT;
END_VAR;
 
  gsmPower(power := ON);
  gprsOpen();
  fsMediaOpen(media := 0);
 
BEGIN
 open := (ftpOpen() = 0);
IF open THEN
    id := ftpConnect(host := host, username := usr, password := pwd);
    ftpFileSend(id := id, name := name, local := name);
    ftpDisconnect(id := id);
END_IF;
ftpClose();
END;
END_PROGRAM;