Difference between revisions of "API Connection.GetPort"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Gets a ports value from its index
 
Gets a ports value from its index
Line 33: Line 35:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Gets a ports value from its index

Class hierarchy

Connection

GetPort

Parameters

UINT Index

The index of the port or a quoted port name

ULONG Mask

The bits of the port to isolate
The default value for this parameter is: -1


Return value

BOOL

Returns the ports value from its index


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Connection.GetPort(index, mask)

No additional examples