Difference between revisions of "API Connection.GetPort"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 16: Line 16:
 
:The bits of the port to isolate
 
:The bits of the port to isolate
 
:''The default value for this parameter is: '''''-1'''
 
:''The default value for this parameter is: '''''-1'''
 +
  
 
==Return value==
 
==Return value==
Line 21: Line 22:
  
 
Returns the ports value from its index
 
Returns the ports value from its index
 +
  
 
==Detailed description==
 
==Detailed description==

Revision as of 01:54, 12 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)

No additional information