Click or drag to resize

RelativeSearchOperationTryCancel Method

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
Stop a search that's in progress, typically as a result of a timeout or because the user has cancelled the search. Returns true if the operation was successfully stopped; if the operation lacks the facility to stop itself, it should instead return false, in which case the thread that FindResults was called on will be stopped.

Namespace:  Telogis.GeoBase.Geocoding
Assembly:  geobase.net (in geobase.net.dll) Version: 4.99.0.0
Syntax
Copy
public override bool TryCancel()

Return Value

Type: Boolean
Whether the operation stopped itself.
Remarks

If the operation involves use of unmanaged code, it is important that the operation can stop itself. Otherwise, cancelling a search may result in memory leaks.

TryCancel does not need to guarantee that the operation has stopped before returning when it returns true; it merely needs to guarantee that the operation will stop imminently.

Subclasses of RelativeSearchOperation should ensure they call base.TryCancel if they override this method, which will cancel any inner search that may be running.

See Also