PLGetTimeIndex

<< Click to Display Table of Contents >>

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

PLGetTimeIndex

Previous page Next page

PURPOSE

Retrieve the nearest time index for the specified time.

SYNTAX

PLGetTimeIndex( DatabaseName, Time )

PARAMETERS

DatabaseName (Character String)

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

Time in seconds (Number)

The Time value.

OUTPUT

An integer value containing the nearest time index for the specified time. If the database is a static analysis database then this value will always be 1. If an error occurs, one of the following codes will be returned:

-999999999

Invalid Input.

-999999998

Invalid Database.

SEE ALSO

Error Codes

PLGetNumSolutionTimes

PLGetDatabaseTimeStep

PLGetTime

PLIsStaticAnalysis

 

Back to Table of Contents