Back to product page

Abort function


Aborts the current method execution.

Type

A Long value. If successful, 0 is returned, otherwise error as specified here

Syntax

  • C
long Sftp_Abort(void *Sftp);
The Abort(void *Sftp) syntax has these parts:
void *SftpHandle of the created Sftp instance.

Remarks

This function aborts the method that is currently executing. This includes file and folder listings, such as ListDir, ListNames, GetFile, PutFile etc..

Once you start a transfer and wish to abort it (for whatever reason), you should call this function. After a short time (it cannot happen immediately) your transfer will stop with an error 30027 (Transfer aborted) and you will be able to resume your operation later. The connection with the server will not be broken.

Platforms

Windows