PLGetUserNodeNumber

<< Click to Display Table of Contents >>

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

PLGetUserNodeNumber

Previous page Next page

PURPOSE

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

SYNTAX

PLGetUserNodeNumber( DatabaseName, NodeIndex )

PARAMETERS

DatabaseName (Character String)

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

NodeIndex (Integer)

The index of the node (from 1 to number of nodes).

OUTPUT

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

-999999999

Invalid Input (Node index out of range).

-999999998

Invalid Database.

SEE ALSO

Error Codes

PLGetNodeCount

PLGetNodeSetName

 

Back to Table of Contents