DeleteNode()

Summary

Deletes an endpoint feature from a standard geographic file.

 

Syntax

deleted_id = DeleteNode(integer ID, array options)

 

Argument	Contents
ID	The ID of the endpoint 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

The integer ID of the deleted endpoint.

 

Notes

• The endpoint layer must be the current layer.

• If any line features are connected to the endpoint, DeleteNode() signals an error.

• JoinLinks() does not eliminate the common endpoint when joining links. You are left with an orphan node with no attached links. You can use DeleteNode() to actually delete the node.

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

Example

// Delete a node where the user clicks

SetLayer("Xsection")

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

on error do

     ShowMessage("The Xsection has streets attached to it!")

     Return()

     end

DeleteNode(id)

on error default

 

Error Codes

Error Type	Meaning
Error	The current layer is not an endpoint layer, or is not from a standard geographic file; or line features are connected to the endpoint
NotFound	There is no feature with the given ID

 

See Also

Function	Summary
AddNode()	Adds an endpoint to a standard geographic line file
JoinLinks()	Joins two line features that meet at a common endpoint
MoveNode()	Changes the location of an endpoint feature in a standard geographic file
SplitNode()	Splits a node into one node for each line that is connected to it