Node_destroy

Homepage

Destroys the Node object and frees its memory.

Result := Node_destroy(NodeObject)

Parameters

NodeObject The Node object to use for the current operation.

Return Value

True (1) if the Node was actually destroyed,
or False (0) if the Node was not destroyed (see 1 below).

Remarks

The object will not be destroyed if:

  1. The lock count for NodeObject is more than one. In this case, the lock count for NodeObject will be decreased by one, and the function returns false to indicate that the object still exists.
  2. NodeObject is NULL (0 or blank) - returns the empty string to indicate an error.

Related

Node_new

Node

Examples

;Creates a new Node object"
myNode := Node_new()

;Destroys myNode and frees its memory
Result := Node_destroy(myNode)

Homepage