|
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.Export()"/><meta name="DC.Relation" scheme="URI" content="GUID-F2CE0F94-324C-4D45-BD37-DA55F9DAC077"/><meta name="DC.Relation" scheme="URI" content="GUID-154DA5F4-32F6-42E2-A107-A7C72F6F9DE5"/><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-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034"/><title>IDataSource.Export() </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-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034"><span>IDataSource.</span>Export()</h1><div> |
|
7 <p><strong>Description:</strong></p> |
|
8 <p>The <code>Export</code> method exports a contact from a contacts |
|
9 database. The information is exported to a vCard file.</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-34DA0408-CEF1-45A8-A9BE-7374FD7D94C6">result = so.IDataSource.Export(criteria);</pre> |
|
14 |
|
15 <p>For asynchronous calls:</p> |
|
16 <pre class="codeblock" id="GUID-C2FBCD68-0924-42CE-836C-69F4A1ADEF3B">result = so.IDataSource.Export(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 the contact to export and optionally |
|
23 the source database. For more information about the object properties and |
|
24 how to define them, see section <a href="GUID-92D152D3-E29A-4010-B5A0-9D37A0369A21.html#GUID-92D152D3-E29A-4010-B5A0-9D37A0369A21">Criteria for exporting a contact</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>Export</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>Export</code> call.</p> |
|
35 |
|
36 </li> |
|
37 </ul> |
|
38 <p><strong>Return value:</strong></p> |
|
39 <p>If synchronous, the <code>Export</code> method returns an object |
|
40 that contains an error code and an error message.</p> |
|
41 <p>If asynchronous, the method returns an object that contains a transaction |
|
42 ID for the <a href="GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608.html#GUID-C7C3B541-8D28-4DC6-9003-ECF57F26C608"><code>callback</code></a> instance, |
|
43 an error code, and an error message. When the asynchronous call has completed, <code>callback</code> returns |
|
44 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> |
|
45 <div class="tablenoborder"><a name="GUID-59FE1923-9C45-49B2-A554-6272F72D9C24"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-59FE1923-9C45-49B2-A554-6272F72D9C24" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value |
|
46 properties for Export</caption> |
|
47 |
|
48 <thead align="left"> |
|
49 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e33706"> |
|
50 <p>Property</p> |
|
51 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e33711"> |
|
52 <p>Description</p> |
|
53 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e33716"> |
|
54 <p>Value</p> |
|
55 </th></tr> |
|
56 </thead> |
|
57 <tbody> |
|
58 <tr class=""> |
|
59 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33706 "> |
|
60 <p><code>result.TransactionID</code></p> |
|
61 </td> |
|
62 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33711 "> |
|
63 <p>This is a number used as an identification to match transactions started |
|
64 with an asynchronous <code>Export</code> call to one or more calls |
|
65 it generates to <code>callback</code>.</p> |
|
66 <p>This property is only valid for asynchronous calls.</p> |
|
67 </td> |
|
68 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33716 "> </td> |
|
69 </tr> |
|
70 <tr class="bg "> |
|
71 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33706 "> |
|
72 <p><code>result.ErrorCode</code></p> |
|
73 </td> |
|
74 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33711 "> |
|
75 <p>This is a number that specifies a predefined error code.</p> |
|
76 </td> |
|
77 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33716 "> |
|
78 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p> |
|
79 </td> |
|
80 </tr> |
|
81 <tr class=""> |
|
82 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33706 "> |
|
83 <p><code>result.ErrorMessage</code></p> |
|
84 </td> |
|
85 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33711 "> |
|
86 <p>This is a text string that describes the error.</p> |
|
87 </td> |
|
88 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33716 "> |
|
89 <p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p> |
|
90 </td> |
|
91 </tr> |
|
92 </tbody> |
|
93 </table></div> |
|
94 <p><strong>Remarks:</strong></p> |
|
95 <ul> |
|
96 <li><p>The default contacts database is <code>cntdb://c:contacts.cdb</code>.</p> |
|
97 </li> |
|
98 <li><p>SIM card databases only support name and number keys for |
|
99 vCard.</p></li> |
|
100 </ul> |
|
101 <p><strong>Example code:</strong></p> |
|
102 <p/> |
|
103 <p>For the complete source of a sample widget |
|
104 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 |
|
105 full example</a>.</p> |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |