org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-270C6C2A-5EBB-4ACC-A231-064F17E85F4A.html
<!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.Delete()"/><meta name="DC.Relation" scheme="URI" content="GUID-D19BB894-371A-4D55-A047-3B2F97673F5F"/><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-270C6C2A-5EBB-4ACC-A231-064F17E85F4A"/><title>IDataSource.Delete() </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-270C6C2A-5EBB-4ACC-A231-064F17E85F4A"><span>IDataSource.</span>Delete()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>Delete</code> method deletes a calendar from the device
or one or more entries from a calendar. Entries are deleted from the specified
calendar or, if no calendar is specified, from the default one.</p>
<p>For deleting a calendar, this method is called synchronously. For deleting
calendar entries, 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-13F75024-C303-4EF3-9789-B417233B35C8">result = so.IDataSource.Delete(criteria);</pre>
<p>For asynchronous calls:</p>
<pre class="codeblock" id="GUID-CA0558EF-F29E-4C1B-87D3-17401F7BF327">result = so.IDataSource.Delete(criteria, callback);</pre>
<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>
<p>This is an object that specifies which calendar or calendar entries
to delete. For more information about the object properties and how to define
them, see section <a href="GUID-11652F7C-4A0A-432D-A7BE-E9C27C32319A.html#GUID-11652F7C-4A0A-432D-A7BE-E9C27C32319A">Criteria for deleting calendar 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>Delete</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>Delete</code> call.</p>
</li>
</ul>
<p><strong>Return value:</strong></p>
<p>If synchronous, the <code>Delete</code> method returns an object
that contains an error code and an error message.</p>
<p>If asynchronous, the method returns an object that contains a transaction
ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance,
an error code, and an error message. When the asynchronous call has completed, <code>callback</code> returns
an object that contains an error code and an error message (see <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-E43BC9EA-3EBE-4C7F-A57E-A1C33BB01CF4">Table: Callback return value</a>).</p>
<div class="tablenoborder"><a name="GUID-34D94D5C-4C91-4A51-8F35-3C6DC24DBCA1"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-34D94D5C-4C91-4A51-8F35-3C6DC24DBCA1" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
properties for Delete</caption>
<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e22231">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e22236">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e22241">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22231 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22236 ">
<p>This is a number used as an identification to match transactions started
with an asynchronous <code>Delete</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="d0e22241 "> </td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22231 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22236 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22241 ">
<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="d0e22231 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22236 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e22241 ">
<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>The default calendar cannot be deleted.</p></li>
<li><p>To delete a calendar or entries from a calendar, the corresponding
calendar file must exist on the device.</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>