org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-150E440F-56E4-4249-8739-A5A7A2050600.html
<!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.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">
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-150E440F-56E4-4249-8739-A5A7A2050600"><span>ILocation.</span>GetLocation()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>GetLocation</code> method retrieves the current location
of the device.</p>
<p>This method can be called both synchronously and asynchronously.</p>
<p><strong>Syntax:</strong></p>
<p>For synchronous calls:</p>
<pre class="codeblock" id="GUID-7CD9AD3A-D065-4F76-A3FF-D524249CBF65-GENIDd0e47808">result = so.ILocation.GetLocation(criteria);</pre>
<p>For asynchronous calls:</p>
<pre class="codeblock" id="GUID-F1140A2E-9B60-4953-8C6E-1A6C47461241-GENIDd0e47814">result = so.ILocation.GetLocation(criteria, callback);</pre>
<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>
<p>This is an object that specifies what type of device location information
is returned and how. For more information about the object properties and
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>
</li>
<li><p><code>callback</code>:</p>
<p>The <code>callback</code> argument is the name of the method
that is executed when an asynchronous <code>GetLocation</code> call
has results or status information to return. You must define this method separately.
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
define the <code>callback</code> method.</p>
<p>This argument is used only with an asynchronous <code>GetLocation</code> call.</p>
</li>
</ul>
<p><strong>Return value:</strong></p>
<p>If synchronous, the <code>GetLocation</code> method returns
an object that contains the requested location information, an error code,
and an error message.</p>
<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
properties for a synchronous GetLocation</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47242">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47247">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47252">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47242 ">
<p><code>result.ReturnValue</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47247 ">
<p>This is an object that contains the requested location information.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47252 ">
<p>See <a href="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B.html#GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B">Returned location information</a>.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47242 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47247 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47252 ">
<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="d0e47242 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47247 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47252 ">
<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>If asynchronous, the <code>GetLocation</code> method returns
an object that contains the initial return value for the asynchronous call
it started (see the following table). The actual location information is returned
by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method
in the <code>ReturnValue</code> property of its result object. The
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>
<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
properties for an asynchronous GetLocation</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47364">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47369">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e47374">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47364 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47369 ">
<p>This is a number used as an identification to match transactions started
with the asynchronous <code>GetLocation</code> call to one or more
calls it generates to <code>callback</code>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47374 "> </td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47364 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47369 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47374 ">
<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="d0e47364 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47369 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e47374 ">
<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>
<ul>
<li><p>The availability of specific location information depends
on the underlying GPS technology. Other factors, such as the number of satellites
available for a location fix, also affect what information can be returned.
You can change the positioning system used by an S60 device from the <strong>Settings
> General > Positioning > Positioning methods</strong> menu.</p></li>
<li><p>It takes time to retrieve the initial position fix. Subsequent
requests are faster.</p></li>
</ul>
<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>