Difference between revisions of "API System.Forward"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sends the currently processing message to the target
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Forward'''
 +
|-
 +
| colspan="2" | Sends the currently processing message to the target&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The component to forward the current message to&nbsp;
 +
|-
 +
| 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''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
===Class hierarchy===
 
:System
 
::Forward
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
''[[Variable types|HANDLE]] Target''
+
This call passes the currently processing event to the ''Target'' component. It is useful for components that behave as a redirection component. To perform the reverse action - claiming an event from a component use [[API System.ClaimEvent|System.ClaimEvent]].
:The component to forward the current message to
 
  
==Return value==
 
''This call does not return a value''
 
 
==Detailed description==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::System.Forward(target)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::System.Forward(target)</pre>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png Forward
Sends the currently processing message to the target 
Fc9-h32-icon.png - HANDLE Target
The component to forward the current message to 
Fc9-void-icon.png - NONE Return


Detailed description

This call passes the currently processing event to the Target component. It is useful for components that behave as a redirection component. To perform the reverse action - claiming an event from a component use System.ClaimEvent.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::System.Forward(target)