plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4.html
changeset 470 d4809db37847
parent 229 716254ccbcc0
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-C2E995C2-535C-41A2-B69D-D36009BBE8C4.html	Thu Aug 19 17:48:04 2010 -0700
@@ -0,0 +1,88 @@
+
+<!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="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">
+      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-C2E995C2-535C-41A2-B69D-D36009BBE8C4"><span>IDataSource.</span>GetList()</h1><div>
+<p><strong>Description:</strong></p>
+<p>The <code>GetList</code> method retrieves a list of available
+calendars or calendar entries. Calendar entries are retrieved from the specified
+calendar or, if no calendar is specified, from the default one.</p>
+<p>This is a synchronous method.</p>
+<p><strong>Syntax:</strong></p>
+<pre class="codeblock" id="GUID-7A329D3F-C954-4E6C-AD94-4F0B2FA4F683">result = so.IDataSource.GetList(criteria);</pre>
+
+<p><strong>Arguments:</strong></p>
+<ul>
+<li><p><code>criteria</code>:</p>
+
+<p>This is an object that specifies what calendar information is returned.
+For more information about the object properties and how to define them, see
+section <a href="GUID-00DB3F96-E09F-4CA2-B02D-598EAEF214FF.html#GUID-00DB3F96-E09F-4CA2-B02D-598EAEF214FF">Criteria for retrieving calendar information</a>.</p>
+
+</li>
+</ul>
+<p><strong>Return value:</strong></p>
+<p>The <code>GetList</code> method returns an object that contains
+the requested calendar information, an error code, and an error message.</p>
+<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
+properties for GetList</caption>
+
+<thead align="left">
+<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e20418">
+<p>Property</p>
+</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e20423">
+<p>Description</p>
+</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e20428">
+<p>Value</p>
+</th></tr>
+</thead>
+<tbody>
+<tr class="">
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20418 ">
+<p><code>result.ReturnValue</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20423 ">
+<p>This is an iterator that contains the requested calendar information.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20428 ">
+<p>See <a href="GUID-10DA851F-1022-4B8C-8F01-F4242AD6EA08.html#GUID-10DA851F-1022-4B8C-8F01-F4242AD6EA08">Returned calendar information</a>.</p>
+</td>
+</tr>
+<tr class="bg ">
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20418 ">
+<p><code>result.ErrorCode</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20423 ">
+<p>This is a number that specifies a predefined error code.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20428 ">
+<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="d0e20418 ">
+<p><code>result.ErrorMessage</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20423 ">
+<p>This is a text string that describes the error.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e20428 ">
+<p>See <a href="GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35.html#GUID-92BD4759-43FA-482F-A12B-3F5607D4AA35">Calendar Service API error messages</a>.</p>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p><strong>Remarks:</strong></p>
+<ul>
+<li><p>If entries are retrieved from a calendar other than the default
+one, the corresponding calendar file must exist on the device.</p></li>
+<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>
+</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-7C0890BC-7931-417B-B4AC-6E77E65A10F3.html#GUID-7C0890BC-7931-417B-B4AC-6E77E65A10F3">the full example</a>.</p>
+
+
+</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>
\ No newline at end of file