API Connection.GetPort: Difference between revisions
XML import of API auto-gen |
XML import API auto-gen |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
Gets a ports value from its index | |||
===Parameters=== | ===Parameters=== | ||
| Line 22: | Line 20: | ||
===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.GetPort(index, mask) | * Add to a calculation icon: result = ::Connection.GetPort(index, mask) | ||
Revision as of 15:34, 10 May 2013
wiki page name 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)