API Scope.AddPort: Difference between revisions

Revision as of 16:53, 11 May 2013

<sidebar>API contents</sidebar> Adds an input to the stream from a port

Scope

AddPort

HANDLE StreamH

A handle to a previously created datascope stream

ULONG PortIndex

A zero-based port index, or a textual port name

ULONG BitMask

The bits of the port to isolate and use

The default value for this parameter is: -1

BOOL PackMask

True to pack all the bits together, false to leave gaps

The default value for this parameter is: 1

BOOL Merge

True to bitwise-or the bits with the current data, false to append to the end

The default value for this parameter is: 0

No additional information

No additional information

Add to a calculation icon:

result = ::Scope.AddPort(streamh, portindex, bitmask, true, false)

@@ Line 2: / Line 2: @@
 Adds an input to the stream from a port
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:Scope
+::AddPort
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|HANDLE]] StreamH''
 :A handle to a previously created datascope stream
@@ Line 22: / Line 28: @@
 :''The default value for this parameter is: '''''0'''
-===Return value===
+==Return value==
 [[Variable types|BOOL]]
 No additional information
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type BOOL
-* Add to a calculation icon: <pre class="brush:[C]">result = ::Scope.AddPort(streamh, portindex, bitmask, true, false)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Scope.AddPort(streamh, portindex, bitmask, true, false)</pre>