API Connection.GetPort: Difference between revisions

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

Add to a calculation icon:

result = ::Connection.GetPort(index, mask)

@@ 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===
-:Connection
-::GetPort
-</div>
-__TOC__
-==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
-==Detailed description==
-''No additional information''
 ==Examples==