Remove (ParentNodes)

Remove (ParentNodes)

Description

Removes an item from a ParentNodes collection.

Syntax

someParentNodes.Remove(indexNode, indexState)

Parameter Description

someParentNodes a ParentNodes collection.

indexNode An integer, or a string, or a object specifying the index of the Node to remove. Integer indexes are zero-based, meaning the first item in the collection has index 0. A string index is valid only if the string is the name of an Node in the collection. An Node is valid only if it in the collection.

indexState Optional. An integer, or a string, or a object specifying the index of a State within the States collection of the Node. If the node has a distribution, it will use this state in place of the parent. If no state is given, the first state is used.

Return Value

None.

Example

See: Collections and Maps: an Overview

Applies To

ParentNodes

Parameter	Description
someParentNodes	a ParentNodes collection.
indexNode	An integer, or a string, or a object specifying the index of the Node to remove. Integer indexes are zero-based, meaning the first item in the collection has index 0. A string index is valid only if the string is the name of an Node in the collection. An Node is valid only if it in the collection.
indexState	Optional. An integer, or a string, or a object specifying the index of a State within the States collection of the Node. If the node has a distribution, it will use this state in place of the parent. If no state is given, the first state is used.