Difference between revisions of "API Scope.AddPort"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 27: Line 27:
 
: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==
 
==Return value==
Line 32: Line 33:
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 01:54, 12 May 2013

<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

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)

No additional information