org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206.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.Calculate()"/><meta name="DC.Relation" scheme="URI" content="GUID-7A466B60-88DD-4A3A-B64C-E7300D42DA56"/><meta name="DC.Relation" scheme="URI" content="GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5"/><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-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206"/><title>ILocation.Calculate() </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-DBEE8177-7246-4FEE-A0F1-D6AEEA6EA206"><span>ILocation.</span>Calculate()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>Calculate</code> method performs mathematical calculations
based on a source location and a target location.</p>
<p>This is a synchronous method.</p>
<p><strong>Syntax:</strong></p>
<pre class="codeblock" id="GUID-627D156A-C30C-4F1D-9FA0-617791185B38">result = so.ILocation.Calculate(criteria);</pre>

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

<p>This is an object that specifies the mathematical operation to perform
and the input values to use in the operation. For more information about the
object properties and how to define them, see section <a href="GUID-9115340A-5D15-4139-A236-945D199583AF.html#GUID-9115340A-5D15-4139-A236-945D199583AF">Calculation criteria</a>.</p>

</li>
</ul>
<p><strong>Return value:</strong></p>
<p>The <code>Calculate</code> method returns an object that contains
the calculation results, an error code, and an error message.</p>
<div class="tablenoborder"><a name="GUID-8DF5C599-28D0-49B0-BD51-67B0E048A4E6"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-8DF5C599-28D0-49B0-BD51-67B0E048A4E6" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for Calculate</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e48873">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e48878">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e48883">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48873 ">
<p><code>result.ReturnValue</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48878 ">
<p>This contains the results for the requested mathematical operation.
The type of the value depends on the operation.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48883 ">
<p>See <a href="GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F.html#GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F">Calculation results</a>.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48873 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48878 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48883 ">
<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="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48873 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48878 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48883 ">
<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>Remarks:</strong></p>
<p>The <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" target="_blank">WGS
84 datum</a> is used to reference coordinates.</p>
<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>