Jump to content

API Connection.GetPort: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import of API auto-gen
Line 22: Line 22:
====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.GetPort(index, mask)
* Add to a calculation icon: <pre class="brush:[C]">result = ::Connection.GetPort(index, mask)</pre>

Revision as of 15:35, 10 May 2013

<sidebar>API contents</sidebar> Gets a ports value from its index


Parameters

UINT Index

The index of the port or a quoted port name

ULONG Mask

The bits of the port to isolate
The default value for this parameter is: -1

Return value

BOOL

Returns the ports value from its index

Detailed description

No additional information

Examples

Calling in a calculation

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