org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-D85C2567-F041-42A1-A2B5-650FCAAD60A9.html
changeset 229 716254ccbcc0
equal deleted inserted replaced
228:913c9751c067 229:716254ccbcc0
       
     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-2B13380C-37C8-473F-B0A7-564439312DA3"/><meta name="DC.Relation" scheme="URI" content="GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34"/><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-B8845FF1-D7F6-476A-8651-8B9C12D8789F"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-D85C2567-F041-42A1-A2B5-650FCAAD60A9"/><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-D85C2567-F041-42A1-A2B5-650FCAAD60A9"><span>IDataSource.</span>Add()</h1><div>
       
     7 <p><strong>Description:</strong></p>
       
     8 <p>The <code>Add</code> method adds a new landmark or landmark
       
     9 category to a landmark database. You can also use this method to edit an existing
       
    10 landmark or landmark category.</p>
       
    11 <p>This is a synchronous method.</p>
       
    12 <p><strong>Syntax:</strong></p>
       
    13 
       
    14 <pre class="codeblock" id="GUID-7C01A677-C9ED-497B-BA4D-1909D74DD3FB">result = so.IDataSource.Add(criteria);</pre>
       
    15 <p><strong>Arguments:</strong></p>
       
    16 <ul>
       
    17 <li><p><code>criteria</code>:</p>
       
    18 
       
    19 <p>This is an object that specifies the landmark or landmark category to
       
    20 add or edit. For more information about the object properties and how to define
       
    21 them, see section <a href="GUID-F97A125E-0DCC-4E4A-B607-42068DBD12EC.html#GUID-F97A125E-0DCC-4E4A-B607-42068DBD12EC">Criteria for adding and editing landmark information</a>.</p>
       
    22 
       
    23 </li>
       
    24 </ul>
       
    25 <p><strong>Return value:</strong></p>
       
    26 <p>The <code>Add</code> method returns an object that contains
       
    27 the ID of the landmark or landmark category that was added or edited, an error
       
    28 code, and an error message.</p>
       
    29 <div class="tablenoborder"><a name="GUID-D0CE2B5F-C59D-4917-98C2-95AD30813FF8"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-D0CE2B5F-C59D-4917-98C2-95AD30813FF8" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Return value
       
    30 properties for Add</caption>
       
    31 <thead align="left">
       
    32 <tr class="title "><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e41510">
       
    33 <p>Property</p>
       
    34 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e41515">
       
    35 <p>Description</p>
       
    36 </th><th class="cellrowborder" valign="top" width="33.33333333333333%" id="d0e41520">
       
    37 <p>Value</p>
       
    38 </th></tr>
       
    39 </thead>
       
    40 <tbody>
       
    41 <tr class="">
       
    42 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41510 ">
       
    43 <p><code>result.ReturnValue</code></p>
       
    44 </td>
       
    45 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41515 ">
       
    46 <p>This is a text string that contains the ID of the landmark or landmark
       
    47 category that was added or edited.</p>
       
    48 </td>
       
    49 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41520 ">&nbsp;</td>
       
    50 </tr>
       
    51 <tr class="bg ">
       
    52 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41510 ">
       
    53 <p><code>result.ErrorCode</code></p>
       
    54 </td>
       
    55 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41515 ">
       
    56 <p>This is a number that specifies a predefined error code.</p>
       
    57 </td>
       
    58 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41520 ">
       
    59 <p>See <a href="GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4.html#GUID-0A215AF3-59F0-4158-842C-0D7B030E5EA4">Service API error codes</a>.</p>
       
    60 </td>
       
    61 </tr>
       
    62 <tr class="">
       
    63 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41510 ">
       
    64 <p><code>result.ErrorMessage</code></p>
       
    65 </td>
       
    66 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41515 ">
       
    67 <p>This is a text string that describes the error.</p>
       
    68 </td>
       
    69 <td class="cellrowborder" valign="top" width="33.33333333333333%" headers="d0e41520 ">
       
    70 <p>See <a href="GUID-4ECCCBED-DE6D-4366-B037-90E874C4DF5C.html#GUID-4ECCCBED-DE6D-4366-B037-90E874C4DF5C">Landmarks Service API error messages</a>.</p>
       
    71 </td>
       
    72 </tr>
       
    73 </tbody>
       
    74 </table></div>
       
    75 <p><strong>Remarks:</strong></p>
       
    76 <ul>
       
    77 <li><p>If a landmark or landmark category is to be edited, it must
       
    78 exist in the database. Use the <a href="GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34.html#GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34"><code>GetList</code></a> method
       
    79 to retrieve the ID of the landmark or landmark category.</p></li>
       
    80 <li><p>If no landmark database is specified, <code>Add</code> is
       
    81 performed on the default database. If the default database does not exist,
       
    82 it is created and set active. The default database is <code>file://c:eposlm.ldb</code>.</p>
       
    83 </li>
       
    84 <li><p>For more information about landmarks, landmark categories,
       
    85 and landmark databases, see the <a href="GUID-D581028C-06ED-422D-866E-AE6C93075084.html#GUID-D581028C-06ED-422D-866E-AE6C93075084">Landmarks
       
    86 Service overview page</a>.</p></li>
       
    87 </ul>
       
    88 <p><strong>Example code:</strong></p>
       
    89 <p/>
       
    90 <p>For the complete source of a sample widget
       
    91 that demonstrates how to use this Service API, see <a href="GUID-11D59F76-EC4C-4297-B262-D5174E826B43.html#GUID-11D59F76-EC4C-4297-B262-D5174E826B43">the
       
    92 full example</a>.</p>
       
    93 
       
    94 
       
    95 </div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>