Difference between revisions of "API Connection.GetPort"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Gets a ports value from its index | Gets a ports value from its index | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Connection | ||
| + | ::GetPort | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|UINT]] Index'' | ''[[Variable types|UINT]] Index'' | ||
:The index of the port or a quoted port name | :The index of the port or a quoted port name | ||
| Line 11: | Line 17: | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| − | + | ==Return value== | |
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
Returns the ports value from its index | Returns the ports value from its index | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre> |
Revision as of 17:03, 11 May 2013
<sidebar>API contents</sidebar> Gets a ports value from its index
Class hierarchy
- Connection
- GetPort
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)
