org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-7A466B60-88DD-4A3A-B64C-E7300D42DA56.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Fri, 11 Jun 2010 13:33:03 -0700
changeset 372 1e408ee32d8a
parent 229 716254ccbcc0
permissions -rw-r--r--
Added templates for WRT 1.1 platform services


<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="ILocation.CancelNotification()"/><meta name="DC.Relation" scheme="URI" content="GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89"/><meta name="DC.Relation" scheme="URI" content="GUID-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-53CE4DE6-F065-4339-8C18-5C30A9540053"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-7A466B60-88DD-4A3A-B64C-E7300D42DA56"/><title>ILocation.CancelNotification() </title><script type="text/javascript">
      function initPage() {}
    </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-7A466B60-88DD-4A3A-B64C-E7300D42DA56"><span>ILocation.</span>CancelNotification()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>CancelNotification</code> method cancels an outstanding
asynchronous call.</p>
<p>This is a synchronous method.</p>
<p><strong>Syntax:</strong></p>
<pre class="codeblock" id="GUID-A0E09CE5-18A6-47FF-853B-1D0168AD7C33-GENIDd0e50583">result = so.ILocation.CancelNotification(criteria);</pre>

<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>

<p>This is an object that specifies whether to cancel a <a href="GUID-150E440F-56E4-4249-8739-A5A7A2050600.html#GUID-150E440F-56E4-4249-8739-A5A7A2050600"><code>GetLocation</code></a> call or a <a href="GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5.html#GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5"><code>Trace</code></a> call.
The object must contain the <code>CancelRequestType</code> property
(string) that is used to specify the type of call to cancel. The possible
values for <code>criteria.CancelRequestType</code> are:</p>
<ul>
<li><p><code>"GetLocCancel"</code> cancels an asynchronous <code>GetLocation</code> call.</p>
</li>
<li><p><code>"TraceCancel"</code> cancels a <code>Trace</code> call.</p>
</li>
</ul>

</li>
</ul>
<p><strong>Return value:</strong></p>
<p>The <code>CancelNotification</code> method returns an object
that contains an error code and an error message.</p>
<div class="tablenoborder"><a name="GUID-6BFF20CA-BCDC-4498-BD31-CE8EA3CB9542"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-6BFF20CA-BCDC-4498-BD31-CE8EA3CB9542" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for CancelNotification</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e49996">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e50001">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e50006">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e49996 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e50001 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e50006 ">
<p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e49996 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e50001 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e50006 ">
<p>See <a href="GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89.html#GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89">Location Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Example code:</strong></p>
<p/>
<p>For the complete source of a sample widget
that demonstrates how to use this Service API, see <a href="GUID-620340F8-F844-445E-80AA-71C757320B7E.html#GUID-620340F8-F844-445E-80AA-71C757320B7E">the full example</a>.</p>


</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>