Difference between revisions of "ISInterface:GetScriptRuntime"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 +
== Syntax ==
 +
*unsigned long GetScriptRuntime(char *ScriptName)
 
== Purpose ==
 
== Purpose ==
 
Retrieves the number of milliseconds a given script has been running
 
Retrieves the number of milliseconds a given script has been running
Line 5: Line 7:
 
=== Parameters ===
 
=== Parameters ===
 
*char *ScriptName
 
*char *ScriptName
: Name of the script
+
:'''[in]''' Name of the script
 
=== Return Value ===
 
=== Return Value ===
 
*unsigned long
 
*unsigned long
Line 11: Line 13:
  
 
== Examples ==
 
== Examples ==
 
+
unsigned long Timer;
 +
Timer=pISInterface->GetScriptRuntime("test");
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]

Latest revision as of 21:09, 2 September 2005

Syntax

  • unsigned long GetScriptRuntime(char *ScriptName)

Purpose

Retrieves the number of milliseconds a given script has been running

Usage

Parameters

  • char *ScriptName
[in] Name of the script

Return Value

  • unsigned long
The number of milliseconds the script has been running, or 0 if the script is not running

Examples

unsigned long Timer;
Timer=pISInterface->GetScriptRuntime("test");

See Also