Difference between revisions of "API Connection.GetPort"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetPort''' | ||
| + | |- | ||
| + | | colspan="2" | Gets a ports value from its index | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | The index of the port or a quoted port name | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Mask | ||
| + | |- | ||
| + | | colspan="2" | The bits of the port to isolate | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | + | ==Detailed description== | |
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| Line 34: | Line 30: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
GetPort |
| Gets a ports value from its index | |
 - UINT
|
Index |
| The index of the port or a quoted port name | |
 - ULONG
|
Mask |
| The bits of the port to isolate | |
| - ULONG
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Connection.GetPort(index, mask)
