Difference between revisions of "API System.Notify"
From Flowcode Help
Jump to navigationJump to search (XML import of API documentation) |
|||
| Line 29: | Line 29: | ||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | Notifications are posted between components using the event [[Event System.User|System.User]]. This is invoked by this '''Notify''' message. Here ''Target'' is the component to post the message to. |
| + | |||
| + | |||
| + | ''Ident'' and ''Data'' are user defined values - Flowcode does not put any constraints on what these are, but by convention ''Ident'' is specified by the recipient of the message in order to identify this from other [[Event System.User|System.User]] messages. | ||
| + | |||
| + | |||
| + | Note that as this message is post instead of sent, the ''Target'' may not receive the message immediately, and the caller should not wait for a reply inside an event macro. | ||
Revision as of 23:16, 11 August 2013
<sidebar>API Contents</sidebar>
Sends a System.User message to the targeted component
Contents
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
Notifications are posted between components using the event System.User. This is invoked by this Notify message. Here Target is the component to post the message to.
Ident and Data are user defined values - Flowcode does not put any constraints on what these are, but by convention Ident is specified by the recipient of the message in order to identify this from other System.User messages.
Note that as this message is post instead of sent, the Target may not receive the message immediately, and the caller should not wait for a reply inside an event macro.
Examples
Calling in a calculation
- Add to a calculation icon:
::System.Notify(target, ident, data)
No additional examples
