PLGetSetElement

<< Click to Display Table of Contents >>

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

PLGetSetElement

Previous page Next page

PURPOSE

Retrieve the user element number from the named element set.

SYNTAX

PLGetSetElement( 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

An integer value containing the user element number from the element set or one of the following error codes:

-999999999

Invalid Input (Invalid element index for the set).

-999999998

Invalid Database.

-999999993

Invalid Set Name.

SEE ALSO

Error Codes

PLGetElementDistanceAlongSet

PLGetElementSetCount

PLGetElementSetName

PLGetNodeDistanceAlongSet

PLGetSetElementCount

 

Back to Table of Contents