Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

ttrStartTracking

ttrStartTracking(
[ l_scopeName ]
)
=> l_scopeName / nil

Description

Starts tracking the time spent on various operations in the given scope. The tracking continues until it is stopped using ttrStopTracking.

Arguments

l_scopeName

Name of the scope for which tracking needs to be started. If a scope name is not provided, a name is automatically generated.

A scope name can be a string or a list.

Value Returned

l_scopeName

Returns the name of the given scope if tracking has started.

You must use this scope name if you want to stop the tracking or print the diagnostics.

nil

The tracking could not be started.

Examples

The following code starts tracking the time for the scope Myscope1. It returns the name of the scope being tracked.

ttrStartTracking("Myscope1")
=>("Myscope1")

The following code starts the tracking. It automatically generates a scope name and returns the name Scope0.

ttrStartTracking()
=>("Scope0")

Related Topics

Time Tracker Functions


Return to top
 ⠀
X