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-F146B956-77AE-41B5-BA17-20F48AF8DBA7.html
author tasneems@symbian.org
Fri, 05 Mar 2010 19:11:15 -0800
changeset 229 716254ccbcc0
permissions -rw-r--r--
Fixed 2046: WRTKit help topics. Fixed 2170: Added support for Web Developer Library. Fixed 1952: Event Trigger icons unreadable


<!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.Add()"/><meta name="DC.Relation" scheme="URI" content="GUID-7E53CD9F-E213-42E7-8569-02AEA1198E52"/><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-F146B956-77AE-41B5-BA17-20F48AF8DBA7"/><title>IDataSource.Add() </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-F146B956-77AE-41B5-BA17-20F48AF8DBA7"><span>IDataSource.</span>Add()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>Add</code> method adds an event (entry) to the event
log database.</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-7CD9AD3A-D065-4F76-A3FF-D524249CBF65-GENIDd0e51563">result = so.IDataSource.Add(criteria);</pre>

<p>For asynchronous calls:</p>
<pre class="codeblock" id="GUID-F1140A2E-9B60-4953-8C6E-1A6C47461241-GENIDd0e51569">result = so.IDataSource.Add(criteria, callback);</pre>

<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>

<p>This is an object that specifies what type of device log entries are
added to the event database and details about the entry. For more information
about the object properties and how to define them, see section <a href="GUID-DDF5BDA7-E0DA-40EB-94E7-30824B0F4365.html#GUID-DDF5BDA7-E0DA-40EB-94E7-30824B0F4365">Criteria for adding a log entry</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>Add</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>Add</code> call.</p>

</li>
</ul>
<p><strong>Return value:</strong></p>
<p>If synchronous, the <code>Add</code> method returns an object
that contains a unique identifier for the log entry, an error code, and an
error message.</p>
<div class="tablenoborder"><a name="GUID-92F92E86-799C-4BE8-A23E-6A2BC57F0E63"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-92F92E86-799C-4BE8-A23E-6A2BC57F0E63" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for a synchronous Add</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" id="d0e50963">
<p>Property</p>
</th><th class="cellrowborder" valign="top" id="d0e50968">
<p>Description</p>
</th><th class="cellrowborder" valign="top" id="d0e50973">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" headers="d0e50963 ">
<p><code>result.ReturnValue</code></p>
</td>
<td class="cellrowborder" valign="top" headers="d0e50968 ">
<p>This is a text string that contains the unique identifier of the log
entry that was added to the event log database.</p>
</td>
<td class="cellrowborder" valign="top" headers="d0e50973 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" headers="d0e50963 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" headers="d0e50968 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" headers="d0e50973 ">
<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" headers="d0e50963 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" headers="d0e50968 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" headers="d0e50973 ">
<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>Add</code> method returns an object
that contains the initial return value from the asynchronous call that it
started (see the following table). The actual logging 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 the preceding table.</p>
<div class="tablenoborder"><a name="GUID-0FFA0367-477E-464F-8602-1BD41CBE9D4E"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-0FFA0367-477E-464F-8602-1BD41CBE9D4E" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for an asynchronous Add</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51077">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51082">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e51087">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51077 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51082 ">
<p>This is a number used as an identification to match transactions started
with the asynchronous <code>Add</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="d0e51087 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51077 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51082 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51087 ">
<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="d0e51077 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51082 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e51087 ">
<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>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