clearWatch method

Article
05/02/2017

Stops listening for updates to the current geographical location.

Syntax

HRESULT retVal = object.clearWatch(watchId);

Parameters

watchId [in]
Type: long

The ID of the watch operation to cancel. This value is returned by the IWebGeolocation::watchPosition method.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Standards information

Geolocation API Specification, Section 5.1

Remarks

If the watchId parameter does not correspond to any watch process started by a previous call to the IWebGeolocation::watchPosition method, this method returns and no further action is taken.

Windows Internet Explorer 9. This property is supported only for webpages displayed in IE9 Standards mode. For more information, see Defining Document Compatibility.