Add()

Description:

The Add method adds a new landmark or landmark category to a landmark database. You can also use this method to edit an existing landmark or landmark category.

This is a synchronous method.

Syntax:

Add(parameters:Object):Object

Arguments:

Return value:

The Add method returns an object that contains the ID of the landmark or landmark category that was added or edited, an error code, and an error message.

Table: Return value properties for Add

Property

Description

Value

ReturnValue

This is a text string that contains the ID of the landmark or landmark category that was added or edited.

 

ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

ErrorMessage

This is a text string that describes the error.

Remarks:

  • If a landmark or landmark category is to be edited, it must exist in the database. Use the GetList method to retrieve the ID of the landmark or landmark category.

  • If no landmark database is specified, Add is performed on the default database. If the default database does not exist, it is created and set active. The default database is file://c:eposlm.ldb.

  • For more information about landmarks, landmark categories, and landmark databases, see the Landmarks Service overview page.

Example code:

The following sample code illustrates how to add a new landmark with the name "abcde":

import com.nokia.lib.Service;
var landmark = new Service("Service.Landmarks", "IDataSource");
var landmarkInfo = {LandmarkName:"abcde"};
var inParams = {Type:"Landmark", Data:landmarkInfo};
var outParams = landmark.Add(inParams);
if (outParams.ErrorCode == 0) {
    var landmarkId = outParams.ReturnValue;
} 
else {
    var errorId = outParams.ErrorCode;//various possible errorcodes
}