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:
wiki page name
+
<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===
+
==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
  
''[[Variable types|ULONG]] PortIndex''
+
[[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''
+
[[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''
+
[[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''
+
[[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]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|BOOL]]
  
===Detailed description===
+
Returns true if the operation is a success, else false
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==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

Class hierarchy

Scope

AddPort

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

BOOL

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