diff -r 4d198a32ac7d -r d4809db37847 plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-CA7C3A7B-6733-47E0-9C6F-FBFB0993F034.html Thu Aug 19 17:48:04 2010 -0700 @@ -0,0 +1,110 @@ + + +IDataSource.Export()

IDataSource.Export()

+

Description:

+

The Export method exports a contact from a contacts +database. The information is exported to a vCard file.

+

This method can be called both synchronously and asynchronously.

+

Syntax:

+

For synchronous calls:

+
result = so.IDataSource.Export(criteria);
+ +

For asynchronous calls:

+
result = so.IDataSource.Export(criteria, callback);
+ +

Arguments:

+
    +
  • criteria:

    + +

    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 Criteria for exporting a contact.

    + +
  • +
  • callback:

    + +

    The callback argument is the name of the method +that is executed when an asynchronous Export call has +results or status information to return. You must define this method separately. +Follow the instructions in section Defining the callback handler for an asynchronous method to +define the callback method.

    +

    This argument is used only with an asynchronous Export call.

    + +
  • +
+

Return value:

+

If synchronous, the Export method returns an object +that contains an error code and an error message.

+

If asynchronous, the method returns an object that contains a transaction +ID for the callback instance, +an error code, and an error message. When the asynchronous call has completed, callback returns +an object that contains an error code and an error message (see Table: Callback return value).

+
+ + + + + + + + + + + + + + + + + + + + + +
Table: Return value +properties for Export
+

Property

+
+

Description

+
+

Value

+
+

result.TransactionID

+
+

This is a number used as an identification to match transactions started +with an asynchronous Export call to one or more calls +it generates to callback.

+

This property is only valid for asynchronous calls.

+
 
+

result.ErrorCode

+
+

This is a number that specifies a predefined error code.

+
+

See Service API error codes.

+
+

result.ErrorMessage

+
+

This is a text string that describes the error.

+
+

See Contacts Service API error messages.

+
+

Remarks:

+
    +
  • The default contacts database is cntdb://c:contacts.cdb.

    +
  • +
  • SIM card databases only support name and number keys for +vCard.

  • +
+

Example code:

+

+

For the complete source of a sample widget +that demonstrates how to use this Service API, see the +full example.

+ + + + +
\ No newline at end of file