Difference between revisions of "API Connection.SetPort"
From Flowcode Help
Jump to navigationJump to search (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]] ''Value'' |
:The value to set the port to | :The value to set the port to | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Mask'' |
:The bitmask for the port | :The bitmask for the port | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| Line 22: | Line 22: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Sets a ports value from its index
Contents
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 information
