|
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-4718B87C-0FFF-48EC-A47F-5C9F8C2E2A51"/><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-CABB28B8-D2B1-496B-BD7E-34FF496E60B4"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4"/><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-C2E995C2-535C-41A2-B69D-D36009BBE8C4"><span>IDataSource.</span>GetList()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>GetList</code> method retrieves a list of available |
|
9 calendars or calendar entries. Calendar entries are retrieved from the specified |
|
10 calendar or, if no calendar is specified, from the default one.</p> |
|
11 <p>This is a synchronous method.</p> |
|
12 <p><strong>Syntax:</strong></p> |
|
13 <pre class="codeblock" id="GUID-7A329D3F-C954-4E6C-AD94-4F0B2FA4F683">result = so.IDataSource.GetList(criteria);</pre> |
|
14 |
|
15 <p><strong>Arguments:</strong></p> |
|
16 <ul> |
|
17 <li><p><code>criteria</code>:</p> |
|
18 |
|
19 <p>This is an object that specifies what calendar information is returned. |
|
20 For more information about the object properties and how to define them, see |
|
21 section <a href="GUID-00DB3F96-E09F-4CA2-B02D-598EAEF214FF.html#GUID-00DB3F96-E09F-4CA2-B02D-598EAEF214FF">Criteria for retrieving calendar information</a>.</p> |
|
22 |
|
23 </li> |
|
24 </ul> |
|
25 <p><strong>Return value:</strong></p> |
|
26 <p>The <code>GetList</code> method returns an object that contains |
|
27 the requested calendar information, an error code, and an error message.</p> |
|
28 <div class="tablenoborder"><a name="GUID-68B2C1AA-B88F-4F8A-895F-48563DD70A35"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-68B2C1AA-B88F-4F8A-895F-48563DD70A35" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
29 properties for GetList</caption> |
|
30 |
|
31 <thead align="left"> |
|
32 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e20418"> |
|
33 <p>Property</p> |
|
34 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e20423"> |
|
35 <p>Description</p> |
|
36 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e20428"> |
|
37 <p>Value</p> |
|
38 </th></tr> |
|
39 </thead> |
|
40 <tbody> |
|
41 <tr class=""> |
|
42 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20418 "> |
|
43 <p><code>result.ReturnValue</code></p> |
|
44 </td> |
|
45 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20423 "> |
|
46 <p>This is an iterator that contains the requested calendar information.</p> |
|
47 </td> |
|
48 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20428 "> |
|
49 <p>See <a href="GUID-10DA851F-1022-4B8C-8F01-F4242AD6EA08.html#GUID-10DA851F-1022-4B8C-8F01-F4242AD6EA08">Returned calendar information</a>.</p> |
|
50 </td> |
|
51 </tr> |
|
52 <tr class="bg "> |
|
53 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20418 "> |
|
54 <p><code>result.ErrorCode</code></p> |
|
55 </td> |
|
56 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20423 "> |
|
57 <p>This is a number that specifies a predefined error code.</p> |
|
58 </td> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20428 "> |
|
60 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
61 </td> |
|
62 </tr> |
|
63 <tr class=""> |
|
64 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20418 "> |
|
65 <p><code>result.ErrorMessage</code></p> |
|
66 </td> |
|
67 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20423 "> |
|
68 <p>This is a text string that describes the error.</p> |
|
69 </td> |
|
70 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20428 "> |
|
71 <p>See <a href="GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35.html#GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35">Calendar Service API error messages</a>.</p> |
|
72 </td> |
|
73 </tr> |
|
74 </tbody> |
|
75 </table></div> |
|
76 <p><strong>Remarks:</strong></p> |
|
77 <ul> |
|
78 <li><p>If entries are retrieved from a calendar other than the default |
|
79 one, the corresponding calendar file must exist on the device.</p></li> |
|
80 <li><p>For detailed information about calendar entries, see section <a href="GUID-798E9CA0-2A46-4D10-B567-04C9567500F4.html#GUID-798E9CA0-2A46-4D10-B567-04C9567500F4">Calendar entries</a>.</p></li> |
|
81 </ul> |
|
82 <p><strong>Example code:</strong></p> |
|
83 <p/> |
|
84 <p>For the complete source of a sample widget |
|
85 that demonstrates how to use this Service API, see <a href="GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3.html#GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3">the full example</a>.</p> |
|
86 |
|
87 |
|
88 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |