Jump to content

SubVI class: Difference between revisions

From LabVIEW Wiki
Started page
 
Replaced with template tables
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide SubVI Properties Table</span>
{{VIServerClassTables|16401}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ SubVI Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|635E40B
| [[SubVI class/BadSubVILinkage property|BadSubVILinkage]]
|Returns whether the referenced subVI needs to be relinked due to connector pane changes. LabVIEW enables the <b>Relink to SubVI</b> shortcut menu option when this property is TRUE.
|R
|X
|- style="background-color:#CCFFFF;"
|635E402
| [[SubVI class/GrowTerms property|GrowTerms]]
|Sets or returns the grow terms.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E40D
| [[SubVI class/MissingVIName property|MissingVIName]]
|
|R
|
|- style="background-color:#CCFFFF;"
|635E40C
| [[SubVI class/MissingVIPath property|MissingVIPath]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|635E405
| [[SubVI class/SkipSbrtCall property|SkipSbrtCall]]
|Skips the call if the subroutine is currently running in another thread.
 
This property is similar to the <b>Skip Subroutine Call if Busy</b> item in the shortcut menu of subVIs.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E409
| [[SubVI class/CloseFPAfterCall property|CloseFPAfterCall]]
|Indicates whether to close the front panel after the subVI runs.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E407
| [[SubVI class/OpenFPOnLoad property|OpenFPOnLoad]]
|Indicates whether to show the front panel when the subVI is loaded.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E408
| [[SubVI class/ShowFPOnCall property|ShowFPOnCall]]
|Indicates whether to show the front panel when the subVI is called.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E40A
| [[SubVI class/SuspendOnCall property|SuspendOnCall]]
|Indicates whether LabVIEW suspends the execution of the VI when calling it as a subVI.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E400
| [[SubVI class/TermVis property|TermVis]]
|Indicates whether the terminals of the subVI are visible.
|R/W
|
|- style="background-color:#CCFFFF;"
|635E401
| [[SubVI class/VIName property|VIName]]
|Name of the subVI file.
|R
|
|- style="background-color:#CCFFFF;"
|635E403
| [[SubVI class/VIPath property|VIPath]]
|Path to the subVI file.
|R
|X
|- style="background-color:#CCFFFF;"
|635E406
| [[SubVI class/VIRef property|VIRef]]
|Returns a reference to the VI.
|R
|
|- style="background-color:#CCFFFF;"
|635E404
| [[SubVI class/ViewAsIcon property|ViewAsIcon]]
|If TRUE, the subVI appears as an icon. If FALSE, the subVI appears as an expandable node.
|R/W
|
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide SubVI Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ SubVI Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|635E003
| [[SubVI class/Feeds Through method|Feeds Through]]
|
|X
|- style="background-color:#CCFFFF;"
|635E002
| [[SubVI class/Inline method|Inline]]
|Inlines the subVI into its calling VIs.
 
National Instruments recommends that you use the Execution:Inline SubVI method when possible to more safely inline a subVI into the block diagram of each calling VI.
|X
|- style="background-color:#CCFFFF;"
|635E000
| [[SubVI class/Relink To VI method|Relink To VI]]
|After the connector pane pattern of a subVI changes, re-links the subVI to the calling VI. LabVIEW uses the new connector pane pattern and attempts to reconnect any existing wires to the new pattern. This method then returns a reference to the re-linked subVI.
|
|- style="background-color:#D1BB80;"
|635E001
| [[SubVI class/Replace method|Replace]]
|
|
|- style="background-color:#D1BB80;"
|635E004
| [[SubVI class/SwapInstanceVI method|SwapInstanceVI]]
|
|
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 00:42, 9 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name SubVI class
Class ID 16401
Scope VI Scripting
Class Inheritance
Class Children


The SubVI class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide SubVI Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
SubVI Properties Table
Property ID Long Name (English) Description R/W RTE
635E400Terminals Visible?Indicates whether the terminals of the subVI are visible.Read/WriteNo
635E401VI NameName of the subVI file.Read OnlyNo
635E402Grow TermsSets or returns the grow terms.Read/WriteNo
635E403VI PathPath to the subVI file.Read OnlyYes
635E404View As IconIf TRUE, the subVI appears as an icon. If FALSE, the subVI appears as an expandable node.Read/WriteNo
635E405Skip Subroutine Call If BusySkips the call if the subroutine is currently running in another thread.Read/WriteNo
635E406VI ReferenceReturns a reference to the VI.Read OnlyNo
635E407SubVI Setup:Open Front Panel When LoadedIndicates whether to show the front panel when the subVI is loaded.Read/WriteNo
635E408SubVI Setup:Show Front Panel When CalledIndicates whether to show the front panel when the subVI is called.Read/WriteNo
635E409SubVI Setup:Close Front Panel After CallIndicates whether to close the front panel after the subVI runs.Read/WriteNo
635E40ASubVI Setup:Suspend When CalledIndicates whether LabVIEW suspends the execution of the VI when calling it as a subVI.Read/WriteNo
635E40BBad SubVI LinkageReturns whether the referenced subVI needs to be relinked due to connector pane changes. LabVIEW enables the Relink to SubVI shortcut menu option when this property is TRUE.Read OnlyYes
635E40CMissing VI PathRead OnlyYes
635E40DMissing VI NameRead OnlyNo

Methods

Show/Hide SubVI Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
SubVI Methods Table
Method ID Long Name (English) Description RTE
635E000Relink To VIAfter the connector pane pattern of a subVI changes, re-links the subVI to the calling VI. LabVIEW uses the new connector pane pattern and attempts to reconnect any existing wires to the new pattern. This method then returns a reference to the re-linked subVI.No
635E001ReplaceNo
635E002InlineInlines the subVI into its calling VIs.Yes (Read/Write)
635E003Feeds ThroughYes
635E004Swap Instance VINo

Events

This class has no events or it inherits events from its parent: Node Class.


History

Version Change(s)
LabVIEW 2018 More info to come.

See Also