SocketTools .NET Edition

DnsClient.Cancel Method 

Cancels the current blocking network operation.

[Visual Basic]
Public Function Cancel() As Boolean
[C#]
public bool Cancel();

Return Value

A boolean value which specifies if the method was successful or not. A return value of True indicates that the method call completed successfully. A return value of False indicates that the method failed and the application should check the value of the LastError property.

Remarks

When the Cancel method is called, the blocked method may not immediately return. 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. It must allow the calling stack to unwind, returning control back to the blocking method before calling any other methods.

Note that if the ThrowError property is set to True, calling the Cancel method will cause the blocked method to raise an exception which must be handled by the application.

See Also

DnsClient Class | SocketTools Namespace