| BOOL Cancel( |
| |
SOCKET hSocket |
|
| ); |
The Cancel method cancels any outstanding blocking socket
operation, causing the blocking method to fail. The application may
then retry the operation or terminate the connection.
Parameters
- hSocket
- An optional parameter that specifies the handle to the socket.
If this parameter is omitted, the socket handle for the current
class instance will be used.
Return Value
If the method succeeds, the return value is non-zero. If the method
fails, the return value is zero. To get extended error information,
call GetLastError.
Remarks
When the Cancel method is called, the blocking method 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 method is typically called from within an event handler to signal
that the current blocking operation should stop. It may also be used to
cancel a blocking operation that is occurring on another thread.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header: Include cswsock10.h
Import Library: cswskv10.lib
See Also
Abort,
Disconnect,
IsBlocking
|