Jump to content

API Connection.GetPort: Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
JonnyW (talk | contribs)
3,997 edits
XML Import to change Variable types into Variable Types
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Gets a ports value from its index
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Connection|Connection]]
:[[API Connection|GetPort]]
</div>
__TOC__
==Parameters==
[[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


==Detailed description==


==Detailed description==
''<span style="color:red;">No additional information</span>''




Line 32: Line 30:
* Declare a variable 'result' of type BOOL
* Declare a variable 'result' of type BOOL
* 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>''

Latest revision as of 14:11, 13 July 2026

GetPort
Gets a ports value from its index 
- UINT Index
The index of the port or a quoted port name 
- ULONG Mask
The bits of the port to isolate 
- 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=43044"