API Connection.GetPort: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| 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 | ||
Revision as of 11:08, 10 June 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
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 information