Time Function

Syntax

String Time(Boolean force24HourFormat = False, [Out] [Number hours], [Out] [Number minutes], [Out] [Number seconds], [Out] [Number milliseconds], [Number timeStampInSeconds], [Boolean baseTimeIsInitTime])

Return Value

String

A string containing the current time in localized format.

Purpose

This function returns the current time.

Parameters

force24HourFormat as Boolean

An optional Boolean that specifies whether the function returns the time string in 24 hour format (the default is false).

hours as Number

An optional number that returns the number of hours since midnight (from 0 to 23).

minutes as Number

An optional number that returns the number of minutes after the hour (from 0 to 59).

seconds as Number

An optional number that returns the number of seconds after the minute (from 0 to 59).

milliseconds as Number

An optional number that returns the number of milliseconds after the second (from 0 to 999).

timeStampInSeconds as Number

An optional number that specifies a timestamp the function uses in place of the current time. Pass a time value you obtain from the expression function Seconds().

baseTimeIsInitTime as Boolean

An optional Boolean that specifies the base time for the timestamp you pass to parameter 6. Pass True if the base time is the time at which the application initialized the TestStand Engine. Pass False if the base time is midnight, January 1, 1970, universal coordinated time (UTC). UTC is also known as Greenwich mean time (GMT).