lxAbutGetNeighbors
lxAbutGetNeighbors(
{ ld_instId | d_instId }
[ ?direction { 'up | 'down | 'left | 'right | 'horizontal | 'vertical | 'all } ]
[ ?depth { 0 ... INT_MAX } ]
[ ?stopGroup d_stopGroup ]
[ ?select { t | nil } ]
)
=> ld_instId / nil
Description
Returns the list of instance IDs found by traversing from an instance list, or an instance, through the associated abutment groups, in the supplied direction.
The traversal can be restricted by providing a maximum traversal depth. A value of 0 or nil indicates no restriction. If an abutment group object is supplied via the ?stopGroup argument, the group is not traversed. The ?select argument, when true, selects the returned instances.
Arguments
|
Integer specifying the maximum depth of traversal. If set to |
|
|
Database ID of the abutment group object that should not be traversed. |
|
Value Returned
Example
lxAbutGetNeighbors( inst1 ?direction 'right ?depth 5 ?stopGroup group1 )
Return to top