Difference between revisions of "API System.Forward"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sends the currently processing message to the target | Sends the currently processing message to the target | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Target'' |
:The component to forward the current message to | :The component to forward the current message to | ||
| Line 19: | Line 19: | ||
==Detailed description== | ==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 [[API System.ClaimEvent|System.ClaimEvent]]. |
| Line 26: | Line 26: | ||
* 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> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Sends the currently processing message to the target
Contents
Parameters
HANDLE Target
- The component to forward the current message to
Return value
This call does not return a value
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)
No additional examples
