Difference between revisions of "API System.ClaimEvent"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Claims an event message by name, returns true if claimed | Claims an event message by name, returns true if claimed | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API System|System]] | + | ====Class hierarchy==== |
| + | [[API System|System]] | ||
:[[API System|ClaimEvent]] | :[[API System|ClaimEvent]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Target'' | |
:The component that would usually recieve the event | :The component that would usually recieve the event | ||
| − | + | [[Variable Types|STRING]] ''MsgName'' | |
:The quoted class.name formatted name of the event to claim | :The quoted class.name formatted name of the event to claim | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if claimed | Returns true if claimed | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 27: | Line 31: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Claims an event message by name, returns true if claimed
Contents
Parameters
HANDLE Target
- The component that would usually recieve the event
STRING MsgName
- The quoted class.name formatted name of the event to claim
Return value
Returns true if claimed
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::System.ClaimEvent(target, "msgname")
No additional examples
