|
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-20D66938-A870-43D7-9515-AC7E22AEDC14"/><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-A5853293-7B83-4CCE-9C29-B2B8F0CD8A18"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"/><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-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"><span>IDataSource.</span>GetList()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetList</code> method retrieves a list of contacts, |
|
9 contact groups, or contacts databases. Contacts and contact groups are retrieved |
|
10 from the specified contacts database or, if no database is specified, from |
|
11 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>Calls that retrieve a list of databases must always be synchronous.</p> |
|
14 </div> |
|
15 <p><strong>Syntax:</strong></p> |
|
16 <p>For synchronous calls:</p> |
|
17 <pre class="codeblock" id="GUID-5017A498-4BF1-48C1-B6AD-44DB3DC7436E">result = so.IDataSource.GetList(criteria);</pre> |
|
18 |
|
19 <p>For asynchronous calls:</p> |
|
20 <pre class="codeblock" id="GUID-22320C1F-DC1F-4D35-BDFE-25E12DA64321">result = so.IDataSource.GetList(criteria, callback);</pre> |
|
21 |
|
22 <p><strong>Arguments:</strong></p> |
|
23 <ul> |
|
24 <li><p><code>criteria</code>:</p> |
|
25 |
|
26 <p>This is an object that specifies what contact information is returned |
|
27 and how the returned information is sorted. For more information about the |
|
28 object properties and how to define them, see section <a href="GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425.html#GUID-06C803FE-DD16-44B5-B9C7-2EC9D497D425">Criteria for retrieving contact information</a>.</p> |
|
29 |
|
30 </li> |
|
31 <li><p><code>callback</code>:</p> |
|
32 |
|
33 <p>The <code>callback</code> argument is the name of the method |
|
34 that is executed when an asynchronous <code>GetList</code> call has |
|
35 results or status information to return. You must define this method separately. |
|
36 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 |
|
37 define the <code>callback</code> method.</p> |
|
38 <p>This argument is used only with an asynchronous <code>GetList</code> call.</p> |
|
39 |
|
40 </li> |
|
41 </ul> |
|
42 <p><strong>Return value:</strong></p> |
|
43 <p>If synchronous, the <code>GetList</code> method returns an object |
|
44 that contains the requested contact information, an error code, and an error |
|
45 message.</p> |
|
46 <div class="tablenoborder"><a name="GUID-B0319288-FE3F-4579-A39F-2ADFC2A36C4E"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-B0319288-FE3F-4579-A39F-2ADFC2A36C4E" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
47 properties for a synchronous GetList</caption> |
|
48 <thead align="left"> |
|
49 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30554"> |
|
50 <p>Property</p> |
|
51 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30559"> |
|
52 <p>Description</p> |
|
53 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30564"> |
|
54 <p>Value</p> |
|
55 </th></tr> |
|
56 </thead> |
|
57 <tbody> |
|
58 <tr class=""> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30554 "> |
|
60 <p><code>result.ReturnValue</code></p> |
|
61 </td> |
|
62 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30559 "> |
|
63 <p>This is an iterator that contains the requested contact information.</p> |
|
64 </td> |
|
65 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30564 "> |
|
66 <p>See <a href="GUID-CD495D49-E492-4E88-833D-29EF222B097F.html#GUID-CD495D49-E492-4E88-833D-29EF222B097F">Returned contact information</a>.</p> |
|
67 </td> |
|
68 </tr> |
|
69 <tr class="bg "> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30554 "> |
|
71 <p><code>result.ErrorCode</code></p> |
|
72 </td> |
|
73 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30559 "> |
|
74 <p>This is a number that specifies a predefined error code.</p> |
|
75 </td> |
|
76 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30564 "> |
|
77 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
78 </td> |
|
79 </tr> |
|
80 <tr class=""> |
|
81 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30554 "> |
|
82 <p><code>result.ErrorMessage</code></p> |
|
83 </td> |
|
84 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30559 "> |
|
85 <p>This is a text string that describes the error.</p> |
|
86 </td> |
|
87 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30564 "> |
|
88 <p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p> |
|
89 </td> |
|
90 </tr> |
|
91 </tbody> |
|
92 </table></div> |
|
93 <p>If asynchronous, the <code>GetList</code> method returns an |
|
94 object that contains the initial return value for the asynchronous call it |
|
95 started (see the following table). The actual contact information is returned |
|
96 by the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> method |
|
97 in the <code>ReturnValue</code> property of its result object. The |
|
98 returned information is described in section <a href="GUID-CD495D49-E492-4E88-833D-29EF222B097F.html#GUID-CD495D49-E492-4E88-833D-29EF222B097F">Returned contact information</a>.</p> |
|
99 <div class="tablenoborder"><a name="GUID-95A1D66E-A3B6-476B-82B5-A555714CE48D"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-95A1D66E-A3B6-476B-82B5-A555714CE48D" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
100 properties for an asynchronous GetList</caption> |
|
101 |
|
102 <thead align="left"> |
|
103 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30676"> |
|
104 <p>Property</p> |
|
105 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30681"> |
|
106 <p>Description</p> |
|
107 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30686"> |
|
108 <p>Value</p> |
|
109 </th></tr> |
|
110 </thead> |
|
111 <tbody> |
|
112 <tr class=""> |
|
113 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30676 "> |
|
114 <p><code>result.TransactionID</code></p> |
|
115 </td> |
|
116 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30681 "> |
|
117 <p>This is a number used as an identification to match transactions started |
|
118 with the asynchronous <code>GetList</code> call to one or more calls |
|
119 it generates to <code>callback</code>.</p> |
|
120 </td> |
|
121 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30686 "> </td> |
|
122 </tr> |
|
123 <tr class="bg "> |
|
124 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30676 "> |
|
125 <p><code>result.ErrorCode</code></p> |
|
126 </td> |
|
127 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30681 "> |
|
128 <p>This is a number that specifies a predefined error code.</p> |
|
129 </td> |
|
130 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30686 "> |
|
131 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
132 </td> |
|
133 </tr> |
|
134 <tr class=""> |
|
135 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30676 "> |
|
136 <p><code>result.ErrorMessage</code></p> |
|
137 </td> |
|
138 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30681 "> |
|
139 <p>This is a text string that describes the error.</p> |
|
140 </td> |
|
141 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30686 "> |
|
142 <p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p> |
|
143 </td> |
|
144 </tr> |
|
145 </tbody> |
|
146 </table></div> |
|
147 <p><strong>Remarks:</strong></p> |
|
148 <p>The default contacts database is <code>cntdb://c:contacts.cdb</code>. |
|
149 The SIM card database is <code>sim://global_adn</code>.</p> |
|
150 <p><strong>Example code:</strong></p> |
|
151 <p/> |
|
152 <p>For the complete source of a sample widget |
|
153 that demonstrates how to use this Service API, see <a href="GUID-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1.html#GUID-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1">the |
|
154 full example</a>.</p> |
|
155 |
|
156 |
|
157 |
|
158 |
|
159 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |