Jump to content

API Connection.SetPort: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
 
Admin (talk | contribs)
XML import API auto-gen
Line 1: Line 1:
wiki page name
wiki page name
==ConnectionSetPort==
Sets a ports value from its index


Sets a ports value from its index
----


===Parameters===
===Parameters===
Line 25: Line 23:


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

Revision as of 15:34, 10 May 2013

wiki page name Sets a ports value from its index


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

No additional information

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)