Difference between revisions of "API System.Notify"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Sends a System.User message to the targeted component
 
Sends a System.User message to the targeted component
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:System
 +
::Notify
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|HANDLE]] Target''
 
''[[Variable types|HANDLE]] Target''
 
:The component to send the message to
 
:The component to send the message to
Line 15: Line 21:
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
  
===Return value===
+
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::System.Notify(target, ident, data)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">::System.Notify(target, ident, data)</pre>

Revision as of 21:14, 11 May 2013

<sidebar>API contents</sidebar> Sends a System.User message to the targeted component

Class hierarchy

System
Notify

Parameters

HANDLE Target

The component to send the message to

ULONG Ident

A user-defined value for identification purposes
The default value for this parameter is: 0

ULONG Data

Some user-defined data to send to the target
The default value for this parameter is: 0

Return value

This call does not return a value

Detailed description

No additional information

Examples

Calling in a calculation

  • Add to a calculation icon:
    ::System.Notify(target, ident, data)