Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007.html
changeset 229 716254ccbcc0 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007.html	Fri Mar 05 19:11:15 2010 -0800
@@ -0,0 +1,159 @@
+
+<!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-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">
+      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-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"><span>IDataSource.</span>GetList()</h1><div>
+<p><strong>Description:</strong></p>
+<p>The <code>GetList</code> method retrieves a list of contacts,
+contact groups, or contacts databases. Contacts and contact groups are retrieved
+from the specified contacts database or, if no database is specified, from
+the default one.</p>
+<p>This method can be called both synchronously and asynchronously.</p>
+<div class="note"><p><strong class="note_title">Note: </strong>Calls that retrieve a list of databases must always be synchronous.</p>
+</div>
+<p><strong>Syntax:</strong></p>
+<p>For synchronous calls:</p>
+<pre class="codeblock" id="GUID-5017A498-4BF1-48C1-B6AD-44DB3DC7436E">result = so.IDataSource.GetList(criteria);</pre>
+
+<p>For asynchronous calls:</p>
+<pre class="codeblock" id="GUID-22320C1F-DC1F-4D35-BDFE-25E12DA64321">result = so.IDataSource.GetList(criteria, callback);</pre>
+
+<p><strong>Arguments:</strong></p>
+<ul>
+<li><p><code>criteria</code>:</p>
+
+<p>This is an object that specifies what contact information is returned
+and how the returned information is sorted. For more information about the
+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>
+
+</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>GetList</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>GetList</code> call.</p>
+
+</li>
+</ul>
+<p><strong>Return value:</strong></p>
+<p>If synchronous, the <code>GetList</code> method returns an object
+that contains the requested contact information, an error code, and an error
+message.</p>
+<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
+properties for a synchronous GetList</caption>
+<thead align="left">
+<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30554">
+<p>Property</p>
+</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30559">
+<p>Description</p>
+</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30564">
+<p>Value</p>
+</th></tr>
+</thead>
+<tbody>
+<tr class="">
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30554 ">
+<p><code>result.ReturnValue</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30559 ">
+<p>This is an iterator that contains the requested contact information.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30564 ">
+<p>See <a href="GUID-CD495D49-E492-4E88-833D-29EF222B097F.html#GUID-CD495D49-E492-4E88-833D-29EF222B097F">Returned contact information</a>.</p>
+</td>
+</tr>
+<tr class="bg ">
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30554 ">
+<p><code>result.ErrorCode</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30559 ">
+<p>This is a number that specifies a predefined error code.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30564 ">
+<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="d0e30554 ">
+<p><code>result.ErrorMessage</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30559 ">
+<p>This is a text string that describes the error.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30564 ">
+<p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p>If asynchronous, the <code>GetList</code> method returns an
+object that contains the initial return value for the asynchronous call it
+started (see the following table). The actual contact 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-CD495D49-E492-4E88-833D-29EF222B097F.html#GUID-CD495D49-E492-4E88-833D-29EF222B097F">Returned contact information</a>.</p>
+<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
+properties for an asynchronous GetList</caption>
+
+<thead align="left">
+<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30676">
+<p>Property</p>
+</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30681">
+<p>Description</p>
+</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e30686">
+<p>Value</p>
+</th></tr>
+</thead>
+<tbody>
+<tr class="">
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30676 ">
+<p><code>result.TransactionID</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30681 ">
+<p>This is a number used as an identification to match transactions started
+with the asynchronous <code>GetList</code> call to one or more calls
+it generates to <code>callback</code>.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30686 ">&nbsp;</td>
+</tr>
+<tr class="bg ">
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30676 ">
+<p><code>result.ErrorCode</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30681 ">
+<p>This is a number that specifies a predefined error code.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30686 ">
+<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="d0e30676 ">
+<p><code>result.ErrorMessage</code></p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30681 ">
+<p>This is a text string that describes the error.</p>
+</td>
+<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e30686 ">
+<p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p><strong>Remarks:</strong></p>
+<p>The default contacts database is <code>cntdb://c:contacts.cdb</code>.
+The SIM card database is <code>sim://global_adn</code>.</p>
+<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-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1.html#GUID-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1">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
FCL/sftools/dev/eclipseenv/wrttools