Jump to content

API Connection.SetPort: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
Admin (talk | contribs)
XML import
Line 24: Line 24:
[[Variable types|BOOL]]
[[Variable types|BOOL]]


''<span style="color:red;">No additional information</span>''
Returns true if the operation is a success, else false





Revision as of 21:29, 12 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