Delete file operation

Remote File Details properties
Connection Settings properties
Delete Operation Result properties
Exceptions

Deletes a file from the FTP server.

For information about the General and Route Evaluation property groups, see Common operation properties.

Remote File Details properties

Properties for defining the file to delete.

Remote File Name

A string value that represents the name of the file to delete. The file name does not include the path to the file. Specify the path using the Remote Directory Path property.

Remote Directory Path

A string value that represents the path to the file to delete. The path does not include the file name. Specify the file name using the Remote File Name property.

Connection Settings properties

Use the Connection Settings properties to specify information required for connecting to the FTP server.

Use Configuration Options

A boolean value that specifies whether to use the settings in the service configuration instead of the settings specified in the properties of the operation. A value of True means to use the default connection settings configured for the FTP service. A value of False means to use the settings configured in the properties for the operation.

If you use a literal value to configure this property, selecting the Use Configuration Options check box means to use the default connection properties that are set for the FTP service. If you want to use the connection settings specified in the operation, deselect the Use Configuration Options check box

Host

A string value that represents the IP address or URI. For example, you can use the name of the computer that is resolved by Domain Naming Scheme (DNS).

Port Number

An int value that represents the port number for transferring files. The default port number is 21.

User

A string value that represents the user name to connect to the FTP server. No default is provided.

Password

A string value that represents the password to use for authenticating with the FTP server. No default is provided.

Delete Operation Result properties

Properties that specify where to save the operation results.

Result

The location to save the operation result. The data type is boolean. A value of True indicates that the file was deleted. A value of False indicates that the file could not be deleted.

Exceptions

The exception event attached to this operation can receive FTPConnectionException, FTPFileUnavailableException, IllegalArgumentException, and IOException exceptions.