|
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="IDataSource.GetList()"/><meta name="DC.Relation" scheme="URI" content="GUID-D85C2567-F041-42A1-A2B5-650FCAAD60A9"/><meta name="DC.Relation" scheme="URI" content="GUID-E138B464-2086-4E74-B356-ACF8687BBB5A"/><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-B8845FF1-D7F6-476A-8651-8B9C12D8789F"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34"/><title>IDataSource.GetList() </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-55591BBC-49F8-407D-98F5-1D2FCD5DFB34"><span>IDataSource.</span>GetList()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetList</code> method retrieves information about |
|
9 landmarks, landmark categories, or landmark databases. Landmarks and landmark |
|
10 categories are retrieved from the specified landmark database or, if no database |
|
11 is specified, from the default one.</p> |
|
12 <p>This method can be called both synchronously and asynchronously.</p> |
|
13 <div class="note"><p><strong class="note_title">Note: </strong>For retrieving information about databases, only synchronous <code>GetList</code> is |
|
14 supported.</p> |
|
15 </div> |
|
16 <p><strong>Syntax:</strong></p> |
|
17 <p>For synchronous calls:</p> |
|
18 |
|
19 <pre class="codeblock" id="GUID-DD166A2E-3858-4E89-8401-438CF7414173">result = so.IDataSource.GetList(criteria);</pre> |
|
20 <p>For asynchronous calls:</p> |
|
21 |
|
22 <pre class="codeblock" id="GUID-56AC7152-6F96-4C30-9CE9-92AAD69C60B3">result = so.IDataSource.GetList(criteria, callback);</pre> |
|
23 <p><strong>Arguments:</strong></p> |
|
24 <ul> |
|
25 <li><p><code>criteria</code>:</p> |
|
26 |
|
27 <p>This is an object that specifies what landmark information is returned |
|
28 and how the returned information is sorted. For more information about the |
|
29 object properties and how to define them, see section <a href="GUID-8074E501-A64A-41F8-B598-05D8B496438F.html#GUID-8074E501-A64A-41F8-B598-05D8B496438F">Criteria for retrieving landmark information</a>.</p> |
|
30 |
|
31 </li> |
|
32 <li><p><code>callback</code>:</p> |
|
33 |
|
34 <p>The <code>callback</code> argument is the name of the method |
|
35 that is executed when an asynchronous <code>GetList</code> call has |
|
36 results or status information to return. You must define this method separately. |
|
37 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 |
|
38 define the <code>callback</code> method.</p> |
|
39 <p>This argument is used only with an asynchronous <code>GetList</code> call.</p> |
|
40 |
|
41 </li> |
|
42 </ul> |
|
43 <p><strong>Return value:</strong></p> |
|
44 <p>If synchronous, the <code>GetList</code> method returns an object |
|
45 that contains the requested landmark information, an error code, and an error |
|
46 message.</p> |
|
47 <div class="tablenoborder"><a name="GUID-F460C206-1FEA-45D5-AC5A-0369D2E356CE"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-F460C206-1FEA-45D5-AC5A-0369D2E356CE" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
48 properties for a synchronous GetList</caption> |
|
49 <thead align="left"> |
|
50 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e39289"> |
|
51 <p>Property</p> |
|
52 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e39294"> |
|
53 <p>Description</p> |
|
54 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e39299"> |
|
55 <p>Value</p> |
|
56 </th></tr> |
|
57 </thead> |
|
58 <tbody> |
|
59 <tr class=""> |
|
60 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39289 "> |
|
61 <p><code>result.ReturnValue</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39294 "> |
|
64 <p>This is an iterator that contains the requested landmark information.</p> |
|
65 </td> |
|
66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39299 "> |
|
67 <p>See <a href="GUID-89A7E790-06F0-488E-B833-AC63B9995E25.html#GUID-89A7E790-06F0-488E-B833-AC63B9995E25">Returned landmark information</a>.</p> |
|
68 </td> |
|
69 </tr> |
|
70 <tr class="bg "> |
|
71 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39289 "> |
|
72 <p><code>result.ErrorCode</code></p> |
|
73 </td> |
|
74 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39294 "> |
|
75 <p>This is a number that specifies a predefined error code.</p> |
|
76 </td> |
|
77 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39299 "> |
|
78 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
79 </td> |
|
80 </tr> |
|
81 <tr class=""> |
|
82 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39289 "> |
|
83 <p><code>result.ErrorMessage</code></p> |
|
84 </td> |
|
85 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39294 "> |
|
86 <p>This is a text string that describes the error.</p> |
|
87 </td> |
|
88 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39299 "> |
|
89 <p>See <a href="GUID-4ECCCBED-DE6D-4366-B037-90E874C4DF5C.html#GUID-4ECCCBED-DE6D-4366-B037-90E874C4DF5C">Landmarks Service API error messages</a>.</p> |
|
90 </td> |
|
91 </tr> |
|
92 </tbody> |
|
93 </table></div> |
|
94 <p>If asynchronous, the <code>GetList</code> method returns an |
|
95 object that contains the initial return value for the asynchronous call it |
|
96 started (see the following table). The actual landmark information is returned |
|
97 by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
98 in the <code>ReturnValue</code> property of its result object. The |
|
99 returned information is described in section <a href="GUID-89A7E790-06F0-488E-B833-AC63B9995E25.html#GUID-89A7E790-06F0-488E-B833-AC63B9995E25">Returned landmark information</a>.</p> |
|
100 <div class="tablenoborder"><a name="GUID-AB68C15D-FCCD-49F5-8EA4-D707749EB94C"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-AB68C15D-FCCD-49F5-8EA4-D707749EB94C" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
101 properties for an asynchronous GetList</caption> |
|
102 |
|
103 <thead align="left"> |
|
104 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e39411"> |
|
105 <p>Property</p> |
|
106 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e39416"> |
|
107 <p>Description</p> |
|
108 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e39421"> |
|
109 <p>Value</p> |
|
110 </th></tr> |
|
111 </thead> |
|
112 <tbody> |
|
113 <tr class=""> |
|
114 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39411 "> |
|
115 <p><code>result.TransactionID</code></p> |
|
116 </td> |
|
117 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39416 "> |
|
118 <p>This is a number used as an identification to match transactions started |
|
119 with the asynchronous <code>GetList</code> call to one or more calls |
|
120 it generates to <code>callback</code>.</p> |
|
121 </td> |
|
122 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39421 "> </td> |
|
123 </tr> |
|
124 <tr class="bg "> |
|
125 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39411 "> |
|
126 <p><code>result.ErrorCode</code></p> |
|
127 </td> |
|
128 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39416 "> |
|
129 <p>This is a number that specifies a predefined error code.</p> |
|
130 </td> |
|
131 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39421 "> |
|
132 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
133 </td> |
|
134 </tr> |
|
135 <tr class=""> |
|
136 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39411 "> |
|
137 <p><code>result.ErrorMessage</code></p> |
|
138 </td> |
|
139 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39416 "> |
|
140 <p>This is a text string that describes the error.</p> |
|
141 </td> |
|
142 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e39421 "> |
|
143 <p>See <a href="GUID-4ECCCBED-DE6D-4366-B037-90E874C4DF5C.html#GUID-4ECCCBED-DE6D-4366-B037-90E874C4DF5C">Landmarks Service API error messages</a>.</p> |
|
144 </td> |
|
145 </tr> |
|
146 </tbody> |
|
147 </table></div> |
|
148 <p><strong>Remarks:</strong></p> |
|
149 <ul> |
|
150 <li><p>If <code>GetList</code> is performed on the default |
|
151 landmark database and it does not exist, it is created and set active. The |
|
152 default database is <code>file://c:eposlm.ldb</code>.</p></li> |
|
153 <li><p>For more information about landmarks, landmark categories, |
|
154 and landmark databases, see the <a href="GUID-D581028C-06ED-422D-866E-AE6C93075084.html#GUID-D581028C-06ED-422D-866E-AE6C93075084">Landmarks |
|
155 Service overview page</a>.</p></li> |
|
156 </ul> |
|
157 <p><strong>Example code:</strong></p> |
|
158 <p/> |
|
159 <p>For the complete source of a sample widget |
|
160 that demonstrates how to use this Service API, see <a href="GUID-11D59F76-EC4C-4297-B262-D5174E826B43.html#GUID-11D59F76-EC4C-4297-B262-D5174E826B43">the |
|
161 full example</a>.</p> |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |