DeleteLink()

Summary

Deletes a line feature from a line layer.

 

Syntax

deleted_id = DeleteLink(integer ID, array options)

 

Argument	Contents
ID	The ID of the link to delete

 

Option	Type	Contents
Reason	String	If provided, a record will be added to the database's log file, with this used as the Reason column. If it's not provided, no entry will be added, even if the other options are present.
Comment	String	Text for the comment field of the log file.
User	String	User name for the log file.

 

Returns

An array of between one and three integer elements. The first element is the ID of the deleted link. The second and third elements, if any, are the IDs of any end points that were no longer in use and were therefore deleted.

 

Notes

• The line layer must be the current layer.

• The line layer can be an Oracle Spatial layer.

• The log file name will have the same name as the database and a .txt extension.

Example

// Delete a line feature where the user clicks

SetLayer("Roads")

id = RH2ID(LocateNearestRecord(ClickCoord(), 0.25))

DeleteLink(id)

 

Error Codes

Error Type	Meaning
Error	The current layer is not a line layer, or is not from a standard geographic file
NotFound	There is no feature with the given ID

 

See Also

Function	Summary
AddLink()	Adds a line feature to a line layer
ReverseLink()	Reverses the order of shape points on a link