Difference between revisions of "API Scope.AddPort"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import API auto-gen) |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
| − | + | Adds an input to the stream from a port | |
| − | |||
| − | |||
===Parameters=== | ===Parameters=== | ||
| Line 33: | Line 31: | ||
===Examples=== | ===Examples=== | ||
| − | ====Calling in a calculation | + | ====Calling in a calculation==== |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: result = ::Scope.AddPort(streamh, portindex, bitmask, true, false) | * Add to a calculation icon: result = ::Scope.AddPort(streamh, portindex, bitmask, true, false) | ||
Revision as of 15:34, 10 May 2013
wiki page name Adds an input to the stream from a port
Parameters
HANDLE StreamH
- A handle to a previously created datascope stream
ULONG PortIndex
- A zero-based port index, or a textual port name
ULONG BitMask
- The bits of the port to isolate and use
- The default value for this parameter is: -1
BOOL PackMask
- True to pack all the bits together, false to leave gaps
- The default value for this parameter is: 1
BOOL Merge
- True to bitwise-or the bits with the current data, false to append to the end
- The default value for this parameter is: 0
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon: result = ::Scope.AddPort(streamh, portindex, bitmask, true, false)
