Difference between revisions of "API Connection.SetPort"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
− | + | Sets a ports value from its index | |
− | + | <div style="width:25%; float:right" class="toc"> | |
− | + | ====Class hierarchy==== | |
+ | [[API Connection|Connection]] | ||
+ | :[[API Connection|SetPort]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[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 Types|ULONG]] ''Value'' | |
:The value to set the port to | :The value to set the port to | ||
− | + | [[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''' | ||
− | |||
− | |||
− | + | ==Return value== | |
+ | [[Variable Types|BOOL]] | ||
+ | |||
+ | Returns true if the operation is a success, else false | ||
+ | |||
− | + | ==Detailed description== | |
− | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
− | + | ||
− | + | ==Examples== | |
+ | ===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.SetPort(index, value, mask) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetPort(index, value, mask)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<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 examples