|
1 |
|
2 <!DOCTYPE html |
|
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <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"> |
|
5 function initPage() {} |
|
6 </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> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Calculate</code> method performs mathematical calculations |
|
9 based on a source location and a target location.</p> |
|
10 <p>This is a synchronous method.</p> |
|
11 <p><strong>Syntax:</strong></p> |
|
12 <pre class="codeblock" id="GUID-627D156A-C30C-4F1D-9FA0-617791185B38">result = so.ILocation.Calculate(criteria);</pre> |
|
13 |
|
14 <p><strong>Arguments:</strong></p> |
|
15 <ul> |
|
16 <li><p><code>criteria</code>:</p> |
|
17 |
|
18 <p>This is an object that specifies the mathematical operation to perform |
|
19 and the input values to use in the operation. For more information about the |
|
20 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> |
|
21 |
|
22 </li> |
|
23 </ul> |
|
24 <p><strong>Return value:</strong></p> |
|
25 <p>The <code>Calculate</code> method returns an object that contains |
|
26 the calculation results, an error code, and an error message.</p> |
|
27 <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 |
|
28 properties for Calculate</caption> |
|
29 <thead align="left"> |
|
30 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e48873"> |
|
31 <p>Property</p> |
|
32 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e48878"> |
|
33 <p>Description</p> |
|
34 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e48883"> |
|
35 <p>Value</p> |
|
36 </th></tr> |
|
37 </thead> |
|
38 <tbody> |
|
39 <tr class=""> |
|
40 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48873 "> |
|
41 <p><code>result.ReturnValue</code></p> |
|
42 </td> |
|
43 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48878 "> |
|
44 <p>This contains the results for the requested mathematical operation. |
|
45 The type of the value depends on the operation.</p> |
|
46 </td> |
|
47 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48883 "> |
|
48 <p>See <a href="GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F.html#GUID-B1BFA47E-DAC0-40B1-898E-B3FCE14AE78F">Calculation results</a>.</p> |
|
49 </td> |
|
50 </tr> |
|
51 <tr class="bg "> |
|
52 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48873 "> |
|
53 <p><code>result.ErrorCode</code></p> |
|
54 </td> |
|
55 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48878 "> |
|
56 <p>This is a number that specifies a predefined error code.</p> |
|
57 </td> |
|
58 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48883 "> |
|
59 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
60 </td> |
|
61 </tr> |
|
62 <tr class=""> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48873 "> |
|
64 <p><code>result.ErrorMessage</code></p> |
|
65 </td> |
|
66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48878 "> |
|
67 <p>This is a text string that describes the error.</p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e48883 "> |
|
70 <p>See <a href="GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89.html#GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89">Location Service API error messages</a>.</p> |
|
71 </td> |
|
72 </tr> |
|
73 </tbody> |
|
74 </table></div> |
|
75 <p><strong>Remarks:</strong></p> |
|
76 <p>The <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" target="_blank">WGS |
|
77 84 datum</a> is used to reference coordinates.</p> |
|
78 <p><strong>Example code:</strong></p> |
|
79 <p/> |
|
80 <p>For the complete source of a sample widget |
|
81 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 |
|
82 full example</a>.</p> |
|
83 |
|
84 |
|
85 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |