Difference between revisions of "API Connection.GetPort"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a ports value from its index | Gets a ports value from its index | ||
Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
− | [[Variable | + | [[Variable Types|UINT]] ''Index'' |
:The index of the port or a quoted port name | :The index of the port or a quoted port name | ||
− | [[Variable | + | [[Variable Types|ULONG]] ''Mask'' |
:The bits of the port to isolate | :The bits of the port to isolate | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
Line 19: | Line 19: | ||
==Return value== | ==Return value== | ||
− | [[Variable | + | [[Variable Types|BOOL]] |
Returns the ports value from its index | Returns the ports value from its index | ||
Line 33: | Line 33: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre> | ||
− | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a ports value from its index
Contents
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
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)
No additional examples