HTGetTimeStringAtScooter() Function

The HTGetTimeStringAtScooter() function returns the string containing the time/date for the sample at the specified scooter location.

Category

Historical

Syntax

MessageResult=HTGetTimeStringAtScooter(Hist_Tag, UpdateCount, ScootNum, ScootLoc, Format_Text);

Arguments

Hist_Tag

HistTrend tag assigned the name of the trend.

UpdateCount

Integer representing the trend's .UpdateCount dotfield.

ScootNum

Integer representing the left or right scooter:
1=Left Scooter
2=Right Scooter

ScootLoc

Real number representing the value at the .ScooterPosRight or .ScooterPosLeft positions on the trend.

Format_Text

String specifying the time/date format to use. The following Format_Text strings are acceptable:

"Date", "Time", "DateTime", "DOWShort" (Wed, for example), and "DOWLong" (Wednesday, for example).

Remarks

Any changes to the values assigned to the UpdateCount, ScootNum, and ScootLoc arguments cause the expression to be evaluated. This ensures the expression is evaluated after new data retrievals or after a scooter is moved. The format of the string determines the contents of the return value.

Example

The following statement retrieves the date and time for the value at the current scooter location for the right scooter of the Trend1 trend. The value is stored in the NewRightTimeString message tag and is in "Time" format:

NewRightTimeString=HTGetTimeStringAtScooter ("Trend1",Trend1.UpdateCount,2, Trend1.ScooterPosRight,"Time");