PLGetElementDistanceAlongSet

<< Click to Display Table of Contents >>

Navigation:  PipeLay > Excel Add-In > Function Reference > Set Functions >

PLGetElementDistanceAlongSet

Previous page Next page

PURPOSE

Retrieves the distance along a set to the start of the specified element.

SYNTAX

PLGetElementDistanceAlongSet( DatabaseName, SetName, ElementIndex )

PARAMETERS

DatabaseName (Character String)

The full path and filename to the relevant database. The file extension is optional.

SetName (Character String)

The name of the set.

ElementIndex (Integer)

The index of the element within the element set.

OUTPUT

A numerical value containing the distance along the set or one of the following error codes:

-999999999

Invalid Input (Invalid element index for the set).

-999999998

Invalid Database.

-999999993

Invalid Set Name.

UNITS

Imperial

Metric

ft

m

SEE ALSO

Error Codes

PLGetElementSetCount

PLGetElementSetName

PLGetNodeDistanceAlongSet

PLGetSetElement

PLGetSetElementCount

 

Back to Table of Contents