Difference between revisions of "API System.ClaimEvent"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Claims an event message by name, returns true if claimed

HANDLE Target

The component that would usually recieve the event

STRING MsgName

The quoted class.name formatted name of the event to claim

Returns true if claimed

No additional information

Add to a calculation icon:

result = ::System.ClaimEvent(target, "msgname")

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
 Claims an event message by name, returns true if claimed
+<div style="width:25%; float:right" class="toc">
+====Class hierarchy====
+[[API System|System]]
+:[[API System|ClaimEvent]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Target''
+[[Variable Types|HANDLE]] ''Target''
 :The component that would usually recieve the event
-''[[Variable types|STRING]] MsgName''
+[[Variable Types|STRING]] ''MsgName''
 :The quoted class.name formatted name of the event to claim
-===Return value===
-[[Variable types|BOOL]]
+==Return value==
+[[Variable Types|BOOL]]
 Returns true if claimed
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation====
+''<span style="color:red;">No additional information</span>''
+==Examples==
+===Calling in a calculation===
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: result = ::System.ClaimEvent(target, "msgname")
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre>
+''<span style="color:red;">No additional examples</span>''