Tinderbox v9 Icon

linkPath (pathName [, start [,end] ])

Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Item   [operators of similar scope]

 Linking   [other Linking operators]



linkPath (pathName)

linkPath (pathName [, start [,end] ])

These functions return a list of notes that are on a designated path. The pathName "*" designates any path, regardless of path name. If start list provided, that path starts at the designated note and ends on reaching the end note or when all links on the path reachable from start are exhausted. If only the pathName is provided, all notes on the path are listed.

If several paths exist, Tinderbox will return a path which is not longer than any other path.

The underlying graph may contain cycles.

A Tinderbox Reference File : Actions & Rules : Operators : Full Operator List : linkPath (pathName [, start [,end] ])