|
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-154DA5F4-32F6-42E2-A107-A7C72F6F9DE5"/><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-E6FAAB7C-EE2D-4464-9D0F-B1D89E26ABCF"/><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-E6FAAB7C-EE2D-4464-9D0F-B1D89E26ABCF"><span>IDataSource.</span>Delete()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Delete</code> method deletes one or more contacts |
|
9 or contact groups from a contacts database. The information is deleted from |
|
10 the specified database or, if no database is specified, from the default one.</p> |
|
11 <p>This method can be called both synchronously and asynchronously.</p> |
|
12 <p><strong>Syntax:</strong></p> |
|
13 <p>For synchronous calls:</p> |
|
14 <pre class="codeblock" id="GUID-379FB4B8-48E8-459D-8E60-C0774AA6A4FD">result = so.IDataSource.Delete(criteria);</pre> |
|
15 |
|
16 <p>For asynchronous calls:</p> |
|
17 <pre class="codeblock" id="GUID-DCD61FFA-9961-4840-90D8-DA23096260E2">result = so.IDataSource.Delete(criteria, callback);</pre> |
|
18 |
|
19 <p><strong>Arguments:</strong></p> |
|
20 <ul> |
|
21 <li><p> <code>criteria</code>:</p> |
|
22 |
|
23 <p>This is an object that specifies which contacts or contact groups to |
|
24 delete and from which database. For more information about the object properties |
|
25 and how to define them, see section <a href="GUID-9FF007CF-0CFF-4572-B399-B98C4F98C250.html#GUID-9FF007CF-0CFF-4572-B399-B98C4F98C250">Criteria for deleting contact information</a>.</p> |
|
26 |
|
27 </li> |
|
28 <li><p><code>callback</code>:</p> |
|
29 |
|
30 <p>The <code>callback</code> argument is the name of the method |
|
31 that is executed when an asynchronous <code>Delete</code> call has |
|
32 results or status information to return. You must define this method separately. |
|
33 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 |
|
34 define the <code>callback</code> method.</p> |
|
35 <p>This argument is used only with an asynchronous <code>Delete</code> call.</p> |
|
36 |
|
37 </li> |
|
38 </ul> |
|
39 <p><strong>Return value:</strong></p> |
|
40 <p>If synchronous, the <code>Delete</code> method returns an object |
|
41 that contains an error code and an error message.</p> |
|
42 <p>If asynchronous, the method returns an object that contains a transaction |
|
43 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
44 an error code, and an error message. When the asynchronous call has completed, <code>callback</code> returns |
|
45 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> |
|
46 <div class="tablenoborder"><a name="GUID-29DC17D6-56DA-45CA-AD5B-BBDED3A35248"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-29DC17D6-56DA-45CA-AD5B-BBDED3A35248" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
47 properties for Delete</caption> |
|
48 |
|
49 <thead align="left"> |
|
50 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e32682"> |
|
51 <p>Property</p> |
|
52 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e32687"> |
|
53 <p>Description</p> |
|
54 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e32692"> |
|
55 <p>Value</p> |
|
56 </th></tr> |
|
57 </thead> |
|
58 <tbody> |
|
59 <tr class=""> |
|
60 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32682 "> |
|
61 <p><code>result.TransactionID</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32687 "> |
|
64 <p>This is a number used as an identification to match transactions started |
|
65 with an asynchronous <code>Delete</code> call to one or more calls |
|
66 it generates to <code>callback</code>.</p> |
|
67 <p>This property is only valid for asynchronous calls.</p> |
|
68 </td> |
|
69 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32692 "> </td> |
|
70 </tr> |
|
71 <tr class="bg "> |
|
72 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32682 "> |
|
73 <p><code>result.ErrorCode</code></p> |
|
74 </td> |
|
75 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32687 "> |
|
76 <p>This is a number that specifies a predefined error code.</p> |
|
77 </td> |
|
78 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32692 "> |
|
79 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
80 </td> |
|
81 </tr> |
|
82 <tr class=""> |
|
83 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32682 "> |
|
84 <p><code>result.ErrorMessage</code></p> |
|
85 </td> |
|
86 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32687 "> |
|
87 <p>This is a text string that describes the error.</p> |
|
88 </td> |
|
89 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e32692 "> |
|
90 <p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p> |
|
91 </td> |
|
92 </tr> |
|
93 </tbody> |
|
94 </table></div> |
|
95 <p><strong>Remarks:</strong></p> |
|
96 <ul> |
|
97 <li><p>The default contacts database is <code>cntdb://c:contacts.cdb</code>. |
|
98 The SIM card database is <code>sim://global_adn</code>.</p></li> |
|
99 <li><p>The contacts or contacts groups to be deleted must exist |
|
100 in the specified database. Use <a href="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007.html#GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"><code>GetList</code></a> to |
|
101 retrieve the IDs of the entries you want to delete.</p></li> |
|
102 <li><p>If you delete a contacts group, the contacts associated with |
|
103 that group are not deleted. Only the group item is deleted.</p></li> |
|
104 </ul> |
|
105 <p><strong>Example code:</strong></p> |
|
106 <p/> |
|
107 <p>For the complete source of a sample widget |
|
108 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 |
|
109 full example</a>.</p> |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |