Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / file revision
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-7E53CD9F-E213-42E7-8569-02AEA1198E52.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Mon, 19 Apr 2010 18:04:34 -0700
changeset 311 eef7c6acd0f3
parent 229 716254ccbcc0
permissions -rw-r--r--
Heads merge


<!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-0022AED9-7B79-4C96-B82E-8B1EDF455E1D"/><meta name="DC.Relation" scheme="URI" content="GUID-F146B956-77AE-41B5-BA17-20F48AF8DBA7"/><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-F003B7DD-E450-49AD-B447-C5132FE47D3C"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-7E53CD9F-E213-42E7-8569-02AEA1198E52"/><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-7E53CD9F-E213-42E7-8569-02AEA1198E52"><span>IDataSource.</span>GetList()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>GetList</code> method retrieves an iterable list of
entries from the log event database. The database contains two types of entries,
log entries (all entries) and recent log entries (a subset of all log entries).</p>
<p>This method can be called both synchronously and asynchronously.</p>
<p><strong>Syntax:</strong></p>
<p>For synchronous calls:</p>
<pre class="codeblock" id="GUID-E5A12B7D-104F-458B-8467-642667CCE541">result = so.IDataSource.GetList(criteria);</pre>

<p>For asynchronous calls:</p>
<pre class="codeblock" id="GUID-C1DA7414-D129-44AD-8E4A-06799616E896">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 information is returned from the
log event database. For more information about the object properties and how
to define them, see section <a href="GUID-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8.html#GUID-258A8E34-56F4-4BF2-8C94-F7BB7FAE71F8">Criteria for retrieving log events</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 log event information, an error code, and an error
message.</p>
<div class="tablenoborder"><a name="GUID-FACAF67F-1BC6-4F78-869F-5AC20DE6F06B"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-FACAF67F-1BC6-4F78-869F-5AC20DE6F06B" 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="d0e51883">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51888">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51893">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51883 ">
<p><code>result.ReturnValue</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51888 ">
<p>This is an iterator that contains the requested log event information.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51893 ">
<p>See <a href="GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C.html#GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C">Returned log event information</a>.</p>
</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51883 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51888 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51893 ">
<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="d0e51883 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51888 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51893 ">
<p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging 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 from the asynchronous call that
it started (see the following table). The actual 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-F22F30CF-0BCB-4720-9F47-691BDC517E5C.html#GUID-F22F30CF-0BCB-4720-9F47-691BDC517E5C">Returned log event information</a>.</p>
<div class="tablenoborder"><a name="GUID-661668C1-0762-4A01-8BD2-6C925B02F8BF"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-661668C1-0762-4A01-8BD2-6C925B02F8BF" 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="d0e52005">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e52010">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e52015">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52005 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52010 ">
<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>
<p>This property is only valid for asynchronous calls.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52015 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52005 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52010 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52015 ">
<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="d0e52005 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52010 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e52015 ">
<p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Remarks:</strong></p>
<p>To access information about individual log events, iterate through the
list of objects contained in <code>result.ReturnValue</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-9C85B403-6CFC-4E17-A2B2-AD1AD2F7794D.html#GUID-9C85B403-6CFC-4E17-A2B2-AD1AD2F7794D">the
full example</a>.</p>




</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>
FCL/sftools/dev/eclipseenv/wrttools