Difference between revisions of "API Connection.SetPort"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Sets a ports value from its index
 
Sets a ports value from its index
  
Line 36: Line 36:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetPort(index, value, mask)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetPort(index, value, mask)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Sets a ports value from its index

Class hierarchy

Connection

SetPort

Parameters

UINT Index

The index of the port or a quoted port name

ULONG Value

The value to set the port to

ULONG Mask

The bitmask for the port
The default value for this parameter is: -1


Return value

BOOL

Returns true if the operation is a success, else false


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