Difference between revisions of "API Connection.GetPort"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API |API ]]
+
===Class hierarchy===[[API Connection|Connection]]
:[[API Connection|Connection]]
+
:[[API Connection|GetPort]]
::GetPort
 
 
</div>
 
</div>
 
__TOC__
 
__TOC__

Revision as of 21:23, 11 May 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)