Difference between revisions of "API Connection.GetPort"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> 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

The default value for this parameter is: -1

Returns the ports value from its index

No additional information

Add to a calculation icon:

result = ::Connection.GetPort(index, mask)

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==ConnectionGetPort==
+Gets a ports value from its index
-Gets a ports value from its index
+<div style="width:25%; float:right" class="toc">
-----
+====Class hierarchy====
+[[API Connection|Connection]]
+:[[API Connection|GetPort]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|UINT]] Index''
+[[Variable Types|UINT]] ''Index''
 :The index of the port or a quoted port name
-''[[Variable types|ULONG]] Mask''
+[[Variable Types|ULONG]] ''Mask''
 :The bits of the port to isolate
 :''The default value for this parameter is: '''''-1'''
-===Return value===
-[[Variable types|BOOL]]
+==Return value==
+[[Variable Types|BOOL]]
 Returns the ports value from its index
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation:====
+''<span style="color:red;">No additional information</span>''
+==Examples==
+===Calling in a calculation===
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: result = ::Connection.GetPort(index, mask)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetPort(index, mask)</pre>
+''<span style="color:red;">No additional examples</span>''