Difference between revisions of "API Connection.GetPort"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets a ports value from its index
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetPort'''
 +
|-
 +
| colspan="2" | Gets a ports value from its index&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | The index of the port or a quoted port name&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Mask
 +
|-
 +
| colspan="2" | The bits of the port to isolate&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|UINT]] Index''
 
−
:The index of the port or a quoted port name
 
  
−
''[[Variable types|ULONG]] Mask''
 
−
:The bits of the port to isolate
 
−
:''The default value for this parameter is: '''''-1'''
 
  
−
===Return value===
 
−
[[Variable types|BOOL]]
 
  
−
Returns the ports value from its index
+
==Examples==
−
 
+
===Calling in a calculation===
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
−
* Add to a calculation icon: result = ::Connection.GetPort(index, mask)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetPort
Gets a ports value from its index 
Fc9-u16-icon.png - UINT Index
The index of the port or a quoted port name 
Fc9-u32-icon.png - ULONG Mask
The bits of the port to isolate 
Fc9-u32-icon.png - ULONG Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Connection.GetPort(index, mask)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Connection.GetPort&oldid=30261"