Difference between revisions of "API Scope.AddPort"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Adds an input to the stream from a port | Adds an input to the stream from a port | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Scope | ||
| + | ::AddPort | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] StreamH'' | ''[[Variable types|HANDLE]] StreamH'' | ||
:A handle to a previously created datascope stream | :A handle to a previously created datascope stream | ||
| Line 22: | Line 28: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | + | ==Return value== | |
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddPort(streamh, portindex, bitmask, true, false)</pre> |
Revision as of 16:53, 11 May 2013
<sidebar>API contents</sidebar> Adds an input to the stream from a port
Class hierarchy
- Scope
- AddPort
Contents
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)
