Difference between revisions of "API Connection.SetPort"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API changes)
Line 23: Line 23:
 
==Return value==
 
==Return value==
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
 +
 
Returns true if the operation is a success, else false
 
Returns true if the operation is a success, else false
  

Revision as of 13:15, 14 May 2013

<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 information