PLGetUserElementNumber

<< Click to Display Table of Contents >>

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

PLGetUserElementNumber

Previous page Next page

PURPOSE

Retrieve the user element number identified by a element index from the database.

SYNTAX

PLGetUserElementNumber( DatabaseName, ElementIndex )

PARAMETERS

DatabaseName (Character String)

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

ElementIndex (Integer)

The index of the element (from 1 to number of elements).

OUTPUT

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

-999999999

Invalid Input (Element index out of range).

-999999998

Invalid Database.

SEE ALSO

Error Codes

PLGetElementCount

PLGetElementStartNode

PLGetElementEndNode

PLGetElementLength

PLGetElementInnerDiameter

PLGetElementOuterDiameter

Back to Table of Contents