Description

The Abort property allows you to stop the execution of a currently running Xceed FTP Library method.

At any time during the execution of an Xceed FTP method, setting the Abort property to True will cause the currently executing method to abort. If the method was called as a background operation (BackgroundProcessing property set to True), the ProcessCompleted event will be triggered with the FTP_E_OPERATIONABORTED result code. If the method was called as a foreground operation, (BackgroundProcessing property set to False) the method call will return with the aforementioned result code.

The Abort property is automatically set back to False whenever a new method is called.

In order to properly terminate the current operation, the library’s response to the Abort property is not always instantaneous.

Data type

Boolean

Default value

False

Remarks

When aborting a method call that is waiting for a reply from an FTP server, the first time that Abort is set to true, the data connection will be cut and the ABOR command sent to the server. If this does not allow the method to return, then setting the Abort property to true a second time will completely disconnect Xceed FTP from the server.

HRESULT Abort( [out, retval] VARIANT_BOOL* pbVal );
HRESULT Abort( [in] VARIANT_BOOL bVal );

See also

CurrentState property (To find out what the current operation being executed is)

SendTelnetSignals property (Indicates if special Telnet signals are sent before sending an ABOR command.)