| INT WINAPI FtpCancel( |
| |
HCLIENT hClient |
|
| ); |
The FtpCancel function cancels any outstanding blocking
operation in the client, causing the blocking function to fail. The
application may then retry the operation or terminate the client
session.
Parameters
- hClient
- Handle to the client session.
Return Value
If the function succeeds, the return value is zero. If the
function fails, the return value is FTP_ERROR. To get extended error
information, call FtpGetLastError.
Remarks
When the FtpCancel function is called, the blocking
function will not immediately fail. An internal flag is set which
causes the blocking operation to exit with an error. This means that
the application cannot cancel an operation and immediately perform
some other operation. Instead it must allow the calling stack to
unwind, returning back to the blocking operation before making any
further function calls.
This function may be called during a blocking file transfer.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Import Library: csftpv11.lib
See Also
FtpIsBlocking
|