Difference between revisions of "API Scope.AddPort"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
Line 31: | Line 31: | ||
==Return value== | ==Return value== | ||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
− | |||
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Revision as of 21:53, 12 May 2013
<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
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 information