|
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.Add()"/><meta name="DC.Relation" scheme="URI" content="GUID-E6FAAB7C-EE2D-4464-9D0F-B1D89E26ABCF"/><meta name="DC.Relation" scheme="URI" content="GUID-37C9E5F0-BEA9-4E0B-A40D-B953B3551007"/><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-20D66938-A870-43D7-9515-AC7E22AEDC14"/><title>IDataSource.Add() </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-20D66938-A870-43D7-9515-AC7E22AEDC14"><span>IDataSource.</span>Add()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Add</code> method adds a contact or contact group |
|
9 to a contacts database. If the contact or contact group already exists in |
|
10 the database, it is replaced with the new entry. You can thus use this method |
|
11 to both add and edit contacts and contact groups. The information is added |
|
12 to the specified database or, if no database is specified, to the default |
|
13 one. If the default database does not exist, it is created.</p> |
|
14 <p>This method can be called both synchronously and asynchronously.</p> |
|
15 <p><strong>Syntax:</strong></p> |
|
16 <p>For synchronous calls:</p> |
|
17 <pre class="codeblock" id="GUID-011A2BEC-80E5-42F3-A950-5AD015B01A1B">result = so.IDataSource.Add(criteria);</pre> |
|
18 |
|
19 <p>For asynchronous calls:</p> |
|
20 <pre class="codeblock" id="GUID-01DF7362-142F-43B6-9D97-80D7A0EEB0AC">result = so.IDataSource.Add(criteria, callback);</pre> |
|
21 |
|
22 <p><strong>Arguments:</strong></p> |
|
23 <ul> |
|
24 <li><p><code>criteria</code>:</p> |
|
25 |
|
26 <p>This is an object that specifies what contact information to add or |
|
27 edit and for which database. For more information about the object properties |
|
28 and how to define them, see section <a href="GUID-94FAF08A-F3E3-4686-A35B-E98EEBF18824.html#GUID-94FAF08A-F3E3-4686-A35B-E98EEBF18824">Criteria for adding and editing contact information</a>.</p> |
|
29 |
|
30 </li> |
|
31 <li><p><code>callback</code>:</p> |
|
32 |
|
33 <p>The <code>callback</code> argument is the name of the method |
|
34 that is executed when an asynchronous <code>Add</code> call has results |
|
35 or status information to return. You must define this method separately. Follow |
|
36 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 |
|
37 define the <code>callback</code> method.</p> |
|
38 <p>This argument is used only with an asynchronous <code>Add</code> call.</p> |
|
39 |
|
40 </li> |
|
41 </ul> |
|
42 <p><strong>Return value:</strong></p> |
|
43 <p>If synchronous, the <code>Add</code> method returns an object |
|
44 that contains an error code and an error message.</p> |
|
45 <p>If asynchronous, the method returns an object that contains a transaction |
|
46 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
47 an error code, and an error message. When the asynchronous call has completed, <code>callback</code> returns |
|
48 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> |
|
49 <div class="tablenoborder"><a name="GUID-9873A8F5-70EF-42EC-ABCC-47F551890CA4"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-9873A8F5-70EF-42EC-ABCC-47F551890CA4" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
50 properties for Add</caption> |
|
51 |
|
52 <thead align="left"> |
|
53 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31867"> |
|
54 <p>Property</p> |
|
55 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31872"> |
|
56 <p>Description</p> |
|
57 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e31877"> |
|
58 <p>Value</p> |
|
59 </th></tr> |
|
60 </thead> |
|
61 <tbody> |
|
62 <tr class=""> |
|
63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31867 "> |
|
64 <p><code>result.TransactionID</code></p> |
|
65 </td> |
|
66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31872 "> |
|
67 <p>This is a number used as an identification to match transactions started |
|
68 with an asynchronous <code>Add</code> call to one or more calls it |
|
69 generates to <code>callback</code>.</p> |
|
70 <p>This property is only valid for asynchronous calls.</p> |
|
71 </td> |
|
72 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31877 "> </td> |
|
73 </tr> |
|
74 <tr class="bg "> |
|
75 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31867 "> |
|
76 <p><code>result.ErrorCode</code></p> |
|
77 </td> |
|
78 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31872 "> |
|
79 <p>This is a number that specifies a predefined error code.</p> |
|
80 </td> |
|
81 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31877 "> |
|
82 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
83 </td> |
|
84 </tr> |
|
85 <tr class=""> |
|
86 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31867 "> |
|
87 <p><code>result.ErrorMessage</code></p> |
|
88 </td> |
|
89 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31872 "> |
|
90 <p>This is a text string that describes the error.</p> |
|
91 </td> |
|
92 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e31877 "> |
|
93 <p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p> |
|
94 </td> |
|
95 </tr> |
|
96 </tbody> |
|
97 </table></div> |
|
98 <p><strong>Remarks:</strong></p> |
|
99 <ul> |
|
100 <li><p>The default contacts database is <code>cntdb://c:contacts.cdb</code>. |
|
101 The SIM card database is <code>sim://global_adn</code>.</p></li> |
|
102 <li><p>If a contact or contact group is added with its <code>id</code> property |
|
103 specified, and the database already contains an entry with that <code>id</code>, |
|
104 the existing entry is replaced by the new one. If the <code>id</code> is |
|
105 not specified, a new entry is added to the database.</p></li> |
|
106 </ul> |
|
107 <p><strong>Example code:</strong></p> |
|
108 <p/> |
|
109 <p>For the complete source of a sample widget |
|
110 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 |
|
111 full example</a>.</p> |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |