Difference between revisions of "API Connection.SetPort"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets a ports value from its index
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPort'''
====Class hierarchy====
+
|-
[[API Connection|Connection]]
+
| colspan="2" | Sets a ports value from its index&nbsp;
:[[API Connection|SetPort]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
+
| width="90%" | Index
==Parameters==
+
|-
[[Variable Types|UINT]] ''Index''
+
| colspan="2" | The index of the port or a quoted port name&nbsp;
:The index of the port or a quoted port name
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
[[Variable Types|ULONG]] ''Value''
+
| width="90%" | Value
:The value to set the port to
+
|-
 
+
| colspan="2" | The value to set the port to&nbsp;
[[Variable Types|ULONG]] ''Mask''
+
|-
:The bitmask for the port
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
:''The default value for this parameter is: '''''-1'''
+
| width="90%" | Mask
 
+
|-
 
+
| colspan="2" | The bitmask for the port&nbsp;
==Return value==
+
|-
[[Variable Types|BOOL]]
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
Returns true if the operation is a success, else false
+
|}
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png SetPort
Sets 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 Value
The value to set the port to 
Fc9-u32-icon.png - ULONG Mask
The bitmask for the port 
Fc9-bool-icon.png - BOOL Return


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Connection.SetPort(index, value, mask)

No additional examples