Difference between revisions of "API System.ClaimEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Claims an event message by name, returns true if claimed
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClaimEvent'''
 +
|-
 +
| colspan="2" | Claims an event message by name, returns true if claimed&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The component that would usually recieve the event&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | MsgName
 +
|-
 +
| colspan="2" | The quoted class.name formatted name of the event to claim&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Target''
 
−
:The component that would usually recieve the event
 
  
−
''[[Variable types|STRING]] MsgName''
 
−
:The quoted class.name formatted name of the event to claim
 
  
−
===Return value===
 
−
[[Variable types|BOOL]]
 
  
−
Returns true if claimed
+
==Examples==
−
 
+
===Calling in a calculation===
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
−
* Add to a calculation icon: <pre class="brush:[C]">result = ::System.ClaimEvent(target, "msgname")</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png ClaimEvent
Claims an event message by name, returns true if claimed 
Fc9-h32-icon.png - HANDLE Target
The component that would usually recieve the event 
Fc9-string-icon.png - STRING MsgName
The quoted class.name formatted name of the event to claim 
Fc9-bool-icon.png - BOOL Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::System.ClaimEvent(target, "msgname")
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_System.ClaimEvent&oldid=30342"