Mercurial Mercurial > oss > FCL > sftools > dev > eclipseenv > wrttools / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Mon, 07 Jun 2010 16:33:07 -0700
changeset 354 0bceeb415e7f
parent 229 716254ccbcc0
permissions -rw-r--r--
Bug 2892 - Import wgz file from Import menu should have same functionality as File New Project Create from wgz


<!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.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">
      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-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034"><span>IDataSource.</span>Export()</h1><div>
<p><strong>Description:</strong></p>
<p>The <code>Export</code> method exports a contact from a contacts
database. The information is exported to a vCard file.</p>
<p>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-34DA0408-CEF1-45A8-A9BE-7374FD7D94C6">result = so.IDataSource.Export(criteria);</pre>

<p>For asynchronous calls:</p>
<pre class="codeblock" id="GUID-C2FBCD68-0924-42CE-836C-69F4A1ADEF3B">result = so.IDataSource.Export(criteria, callback);</pre>

<p><strong>Arguments:</strong></p>
<ul>
<li><p><code>criteria</code>:</p>

<p>This is an object that specifies the contact to export and optionally
the source database. For more information about the object properties and
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>

</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>Export</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>Export</code> call.</p>

</li>
</ul>
<p><strong>Return value:</strong></p>
<p>If synchronous, the <code>Export</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-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
properties for Export</caption>

<thead align="left">
<tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e33706">
<p>Property</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e33711">
<p>Description</p>
</th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e33716">
<p>Value</p>
</th></tr>
</thead>
<tbody>
<tr class="">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33706 ">
<p><code>result.TransactionID</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33711 ">
<p>This is a number used as an identification to match transactions started
with an asynchronous <code>Export</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="d0e33716 ">&nbsp;</td>
</tr>
<tr class="bg ">
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33706 ">
<p><code>result.ErrorCode</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33711 ">
<p>This is a number that specifies a predefined error code.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33716 ">
<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="d0e33706 ">
<p><code>result.ErrorMessage</code></p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33711 ">
<p>This is a text string that describes the error.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e33716 ">
<p>See <a href="GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF.html#GUID-8722B5DB-5EA6-446D-8C1D-7A0B3D8781EF">Contacts Service API error messages</a>.</p>
</td>
</tr>
</tbody>
</table></div>
<p><strong>Remarks:</strong></p>
<ul>
<li><p>The default contacts database is <code>cntdb://c:contacts.cdb</code>.</p>
</li>
<li><p>SIM card databases only support name and number keys for
vCard.</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-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1.html#GUID-B2BCD2C0-DA4D-4830-9BF3-5DA50879A3A1">the
full example</a>.</p>




</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>
FCL/sftools/dev/eclipseenv/wrttools