Difference between revisions of "API Connection.SetPort"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Sets a ports value from its index

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

Returns true if the operation is a success, else false

No additional information

Add to a calculation icon:

result = ::Connection.SetPort(index, value, mask)

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==ConnectionSetPort==
+Sets a ports value from its index
-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===
+==Parameters==
-''[[Variable types|UINT]] Index''
+[[Variable Types|UINT]] ''Index''
 :The index of the port or a quoted port name
-''[[Variable types|ULONG]] Value''
+[[Variable Types|ULONG]] ''Value''
 :The value to set the port to
-''[[Variable types|ULONG]] Mask''
+[[Variable Types|ULONG]] ''Mask''
 :The bitmask for the port
 :''The default value for this parameter is: '''''-1'''
-===Return value===
-[[Variable types|BOOL]]
-No additional information
+==Return value==
+[[Variable Types|BOOL]]
+Returns true if the operation is a success, else false
-===Detailed description===
+==Detailed description==
-''No additional information''
+''<span style="color:red;">No additional information</span>''
-===Examples===
-====Calling in a calculation:====
+==Examples==
+===Calling in a calculation===
 * 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>''