Jump to content

API System.Notify: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
Admin (talk | contribs)
XML import
Line 3: Line 3:


<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|Notify]]
:[[API System|Notify]]
</div>
</div>
Line 9: Line 10:


==Parameters==
==Parameters==
''[[Variable types|HANDLE]] Target''
[[Variable types|HANDLE]] ''Target''
:The component to send the message to
:The component to send the message to


''[[Variable types|ULONG]] Ident''
[[Variable types|ULONG]] ''Ident''
:A user-defined value for identification purposes
:A user-defined value for identification purposes
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''


''[[Variable types|ULONG]] Data''
[[Variable types|ULONG]] ''Data''
:Some user-defined data to send to the target
:Some user-defined data to send to the target
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''
Line 24: Line 25:


==Detailed description==
==Detailed description==
''No additional information''
''<span style="color:red;">No additional information</span>''
 


==Examples==
==Examples==
===Calling in a calculation===
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::System.Notify(target, ident, data)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">::System.Notify(target, ident, data)</pre>
''<span style="color:red;">No additional information</span>''

Revision as of 22:12, 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)

No additional information