|
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.GetLocation()"/><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-150E440F-56E4-4249-8739-A5A7A2050600"/><title>ILocation.GetLocation() </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-150E440F-56E4-4249-8739-A5A7A2050600"><span>ILocation.</span>GetLocation()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetLocation</code> method retrieves the current location |
|
9 of the device.</p> |
|
10 <p>This method can be called both synchronously and asynchronously.</p> |
|
11 <p><strong>Syntax:</strong></p> |
|
12 <p>For synchronous calls:</p> |
|
13 <pre class="codeblock" id="GUID-7CD9AD3A-D065-4F76-A3FF-D524249CBF65-GENIDd0e47808">result = so.ILocation.GetLocation(criteria);</pre> |
|
14 |
|
15 <p>For asynchronous calls:</p> |
|
16 <pre class="codeblock" id="GUID-F1140A2E-9B60-4953-8C6E-1A6C47461241-GENIDd0e47814">result = so.ILocation.GetLocation(criteria, callback);</pre> |
|
17 |
|
18 <p><strong>Arguments:</strong></p> |
|
19 <ul> |
|
20 <li><p><code>criteria</code>:</p> |
|
21 |
|
22 <p>This is an object that specifies what type of device location information |
|
23 is returned and how. For more information about the object properties and |
|
24 how to define them, see section <a href="GUID-4541E532-CC1A-4115-8467-7FA1C4378307.html#GUID-4541E532-CC1A-4115-8467-7FA1C4378307">Criteria for retrieving location information</a>.</p> |
|
25 |
|
26 </li> |
|
27 <li><p><code>callback</code>:</p> |
|
28 |
|
29 <p>The <code>callback</code> argument is the name of the method |
|
30 that is executed when an asynchronous <code>GetLocation</code> call |
|
31 has results or status information to return. You must define this method separately. |
|
32 Follow the instructions in section <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608">Defining the callback handler for an asynchronous method</a> to |
|
33 define the <code>callback</code> method.</p> |
|
34 <p>This argument is used only with an asynchronous <code>GetLocation</code> call.</p> |
|
35 |
|
36 </li> |
|
37 </ul> |
|
38 <p><strong>Return value:</strong></p> |
|
39 <p>If synchronous, the <code>GetLocation</code> method returns |
|
40 an object that contains the requested location information, an error code, |
|
41 and an error message.</p> |
|
42 <div class="tablenoborder"><a name="GUID-B8FBADEC-F18E-4055-8BAA-9CC36071CF30"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-B8FBADEC-F18E-4055-8BAA-9CC36071CF30" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
43 properties for a synchronous GetLocation</caption> |
|
44 <thead align="left"> |
|
45 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47242"> |
|
46 <p>Property</p> |
|
47 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47247"> |
|
48 <p>Description</p> |
|
49 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47252"> |
|
50 <p>Value</p> |
|
51 </th></tr> |
|
52 </thead> |
|
53 <tbody> |
|
54 <tr class=""> |
|
55 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47242 "> |
|
56 <p><code>result.ReturnValue</code></p> |
|
57 </td> |
|
58 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47247 "> |
|
59 <p>This is an object that contains the requested location information.</p> |
|
60 </td> |
|
61 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47252 "> |
|
62 <p>See <a href="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B.html#GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B">Returned location information</a>.</p> |
|
63 </td> |
|
64 </tr> |
|
65 <tr class="bg "> |
|
66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47242 "> |
|
67 <p><code>result.ErrorCode</code></p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47247 "> |
|
70 <p>This is a number that specifies a predefined error code.</p> |
|
71 </td> |
|
72 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47252 "> |
|
73 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
74 </td> |
|
75 </tr> |
|
76 <tr class=""> |
|
77 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47242 "> |
|
78 <p><code>result.ErrorMessage</code></p> |
|
79 </td> |
|
80 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47247 "> |
|
81 <p>This is a text string that describes the error.</p> |
|
82 </td> |
|
83 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47252 "> |
|
84 <p>See <a href="GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89.html#GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89">Location Service API error messages</a>.</p> |
|
85 </td> |
|
86 </tr> |
|
87 </tbody> |
|
88 </table></div> |
|
89 <p>If asynchronous, the <code>GetLocation</code> method returns |
|
90 an object that contains the initial return value for the asynchronous call |
|
91 it started (see the following table). The actual location information is returned |
|
92 by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
93 in the <code>ReturnValue</code> property of its result object. The |
|
94 returned information is described in section <a href="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B.html#GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B">Returned location information</a>.</p> |
|
95 <div class="tablenoborder"><a name="GUID-2B366CA4-628F-41E0-AD55-0B2A882457E5"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-2B366CA4-628F-41E0-AD55-0B2A882457E5" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
96 properties for an asynchronous GetLocation</caption> |
|
97 |
|
98 <thead align="left"> |
|
99 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47364"> |
|
100 <p>Property</p> |
|
101 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47369"> |
|
102 <p>Description</p> |
|
103 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47374"> |
|
104 <p>Value</p> |
|
105 </th></tr> |
|
106 </thead> |
|
107 <tbody> |
|
108 <tr class=""> |
|
109 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47364 "> |
|
110 <p><code>result.TransactionID</code></p> |
|
111 </td> |
|
112 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47369 "> |
|
113 <p>This is a number used as an identification to match transactions started |
|
114 with the asynchronous <code>GetLocation</code> call to one or more |
|
115 calls it generates to <code>callback</code>.</p> |
|
116 </td> |
|
117 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47374 "> </td> |
|
118 </tr> |
|
119 <tr class="bg "> |
|
120 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47364 "> |
|
121 <p><code>result.ErrorCode</code></p> |
|
122 </td> |
|
123 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47369 "> |
|
124 <p>This is a number that specifies a predefined error code.</p> |
|
125 </td> |
|
126 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47374 "> |
|
127 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
128 </td> |
|
129 </tr> |
|
130 <tr class=""> |
|
131 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47364 "> |
|
132 <p><code>result.ErrorMessage</code></p> |
|
133 </td> |
|
134 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47369 "> |
|
135 <p>This is a text string that describes the error.</p> |
|
136 </td> |
|
137 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47374 "> |
|
138 <p>See <a href="GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89.html#GUID-DEA4164E-5F03-4B57-97B9-4C6238481F89">Location Service API error messages</a>.</p> |
|
139 </td> |
|
140 </tr> |
|
141 </tbody> |
|
142 </table></div> |
|
143 <p><strong>Remarks:</strong></p> |
|
144 <ul> |
|
145 <li><p>The availability of specific location information depends |
|
146 on the underlying GPS technology. Other factors, such as the number of satellites |
|
147 available for a location fix, also affect what information can be returned. |
|
148 You can change the positioning system used by an S60 device from the <strong>Settings |
|
149 > General > Positioning > Positioning methods</strong> menu.</p></li> |
|
150 <li><p>It takes time to retrieve the initial position fix. Subsequent |
|
151 requests are faster.</p></li> |
|
152 </ul> |
|
153 <p><strong>Example code:</strong></p> |
|
154 <p/> |
|
155 <p>For the complete source of a sample widget |
|
156 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 |
|
157 full example</a>.</p> |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |