Navigation:  ThinBASIC Modules > Core (thinBasic Core Engine) > Core Module Classes > cTimer Class > cTimer Methods >

<cTimer>.Elapsed

Previous pageReturn to chapter overviewNext page

 

Description

 

Returns time elapsed since Start event.

Optionally store a string used to better describe the exact elapsed moment.

 

Syntax

 

n = <cTimer>.Elapsed[(Type [, sDescription])]

 

Returns

 

Number: time elapsed since Start event

 

Parameters

 

Name

Type

Optional

Meaning

Type

Number

Yes

One of the following equates:

%cTimer_Seconds

%cTimer_MicroSeconds

%cTimer_MilliSeconds

 

If no type is indicated, the following will be defaulted:

%cTimer_Seconds

 

sDescription

String

Yes

String that will be stored in elapsed time used to better describe the moment. Programmer will be able to retrieve this string using Intermediate_GetDescription method.

 

Remarks

 

This method sets an internal intermediate time. See Intermediate_Count and Intermediate_Get methods.

 

Restrictions

 

See also

 

Examples

 

'---Create a class variable

Dim MyTimer  As cTimer

Dim nSecs    As Long

 

'---Instantiate the class variable. This will automatically call internal Constructor

MyTimer = New cTimer

...

MyTimer.Start("Hi there, I just started")

...

'---Get elapsed seconds since Start event

nSecs = MyTimer.Elapsed(%cTimer_Seconds)

...

'---Stop timer

MyTimer.Stop

...