org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-0022AED9-7B79-4C96-B82E-8B1EDF455E1D.html
changeset 229 716254ccbcc0
equal deleted inserted replaced
228:913c9751c067 229:716254ccbcc0
       
     1 
       
     2 <!DOCTYPE html
       
     3   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 <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-894E87F7-7146-44DD-8CAF-60F7C446B0D8"/><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-0022AED9-7B79-4C96-B82E-8B1EDF455E1D"/><title>IDataSource.Delete() </title><script type="text/javascript">
       
     5       function initPage() {}
       
     6     </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-0022AED9-7B79-4C96-B82E-8B1EDF455E1D"><span>IDataSource.</span>Delete()</h1><div>
       
     7 <p><strong>Description:</strong></p>
       
     8 <p>The <code>Delete</code> method deletes an event (entry) from
       
     9 the event log database. </p>
       
    10 <p>This method can be called both synchronously and asynchronously.</p>
       
    11 <p><strong>Syntax:</strong></p>
       
    12 <p>For synchronous calls:</p>
       
    13 <pre class="codeblock" id="GUID-272D8E40-83BF-4C46-9CDF-E385832FF8A2">result = so.IDataSource.Delete(criteria);</pre>
       
    14 
       
    15 <p>For asynchronous calls:</p>
       
    16 <pre class="codeblock" id="GUID-2C3A0D6F-B710-4747-B530-D03852585034">result = so.IDataSource.Delete(criteria, callback);</pre>
       
    17 
       
    18 <p><strong>Arguments:</strong></p>
       
    19 <ul>
       
    20 <li><p><code>criteria</code>:</p>
       
    21 
       
    22 <p>This is an object that specifies which event to delete from the log
       
    23 event database. For more information about the object properties and how to
       
    24 define them, see section <a href="GUID-59A3DC52-36FB-4A05-8D37-0305AE4B80D0.html#GUID-59A3DC52-36FB-4A05-8D37-0305AE4B80D0">Criteria for deleting an event</a>.</p>
       
    25 
       
    26 </li>
       
    27 <li><p><code>callback</code>:</p>
       
    28 
       
    29 <p>The <code>callback</code> argument is the name of the method
       
    30 that is executed when an asynchronous <code>Delete</code> call has
       
    31 results or status information to return. You must define this method separately.
       
    32 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
       
    33 define the <code>callback</code> method.</p>
       
    34 <p>This argument is used only with an asynchronous <code>Delete</code> call.</p>
       
    35 
       
    36 </li>
       
    37 </ul>
       
    38 <p><strong>Return value:</strong></p>
       
    39 <p>If synchronous, the <code>Delete</code> method returns an error
       
    40 code and an error message.</p>
       
    41 <div class="tablenoborder"><a name="GUID-BFFCB477-D669-45D8-B0BC-1338B418A80B"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-BFFCB477-D669-45D8-B0BC-1338B418A80B" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
       
    42 properties for a synchronous Delete</caption>
       
    43 <thead align="left">
       
    44 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53373">
       
    45 <p>Property</p>
       
    46 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53378">
       
    47 <p>Description</p>
       
    48 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53383">
       
    49 <p>Value</p>
       
    50 </th></tr>
       
    51 </thead>
       
    52 <tbody>
       
    53 <tr class="">
       
    54 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53373 ">
       
    55 <p><code>result.ErrorCode</code></p>
       
    56 </td>
       
    57 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53378 ">
       
    58 <p>This is a number that specifies a predefined error code.</p>
       
    59 </td>
       
    60 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53383 ">
       
    61 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
       
    62 </td>
       
    63 </tr>
       
    64 <tr class="bg ">
       
    65 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53373 ">
       
    66 <p><code>result.ErrorMessage</code></p>
       
    67 </td>
       
    68 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53378 ">
       
    69 <p>This is a text string that describes the error.</p>
       
    70 </td>
       
    71 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53383 ">
       
    72 <p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging Service API error messages</a>.</p>
       
    73 </td>
       
    74 </tr>
       
    75 </tbody>
       
    76 </table></div>
       
    77 <p>If asynchronous, the method returns an object that contains a transaction
       
    78 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance,
       
    79 an error code, and an error message (see the following table). When the asynchronous
       
    80 call has completed, <code>callback</code> returns an object that contains
       
    81 an error code and an error message (see <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-E43BC9EA-3EBE-4C7F-A57E-A1C33BB01CF4">Table:
       
    82 Callback return value</a>).</p>
       
    83 <div class="tablenoborder"><a name="GUID-2007806C-ED9D-4BF9-92F0-7494014B367A"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-2007806C-ED9D-4BF9-92F0-7494014B367A" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
       
    84 properties for an asynchronous Delete</caption>
       
    85 
       
    86 <thead align="left">
       
    87 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53469">
       
    88 <p>Property</p>
       
    89 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53474">
       
    90 <p>Description</p>
       
    91 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e53479">
       
    92 <p>Value</p>
       
    93 </th></tr>
       
    94 </thead>
       
    95 <tbody>
       
    96 <tr class="">
       
    97 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53469 ">
       
    98 <p><code>result.TransactionID</code></p>
       
    99 </td>
       
   100 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53474 ">
       
   101 <p>This is a number used as an identification to match transactions started
       
   102 with the asynchronous <code>Delete</code> call to one or more calls
       
   103 it generates to <code>callback</code>.</p>
       
   104 <p>This property is only valid for asynchronous calls.</p>
       
   105 </td>
       
   106 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53479 ">&nbsp;</td>
       
   107 </tr>
       
   108 <tr class="bg ">
       
   109 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53469 ">
       
   110 <p><code>result.ErrorCode</code></p>
       
   111 </td>
       
   112 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53474 ">
       
   113 <p>This is a number that specifies a predefined error code.</p>
       
   114 </td>
       
   115 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53479 ">
       
   116 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
       
   117 </td>
       
   118 </tr>
       
   119 <tr class="">
       
   120 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53469 ">
       
   121 <p><code>result.ErrorMessage</code></p>
       
   122 </td>
       
   123 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53474 ">
       
   124 <p>This is a text string that describes the error.</p>
       
   125 </td>
       
   126 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e53479 ">
       
   127 <p>See <a href="GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6.html#GUID-6C3D58CA-CA4F-432B-898B-4020064E3CE6">Logging Service API error messages</a>.</p>
       
   128 </td>
       
   129 </tr>
       
   130 </tbody>
       
   131 </table></div>
       
   132 <p><strong>Example code:</strong></p>
       
   133 <p/>
       
   134 <p>For the complete source of a sample widget
       
   135 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
       
   136 full example</a>.</p>
       
   137 
       
   138 
       
   139 
       
   140 
       
   141 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>