Difference between revisions of "API Scope.AddPort"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
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==== | ||
+ | [[API Scope|Scope]] | ||
+ | :[[API Scope|AddPort]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''StreamH'' | |
:A handle to a previously created datascope stream | :A handle to a previously created datascope stream | ||
− | + | [[Variable Types|ULONG]] ''PortIndex'' | |
:A zero-based port index, or a textual port name | :A zero-based port index, or a textual port name | ||
− | + | [[Variable Types|ULONG]] ''BitMask'' | |
:The bits of the port to isolate and use | :The bits of the port to isolate and use | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
− | + | [[Variable Types|BOOL]] ''PackMask'' | |
:True to pack all the bits together, false to leave gaps | :True to pack all the bits together, false to leave gaps | ||
:''The default value for this parameter is: '''''1''' | :''The default value for this parameter is: '''''1''' | ||
− | + | [[Variable Types|BOOL]] ''Merge'' | |
:True to bitwise-or the bits with the current data, false to append to the end | :True to bitwise-or the bits with the current data, false to append to the end | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
− | |||
− | |||
− | + | ==Return value== | |
+ | [[Variable Types|BOOL]] | ||
− | + | Returns true if the operation is a success, else false | |
− | |||
− | ===Examples | + | |
− | + | ==Detailed description== | |
+ | ''<span style="color:red;">No additional information</span>'' | ||
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ===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: <pre class="brush:[cpp]">result = ::Scope.AddPort(streamh, portindex, bitmask, true, false)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Adds an input to the stream from a port
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
Returns true if the operation is a success, else false
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)
No additional examples