FTP File Commands

Each of these commands pertain to files that are transferred via FTP.

Script Editor > Expand Internet Category >Select one of FTP File commands listed in this topic

FTP Send File

Sends the selected file from the user's computer to the FTP server.

File Name

Insert the name of the file to send or click on Browse to locate the file.

Transfer Mode

Determine whether the file being sent or received is a Binary file or an ASCII file.

Response from Host

The message generated by the FTP server, whether a success or failure, is saved to the  assigned variable. There are several ways to monitor the variable to determine the status of the operation.

1.Place the variable in a Text Box Display command to display the results at the end of the macro.

2.Use the Variable Modify String command to save the variable results to a text file for later review.

3.Send the results via email to an email account.

FTP Get File

Retrieves the selected file from the FTP server to the destination folder on the user's computer.

Remote File Name

Enter the name of the file found on the FTP server.

Local Destination Directory

Enter the folder name and path of the file to be saved on the computer. Or click on the Browse button to locate the directory.

Transfer Mode

Determine if the file being sent or received is a Binary file or an ASCII file.

Response from Host

The message generated by the FTP server, whether a success or failure, is saved to the assigned variable. There are several ways to monitor the variable to determine the status of the operation.

1.Place the variable in a Text Box Display command to display the results at the end of the macro.

2.Use the Variable Modify String command to save the variable results to a text file for later review.

3.Send the results via email to an email account.

üNote: The Scroll Lock + Pause or other methods available to stop the macro do not work during the playback of the FTP Send File and FTP Get File commands.

FTP Rename File

This command renames a FTP file.

Original Filename

Insert the name or path and name of the file to be renamed.

New Filename

Insert the new filename or new path and name of the file.

Response from Host

The message generated by the FTP server, whether a success or failure, is saved to the assigned variable. There are several ways to monitor the variable to determine the status of the operation.

1.Place the variable in a Text Box Display command to display the results at the end of the macro.

2.Use the Variable Modify String command to save the variable results to a text file for later review.

3.Send the results via email to an email account.

FTP Delete File

This command deletes the selected FTP file. The FTP Delete File command also accepts wildcards, such as *.*, in the filename edit box.

File Name

Enter the name of the file to be deleted from the FTP server.

Response from Host

The message generated by the FTP server, whether a success or failure, is saved to the assigned variable. There are several ways to monitor the variable to determine the status of the operation.

1.Place the variable in a Text Box Display command to display the results at the end of the macro.

2.Use the Variable Modify String command to save the variable results to a text file for later review.

3.Send the results via email to an email account.

Get Filesize

This command returns the size of a FTP file.

üNote: A return value of -1 means that the FTP server does not support the Size command. 

Filename

To obtain the file size, first Insert the name or path and name of the file in question.

Destination Variable

The file size is stored in an integer variable. Select the variable to store this information.

Transfer Mode

Select whether the FTP file is a Binary file, an ASCII file or unknown. Binary is the default selection.

Response from Host

The message generated by the FTP server, whether a success or failure, is saved to the assigned variable. There are several ways to monitor the variable to determine the status of the operation.

1.Place the variable in a Text Box Display command to display the results at the end of the macro.

2.Use the Variable Modify String command to save the variable results to a text file for later review.

3.Send the results via email to an email account.

üNote: Before using any of these functions, the macro script first requires the FTP Site Connect command to connect to the site. When all FTP actions have been completed, use the FTP Site Disconnect command to disconnect from the site.