Difference between revisions of "API System.TimerStart"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TimerStart'''
 +
|-
 +
| colspan="2" | Calls the Component.Timer event with Ident as an argument after Millisecs time 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Ident
 +
|-
 +
| colspan="2" | A user-defined value to pass to the timer event for identification 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Millisecs
 +
|-
 +
| colspan="2" | The minimum number of milliseconds to wait until the timer is fired 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
<sidebar>API Contents</sidebar>
+
==Detailed description==
Calls the Component.Timer event with Ident as an argument after Millisecs time
 
  
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API System|System]]
 
:[[API System|TimerStart]]
 
</div>
 
__TOC__
 
 
==Parameters==
 
[[Variable Types|ULONG]] ''Ident''
 
:A user-defined value to pass to the timer event for identification
 
 
[[Variable Types|ULONG]] ''Millisecs''
 
:The minimum number of milliseconds to wait until the timer is fired
 
 
 
==Return value==
 
''This call does not return a value''
 
 
 
==Detailed description==
 
''<span style="color:red;">No additional information</span>''
 
  
  
Line 30: Line 29:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::System.TimerStart(ident, millisecs)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::System.TimerStart(ident, millisecs)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png TimerStart
Calls the Component.Timer event with Ident as an argument after Millisecs time 
Fc9-u32-icon.png - ULONG Ident
A user-defined value to pass to the timer event for identification 
Fc9-u32-icon.png - ULONG Millisecs
The minimum number of milliseconds to wait until the timer is fired 
Fc9-void-icon.png - NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon:
    ::System.TimerStart(ident, millisecs)