API Connection.SetPort: Difference between revisions
XML Import to change Variable types into Variable Types |
XML import of updated API docs |
||
| Line 1: | Line 1: | ||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Sets a ports value from its index | Sets a ports value from its index | ||
| Line 36: | Line 38: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetPort(index, value, mask)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetPort(index, value, mask)</pre> | ||
''<span style="color:red;">No additional | ''<span style="color:red;">No additional examples</span>'' | ||
Revision as of 09:58, 17 June 2013
<sidebar>API contents</sidebar>
Sets a ports value from its index
Parameters
UINT Index
- The index of the port or a quoted port name
ULONG Value
- The value to set the port to
ULONG Mask
- The bitmask for the port
- The default value for this parameter is: -1
Return value
Returns true if the operation is a success, else false
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Connection.SetPort(index, value, mask)
No additional examples