Jump to content

Application class

From LabVIEW Wiki
Revision as of 03:34, 7 September 2019 by Q (talk | contribs) (Properties: Replaced with template property table)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Application class
Class ID 1
Scope Basic Development Environment
Class Inheritance

This class is a top-level class.

Class Children

This class has no children.


The Application class is a class in the VI Server Class Hierarchy, (see also VI Server). The Application class is the top-level instance of the application in its context. Multiple application instances can be open at a time.

Properties

Show/Hide Application Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Application Properties Table
Property ID Long Name (English) Description R/W RTE
0Application:NameFilename of the application.Read OnlyYes (Read Only)
1Application:User NameUser name used to open the application.Read/WriteYes (Read Only)
2Application:Version NumberVersion number of the application. In a stand-alone application or shared library, this property returns the version of the LabVIEW Run-Time Engine.Read OnlyYes (Read Only)
3Application:KindIndicates the LabVIEW instance the VI is running in, including invalid application types.Read OnlyYes (Read Only)
4Application:Target:Operating SystemIndicates the operating system for which the application was built. Mac OS refers to Mac OS versions 9 and 8. Carbon refers to Mac OS X (32-bit).Read OnlyYes (Read Only)
5Application:Target:CPUIndicates the target CPU of an application.Read OnlyYes (Read Only)
6Operating System:NameName of the operating system where the application is actually running.Read OnlyYes (Read Only)
7Operating System:Version NumberVersion number of the actual operating system.Read OnlyYes (Read Only)
8Application:Exported VIs In MemoryReturns a list of exported VIs in memory.Read OnlyYes (Read Only)
9Printing:File Wrap Text LengthMaximum number of characters on a single line in a file. Affects the Print:VI To HTML, Print:VI To RTF, and Print:VI To Text methods. Set this property to 0 to print all the characters on one line so the text does not wrap.Read/WriteNo
APrinting:PNG Compression LevelNumber between 0 and 9 that specifies the level of compression you want for the PNG file for graphics in VIs printed either interactively or with the Print:VI To HTML method. The quality of the graphic is not affected by the compression, but the graphic file size and speed of compression are affected by this value. Valid values range from 0 to 9 and balance file compression with speed. 0 designates no compression. 1 designates less compression, but faster speed. 9 designates high compression, but slower speed. If you enter –1, LabVIEW selects the best combination of speed and compression.Read/WriteNo
BPrinting:JPEG QualityPercentage value from 0 to 100 specifying the level of quality you want for the JPEG graphic in VIs printed either interactively or with the Print:VI To HTML method. The scale balances image quality and file size. A value in the 75 to 95 range produces a compressed file with a high-quality image, and a value below 50 produces a smaller file size with a low-quality image. The default is 80.Read/WriteNo
CPrinting:Custom Connector?Specifies whether to print the connector pane and icon of VIs when using the custom format with one of the print documentation VI methods.Read/WriteNo
DPrinting:Custom Description?Specifies whether to print VI descriptions when using the custom format with one of the print documentation VI methods.Read/WriteNo
EPrinting:Custom Panel?Specifies whether to print the front panel when using the custom format with one of the print documentation VI methods.Read/WriteNo
FPrinting:Custom Panel Border?Specifies whether to print the front panel with a border when using the custom format with one of the print documentation VI methods.Read/WriteNo
10Printing:Custom Controls?Specifies whether to print front panel control information when using the custom format with one of the print documentation VI methods.Read/WriteNo
11Printing:Custom Control Descriptions?Specifies whether to print descriptions of front panel controls when using the custom format with one of the print documentation VI methods.Read/WriteNo
12Printing:Custom Control Types?Specifies whether to print data type information for front panel controls when using the custom format with one of the print documentation VI methods.Read/WriteNo
13Printing:Custom Diagram?Specifies whether to print block diagrams when using the custom format with one of the print documentation VI methods.Read/WriteNo
14Printing:Custom Diagram Hidden?Specifies whether to print the hidden frames in Case and Stacked Sequence structures that might be present on the block diagram when using the custom format with one of the print documentation VI methods.Read/WriteNo
15Printing:Custom Diagram Repeat?Specifies whether to print visible subdiagrams of each Case, Event, and Stacked Sequence structure in sequence with the non-visible subdiagrams when using the custom format with one of the print documentation VI methods. If you print the visible subdiagrams in sequence, those subdiagrams print twice.Read/WriteNo
16Printing:Custom List of SubVIs?Specifies whether to print a list of the subVIs and Express VIs including the icon, name, and path when using the custom format with one of the print documentation VI methods. If a polymorphic VI is a subVI, LabVIEW prints the instance used in the top-level VI including the icon, name, and path. If the top-level VI is polymorphic, LabVIEW prints a list of all the instances of the polymorphic VI including the icon, name, and path of each instance.Read/WriteNo
17Printing:Custom Hierarchy?Specifies whether to print the hierarchy of the VI in memory when using the custom format with one of the print documentation VI methods.Read/WriteNo
18Printing:Custom History?Specifies whether to print the VI revision history information when using the custom format with one of the print documentation VI methods.Read/WriteNo
19Application:Directory PathAbsolute path to the directory where the application is located.Read OnlyYes (Read Only)
1AServer:VI Access ListList that describes which VIs on the VI server are accessible by remote clients.Read/WriteYes
1BServer:TCP/IP Access ListList that describes which TCP/IP addresses of remote clients may access the VI server.Read/WriteYes
1CApplication:All VIs In MemoryReturns a list of VIs in memory for the specified application instance. This property returns an error if you wire a remote application reference to the reference input. For a remote application, use the Exported VIs in Memory property to return a list of exported VIs.Read OnlyYes (Read Only)
1DApplication:Menu Launch:VIReturns the name of the VI that launched the calling VI from a menu selection.Read OnlyYes (Read Only)
1EApplication:All System VIs in MemoryRead OnlyYes
1FApplication:Menu SetRead/WriteNo
20Server:TCP Listener ActiveSpecifies whether the TCP interface to the VI Server is currently accepting connections.Read/WriteYes
21Display:Primary WorkspaceGives the bounding rectangle of the computer's primary monitor.Read OnlyYes (Read Only)
22Display:All MonitorsReturns information about all the monitors on the computer, including their bit depths and bounding rectangles.Read OnlyYes (Read Only)
24Server:VI Calls AllowedRead/WriteNo
25Server:VI Operations AllowedRead/WriteNo
26Server:Application Operations AllowedRead/WriteNo
27Server:Logging EnabledSpecifies whether the TCP interface to the VI Server is logging operations to a file.Read/WriteYes
28Server:Logging File PathPath of the log file created during TCP/IP communication.Read/WriteYes
29Printing:Custom All Controls?Specifies whether to print all controls or only the controls wired to the connector pane when using the custom format with one of the print documentation VI methods.Read/WriteNo
2AApplication:Controls Palette OpenRead/WriteNo
2BApplication:Functions Palette OpenRead/WriteNo
2CApplication:Tools Palette OpenRead/WriteNo
2DApplication:Default:File Dialog PathRead/WriteYes
2EWeb Server:Server ActiveDetermines whether the built-in Web Server is enabled. This property immediately changes the status of the Web Server without requiring you to restart LabVIEW. Changes using this property are not saved across sessions of LabVIEW and are not reflected on the Web Server page of the Options dialog box.Read/WriteYes
2FWeb Server:Root Directory PathSpecifies the root directory from which the built-in Web Server loads files for document requests.Read/WriteYes
30Web Server:HTTP PortThe port to which the built-in Web Server listens for HTTP requests.Read/WriteYes
31Web Server:Read TimeoutDetermines how long the built-in Web Server waits for read operations to complete when the Web Server reads HTTP requests from HTTP clients.Read/WriteYes
32Web Server:Logging EnabledDetermines whether the built-in Web Server logs to a file information about HTTP requests.Read/WriteYes
33Web Server:Logging File PathDetermines where the built-in Web Server places the log file.Read/WriteYes
34Web Server:TCP-IP Access ListSets or gets the TCP/IP addresses that have access to the Web Server. This property also sets or gets whether each address has access to view a VI remotely, view and control a VI remotely, or does not have access to the Web Server.Read/WriteYes
35Web Server:VI Access ListSets or gets the VIs that are visible through the Web Server. This property also sets or gets whether LabVIEW allows access to each VI.Read/WriteYes
36Application:Parent Window For DialogsRead/WriteYes
37Application:Version As IntegerRead OnlyYes
38Application:Embedded Root PathRead OnlyYes
39Application:Preferences File PathRead OnlyYes
3AApplication:Host Preferences SectionRead OnlyYes
3BApplication:Registered OwnerRead OnlyYes
3CApplication:Registered OrganizationRead OnlyYes
3DApplication:Serial NumberRead OnlyYes
3EApplication:Downloaded VIsRead OnlyNo
3FApplication:Show FP Tip StripsWriting the property: Setting this property to TRUE enables the display of tip strips on front panel controls. Setting the property to FALSE prevents them from being displayed. Reading the property: Specifies whether tip strips display when idling over controls on the front panel.Read/WriteYes
41Remote Panel:Connections To ClientsReturns an array of clusters containing connection information about the clients currently connected to the computer.Read OnlyYes (Read Only)
42Remote Panel:Connections To ServersReturns an array of clusters containing connection information about the servers to which the computer is currently connected.Read OnlyYes (Read Only)
43Remote Panel:NetLoad Monitor EnabledRead/WriteYes
44Application:Target:IP AddressRead OnlyYes
45Application:Remote Web Server ActiveRead OnlyYes
46Application:Active:VIReturns the name of the active VI in the application.Read OnlyYes
47Application:Selection List ChangedRead OnlyYes
48Printing:Color/Grayscale?If TRUE, LabVIEW sends color/grayscale output to the printer. If FALSE, LabVIEW sends monochrome output to the printer.Read/WriteYes
49Printing:Default PrinterGets or sets the name of the default printer in LabVIEW.Read/WriteYes
4APrinting:MethodGets or sets how LabVIEW prints.Read/WriteYes
4BPrinting:Available PrintersReturns an alphabetized array of printer names available on the computer.Read OnlyYes
4DApplication:Unattended ModeRead/WriteYes
4EApplication:Default:Error Handler VIRead/WriteYes
4FApplication:Command Line ArgumentsReturns an array of user-defined command-line arguments passed when LabVIEW launched.Read OnlyYes (Read Only)
51Application:Use App Template BrowserRead/WriteYes
52Application:Assistants Use Strict Types DefaultRead/WriteYes
53Application:Auto-Route WiresReturns whether LabVIEW automatically finds a route for a wire.Read/WriteNo
54Application:Target:InfoRead OnlyYes
55Application:Target:KindRead OnlyYes
56Application:Defer DrawingRead/WriteYes
57Application:Default:Data DirectoryPath to the default data directory.Read OnlyYes (Read Only)
58Application:Search PathsRead/WriteYes
59Application:Real-Time SupportRead OnlyYes
5AApplication:User Interface AvailableIf you are not targeted to a real-time (RT) platform, this property is always TRUE. If you are targeted to an RT-platform and the host is connected, this property is TRUE. When this property is FALSE, the host is not connected, requiring that the Real-Time Module application must be able to handle all operations independent of the host. Use this property to determine when it is safe to display a dialog box that requires user interaction.Read OnlyYes
5BApplication:Delete FP Terminal from DiagramReturns whether LabVIEW deletes terminals corresponding to front panel objects from diagram operations.Read/WriteNo
5CPrinting:Custom Express VI Configuration?Specifies whether to print the configuration information for any Express VIs on the block diagram when using the custom format with one of the print documentation VI methods.Read/WriteNo
5DServer:PortGets or sets the LabVIEW VI server port. LabVIEW returns an error if you attempt to access this property on a remote application.Read/WriteYes
5ERemote Panel:Is SupportedRead OnlyYes
5FApplication:Installed PackageRead OnlyYes
60Application:Inside Build AppRead/WriteYes
62Application:Internet Toolkit InstalledRead/WriteYes
63Application:LanguageIndicates the language of the LabVIEW environment or stand-alone application as a string according to ISO 639. Values include en, de, fr, ja, ko, and zh-cn.Read OnlyYes (Read Only)
64Application:Window For Panel OriginRead/WriteYes
65Module HandleRead OnlyYes
66Application:Pump OS MessagesRead/WriteYes
67Application:Full FeatureRead OnlyYes
68Application:All ContextsRead OnlyYes
69Project:Projects[]Returns an array of references to each LabVIEW project in memory. You can use these references with the Project properties.Read OnlyYes
6AApplication:DWarn DialogRead/WriteYes
6BOptions:Use Abridged MenusRead/WriteNo
6ESource Control:Configuration DataRead/WriteYes
6FSource Control:Provider NameRead/WriteYes
70Source Control:Provider LocationRead/WriteYes
71Source Control:Display Only Selected FilesRead/WriteYes
72Source Control:Select Hierarchy When Adding FilesRead/WriteYes
73Source Control:Select Callers When Checking Files OutRead/WriteYes
74Source Control:Display Warning If File Is Checked OutRead/WriteYes
75Source Control:Use Dialog Box For File CheckoutRead/WriteYes
76Source Control:Prompt to Check OutRead/WriteYes
77Source Control:Prompt to Add to SCC When Adding to ProjectRead/WriteYes
78Source Control:Prompt to Add SubVIsRead/WriteYes
7AApplication:Context NameRead OnlyYes
7CNI Security:UserIndicates the name of the user who is currently logged in, using the format of <Domain Name>\<User Name>.Read OnlyYes
7DApplication:Is Editor In MDI ModeRead OnlyYes
7EProject:Owning ProjectReturns a reference to the project that owns the referenced application.Read OnlyNo
7FApplication:Menu Launch:AppReturns a reference to the application instance that launched the calling VI from a menu selection.Read OnlyYes (Read Only)
80Application:Active:ApplicationGets an application reference to the active VIs owning application.Read OnlyYes (Read Only)
81Project:Default ProjectRead OnlyNo
82Project:Has Any Project Been CreatedRead OnlyYes
83Application:LVTargetRead OnlyNo
84Application:Private?Read OnlyYes
85Project:Show Path in Project WindowRead/WriteYes
86Project:Target ItemReturns the associated target item of the application reference you specify.Read OnlyYes
87Project:Get Last Max Load TimeRead OnlyYes
88Project:Libraries[]Read OnlyNo
89Application:Save FormatRead/WriteYes
8BApplication:Target:Class NameRead OnlyYes
8COptions:Editor Menu BarRead OnlyNo
8DApplication:Debug NameReturns the name used for opening a debugging connection to this application or shared library. This method is only useful in built applications or shared libraries.Read OnlyYes
8EApplication:Cross Context SettingsRead OnlyNo
8FApplication:Default:Context NameRead OnlyYes
90Application:Default:ApplicationReturns the default application reference.Read OnlyYes
91Application:All Libraries in All Application InstancesRead OnlyYes
92Project:Active ProjectReturns a reference to the LabVIEW project that is active when this property executes. A project is active if the user has the associated project window in focus or any member of the project in focus, including VIs, controls, and project libraries.Read OnlyNo
93Printing:Custom Control Label/Caption?Specifies whether to print the label and/or caption for each control when using the custom format with one of the print documentation VI methods.Read/WriteNo
94Server:Service NameGets or sets the service name for the LabVIEW VI Server.Read/WriteYes
96Application:Z Compress LevelRead/WriteYes
97Application:On LineRead/WriteYes
98Debug Server:Server ActiveDetermines whether the Debug Server is enabled. You can use this property only in LabVIEW-built applications or shared libraries.Read/WriteYes
99Debug Server:TCP-IP Access ListList that describes which TCP/IP addresses of remote clients can access the Debug Server. You can use this property only in LabVIEW-built applications or shared libraries.Read/WriteYes
9BSource Control:Include VILib In Get DependentsRead/WriteYes
9CSource Control:Include InstrLib In Get DependentsRead/WriteYes
9DSave for Previous:Original AppRead OnlyYes
9EApplication:VI Of Top Most Block DiagramReturns a reference to the block diagram highest in the Z order, which is most likely the last block diagram accessed.Read OnlyYes
9FRun Reserve XInterface ComponentsRead/WriteYes
A0NI Security:Nobody Logged In?Determines if anyone is logged in.Read OnlyYes
A1NI Security:Unique UserRead OnlyYes
A2Delay File NotificationsRead/WriteYes
A3MathScript:PathRead OnlyYes
A4Application:Multi Pwd Op Cancelled?Read OnlyNo
A5MathScript:All M Files In ContextRead OnlyNo
A6Application:Is Migration EnabledRead/WriteNo
A7Crosslink:Force Enable DialogsRead/WriteYes
A8Crosslink:Suppress DialogsRead/WriteYes
A9Suppress Auto Update DependenciesRead/WriteYes
AAApplication:Let Private Context Run With XNodeRead/WriteYes
ADApplication:Clipboard VIRead/WriteYes
AETool NumberRead/WriteYes
AFApplication:Compiler:DFIR CompilerRead/WriteYes
B0Supress Update Name PreflightRead/WriteYes
B1Palettes:Get Functions NamesRead OnlyNo
B2Palettes:Get Controls NamesRead OnlyNo
B3Statechart:Show Custom IconRead OnlyYes
B4Statechart:Show ConfigurationRead OnlyYes
B5Web Server:Config File PathThe path of the LabVIEW Web Server configuration file.Read OnlyYes
B6Web Server:Default Config File PathThe path of the Web Server configuration file that contains the LabVIEW default configuration.Read OnlyYes
B7Statechart:CodeGenCaseStructRead/WriteYes
B8Statechart:Show Path for IsInRead OnlyYes
B9Application:Saveable VersionsAn array of the LabVIEW versions to which this version of LabVIEW can save. The array is in reverse chronological order, with the zeroth element being the current version of LabVIEW. Each element of the array is a valid version to pass to VI server functions which save to previous versions.Read OnlyNo
BAApplication:DSC SupportRead OnlyYes
BBLoad and Save Warnings:Auto Test ModeRead/WriteNo
BCLoad and Save Warnings:HistoryRead OnlyNo
BDStatechart:InlineTopLevelGraphRead/WriteYes
BEApplication:Property and Method Data TypesRead OnlyNo
BFOperating System:Build NumberBuild number of the actual operating system. This string returns an alphanumeric value of the build number that you can use to compare the build version of operating systems. This property is read only.Read OnlyYes
C1Application:Compiler:SanityRead/WriteYes
C2Application:Compiler:DOTRead/WriteYes
C6Operating System:Detailed NameDetailed name of the operating system where the application is actually running. This string value returns the operating system and its version, such as Microsoft Windows XP. This property is similar to a combination of OSName and OSVersion, which return the platform name and a numeric version number respectively. This property is read only.Read OnlyYes
CAApplication:Compiler:LLVM CompilerRead/WriteYes
CDApplication:All Libraries in Application InstanceLists all Libraries currently in memory in this application instance.Read OnlyYes
CEApplication:Target:Number of Logical ProcessorsReturns the number of processing units the computer or target contains.Read OnlyYes
D0Application:Target:Number of Cores per PackageReturns the number of cores per package the computer or target contains.Read OnlyYes
D1Application:Target:Number of Logical Processors per CoreReturns the number of logical processors per core the computer or target contains.Read OnlyYes
D2Application:Target:Current Processor IDRead OnlyYes
D3Application:Target:Data Cache Entry SizesReturns an array of the entry sizes, in bytes, for all cache levels the computer or target contains.Read OnlyYes
D4Application:Target:Data Cache SizesReturns an array of the cache sizes, in bytes, for each cache level the computer or target contains.Read OnlyYes
D5Application:Target:Number of PackagesReturns the number of packages, or chips, the computer or target contains.Read OnlyYes
D7Application:Version YearVersion year of the application. In a stand-alone application or shared library, this property returns the version year of the LabVIEW Run-Time Engine.Read OnlyYes (Read Only)
D9Application:Compiler:BriefDOTRead/WriteYes
DAApplication:Is Build App InstanceRead/WriteNo
DBApplication:TestStandOptionsRead/WriteYes
DCApplication:Legacy Build App File LayoutRead OnlyYes
DDApplication:Available Environment ModesRead OnlyNo
DEApplication:Save VersionReturns the version number of the LabVIEW file format to which LabVIEW documents are saved. This version number might be different from the version number of the application. For example, LabVIEW with the version number 9.0.1 saves LabVIEW documents with a file format version number of 9.0.Read OnlyYes (Read Only)
DFApplication:Save Version As IntegerRead OnlyYes
E0Get NXT ContextRead OnlyNo
E1Application:Hide Load WarningRead/WriteYes
E2Application:Disable Path CaseRead/WriteYes
E3Application:Lock Instantiations for AppBuilderRead/WriteNo
E4Application:Clipboard ModeRead/WriteYes
E6Application:Compiler:SSE Runtime OptimizationRead/WriteYes
E7Printing:Custom Cluster Constants?Specifies whether to print the hidden contents of iconified cluster constants that might be present on the block diagram when using the custom format with one of the print documentation VI methods.Read/WriteNo
E8MathScript:Compiler SignatureRead OnlyNo
E9VIObjCache:PathRead OnlyYes
EAApplication:Compiler:SSE1 Code GenerationRead/WriteYes
EBApplication:Compiler:SSE2 Code GenerationRead/WriteYes
ECApplication:UD Refnum FilesRead OnlyNo
EDApplication:Rename Variables for AppBuilderRead/WriteNo
EEStatechart:Is InstalledRead OnlyYes
EFApplication:Current Environment ModeReturns the current environment mode of LabVIEW, such as robotics. If you call this property from a VI in the LabVIEW development system environment, this property returns an empty string.Read/WriteYes
F0MathScript:HighlightingColorsRead OnlyNo
F1MathScript:ColorsInSyncRead/WriteNo
F2MathScript:CompilerInMemoryRead OnlyNo
F3VIObjCache:Available in RTERead/WriteYes
F4Application:Mass Compile Warn On Read Only VIsRead/WriteNo
F5Application:InstCachePathRead OnlyYes
F6Application:Is Compile SuppressedRead/WriteNo
F7VIObjCache:DistPathRead OnlyNo
F8VIObjCache:UserPathRead OnlyNo
F9Application:Library Finish Partial Load EnabledRead/WriteYes
FAAppBuilderCache:PathRead OnlyNo
FBSeparate Compiled Code For New FilesRead OnlyNo
FCApplication:Compiler ThresholdGets or sets how complex a VI must be before the compiler limits optimizations to improve editor responsiveness. If the complexity of a VI is lower than the threshold indicated by this value, the compiler does not limit optimizations, thereby improving the execution speed of the VI. If the complexity of a VI is higher than the threshold, the compiler limits optimizations in order to improve editor responsiveness for the VI.Read/WriteNo
FDApplication:Locked Down For BuildRead/WriteYes
FEApplication:Cross Compile CountRead OnlyNo
FFApplication:GdiCountRead OnlyNo
100Application:Compiler:FP Register CandidateRead/WriteYes
101Application:Compiler:AutoInliningRead/WriteYes
102Application:ShowAutoErrDialogRead/WriteYes
103Application:Selective DeallocationRead/WriteYes
104Application:Selective Deallocation:EnableForAllVIsRead/WriteYes
105Application:Selective Deallocation:LargeBufferThresholdRead/WriteYes
106Application:Enable Inheritance LinkRef AdditionRead/WriteYes
107Application:Enable Inheritance LinkRefsRead/WriteYes
108Application:Full Version YearRead OnlyYes
109Application:Version Year Number OnlyRead OnlyYes
110Application:ImageTableMaxCountRead OnlyYes
111Application:Enable Binary Compatibility LoadRead/WriteYes
112Application:EnableExcursionFreeExecSystemsRead/WriteYes
113Application:IgnoreUnresolvedDLLRefRead OnlyYes
114Application:ImageTableCountRead OnlyYes
115Application:PPL LoadInCompatible LVVersion Default ValueRead/WriteYes
116Application:Treat LV 2016 As Binary CompatibleRead/WriteYes
117Application:SaveChangesAutoSelectionRead/WriteNo
118Application:NativeEventTracingEnabledRead/WriteYes


Methods

Show/Hide Application Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Application Methods Table
Method ID Short Name (English) Description RTE
80D .NET.Convert Obj To LV Variant X
80C .NET.Convert To .NET Type X
80B .NET.Get Assembly Full Name
883 .NET.Load Assembly
807 Add Probe To Cache X
870 Add To MRU X
910 AllowScripting X
997 IsGlobalBackwardCompatibleLoadEnabled X
996 SetGlobalBackwardCompatibleLoadEnabled X
88B BitAccurateDataSizeForType X
7DE Bring To Front On Windows and Mac OS X, brings the application windows to the front. X
7FB Browse DataSocket Launches the DataSocket Browser dialog box to establish a connection to a DataSocket item. X
7E0 Build.Application
994 Build.BCRTEEnabledPackedLibrary
7E1 Build.Distribution
963 Build.Object Cache
951 Build.PackedLibrary
811 C TypeDefs.Get X
810 C TypeDefs.Reset X
7E6 Call Internal Cmd X
97A Change Popup Paths
7E8 Class Operator.Get Gets the operator VI associated with the specified class. Returns FALSE if it does not find the operator VI. X
7EA Class Operator.Remove Removes the operator VI associated with the specified class. Returns FALSE if it does not find the operator VI. X
7EB Class Operator.Remove All Removes all operator VIs associated with all classes. X
7E9 Class Operator.Set Sets an operator VI for the specified class. Returns FALSE if it fails. X
971 ClearAppBuilderCache Deletes all VI object files from the object cache that a build specification compiles.

This method is similar to selecting Application Builder from the Cache list in the Clear Compiled Object Cache dialog box and clicking the Delete button.

95B ClearCompObjCache Deletes all compiled code in the User object cache.

The User object cache contains the compiled code for the following kinds of files:


Files that have separate compiled code VIs that you deploy to an RT target

942 ClearInstantiationCacheCache
968 ClearSpecCompObjCache
7EF Clipboard.Empty Clears the clipboard.
7ED Clipboard.Get Image Returns the image currently stored on the clipboard.

The LabVIEW Run-Time Engine does not support the Clipboard:Get Image method. If you include this method in a built application, the method does not work properly.

X
851 Clipboard.Read Reads text from the system clipboard. X
852 Clipboard.Write Writes text to the system clipboard. X
993 CloseLEIFBuildData
920 CodeCov.AllVIs
91E CodeCov.Reset
91F CodeCov.Reset VI
923 CodeCov.ShowUnrunDiags
91C CodeCov.Start
91D CodeCov.Stop
922 CodeCov.UnrunDiags
921 CodeCov.VIPercentage
958 Compare CPTMs For Packed Library X
84F Cmp Data Types X
7F3 Compile VIs Needing Compilation
95E Compile App Context X
952 GetCompilerSettings X
98E IsCalleeInlined X
94D ReadDFIRTokens X
953 SetCompilerSettings X
823 Config.Get Settings X
83D Config.Get Target App's Settings X
83C Config.Set Settings X
83E Config.Set Target App's Settings X
7F7 Conn Responsive.Check Checks if the VI Server connection is responsive.

Use this method to check the status of a VI Server connection. If the connection is not responsive, the method returns network connection error code 1130. The method prompts the server for a message and considers the connection unresponsive if LabVIEW does not receive a message within the time you specify in PingDelay. Use the Connection Responsiveness:Information method to set PingDelay.

X
7F8 Conn Responsive.Info Gets and sets how often LabVIEW checks if a VI Server connection is responsive.

Set the PingDelay and PingTimeout parameters of this method to configure how LabVIEW checks the connection. If LabVIEW does not receive a message in the time you specify in PingDelay, LabVIEW sends a query to prompt the VI Server network connection for a message. After sending the query, if LabVIEW does not receive a message in the time you specified in PingTimeout, LabVIEW considers the connection unresponsive. Then, all VIs and functions waiting on the connection return network connection error code 1130.

For example, if you set PingDelay to 3000 and PingTimeout to 1000, LabVIEW sends a query to verify the status of the VI Server network connection every time 3 seconds elapse without LabVIEW receiving a message over the connection. If LabVIEW does not receive a reply from the network, LabVIEW waits 1 second before all VIs and functions waiting on the connection return network connection error 1130, which you can handle on the block diagram.

Default for PingDelay and PingTimeout is 10,000 ms, which means LabVIEW checks the connection every 10 seconds and waits up to 10 seconds for the connection to respond.

Note If a network operation times out according to the timeout value you specify in PingTimeout, LabVIEW considers the connection unresponsive but does not close the connection. All current and future calls waiting on the connection return a connection error. LabVIEW does not send another message to query the connection status until LabVIEW considers the connection responsive again. A connection becomes responsive again when LabVIEW receives a message over the connection.

X
957 Consolidated Save
815 Context.CreateLocalHostAppInstance X
974 Context.CrossContextLoadVI X
86D Context.GetFromProj
81E Context.Get Preferred X
812 Context.OpenSibling X
864 Context.Ref Count.Dec X
863 Context.Ref Count.Inc X
936 CopyDataConvert X
809 Create COM WDT Data X
89F CreateGUID X
932 CreateInstantiation
850 Data Type Color Returns the color associated with a data type. X
845 DbgConn.CloseDbgConn Closes the connection to the application or shared library specified in Debug Name.
89E DbgConn.GetDbgConn
846 DbgConn.ListApps Returns the list of applications and shared libraries you can debug on the computer specified by Server Address.
844 DbgConn.OpenDbgConn Opens a connection to the application or shared library you can debug.
89B DebugStartTiming X
944 DTT.FilterVILibEvents X
906 DTT.GetTraceData X
916 DTT.IsTracingEnabled X
905 DTT.Setup X
98A DoPostInstallObjCacheCheck
911 EnableExternalProptypes X
913 EnableMetaTrans X
912 EnableTempSelect X
915 DeferErrWinUpdates
89D OpenErrWdw X
967 FlushArcCaching X
882 ForceAutoSave
902 ForceUpdateDiskMonitoring X
978 Freeze Polys
91B GetActiveVIRef Returns a reference to the VI whose window is currently active (focused). If the active window is not a VI, this method returns Not A Ref.
97D Get Broken VI List
86C GetClassNameFromID X
95A GetEnvModeDisplayName Returns the display name of the environment mode you specify. X
946 GetEnvModePath
909 Get Global Dependency Data X
943 GetInstantiationConPaneFromCache
979 GetInstantiationVIPath X
836 Get Shell Icon Of File X
938 Get Hier Img Scaled Gets the scaled image of the VI Hierarchy. X
989 Get VI.Bookmarks Returns the bookmark information for the VI specified in VI Path. You do not need to load the VI into memory in order to read the bookmark information. This method returns an error if the VI is password protected, if the VI is saved in an earlier version of LabVIEW and is not currently in memory, or if the VI does not have a block diagram. X
97F Get VI.CompiledForCurrent
99C Get VI.ConPane CRC Ignore DD v2 X
99B Get VI.ConPane CRC v3 X
91A Get VI.ConPane DataType Returns the data type of the connector pane as variant data without loading the VI.

Use the VIs in the labview\vi.lib\Utility\VariantDataType directory to retrieve information from the variant output.

Note To ensure the information returned by this method is current, make sure the VI whose connector pane you reference has been recompiled in the current version of LabVIEW.

X
806 Get VI.Description Returns the description stored in the VI description field on the Documentation page of the VI Properties dialog box for the specified VI. Unlike the VI Description property, this method does not load the VI into memory. X
947 Get VI Editor Version Returns the version of LabVIEW that last saved the VI. The version of LabVIEW that last saved the VI might be different from the file format version of the VI. For example, if you use LabVIEW 9.0.1 to save a VI, the VI has a file format version of 9.0.

To obtain the file format version of the VI, use the Get VI:Version method.

LabVIEW does not open the VI when retrieving the version information. If you specify a path to a file that is not a VI, LabVIEW returns error 6559.

X
98D Get VI.GetPrimDeps
990 Get VI.Help Info Returns Help path, Help tag, Help Used, and Help URL from the Documentation page of the VI Properties dialog box for the specified VI. This method does not load the VI into memory. X
88C Get VI.Icon Returns the icon of the specified VI without loading the VI into memory. X
97E Get VI.Is Global
860 Get VI.Is Probe Returns whether the specified VI is a probe without loading the VI.
948 Get VI.Qualified Name Returns the qualified name of the referenced VI without loading the VI. X
886 Get VI.Revision History Returns the revision history that appears when you click the Revision History button on the General page of the VI Properties dialog box of the specified VI. This method does not load the VI into memory. X
805 Get VI.Title Returns the name that appears in the title bar of the specified VI. This method does not load the VI into memory. X
7F9 Get VI Version Returns the LabVIEW file format version of the VI. The file format version of the VI might be different from the version of LabVIEW in which the VI was last saved. For example, if you use LabVIEW 9.0.1 to save a VI, the VI has a file format version of 9.0.

To obtain the version of LabVIEW in which the VI was last saved, use the Get VI:Editor Version method.

LabVIEW does not open the VI when retrieving the version information. If you specify a path to a file that is not a VI, LabVIEW returns error 6559.

X
970 Get Compiled Object File X
841 Global Data.Free X
840 Global Data.Get X
83F Global Data.Set X
862 GetDataTypeHelpImage
868 Get Func Help Image
7DA History Since
82C I/O Ctrl.Get Name Attributes X
82B I/O Ctrl.Get Names X
80A Image Data To Byte Array X
964 Install Adjacent Cache
90A Invalidate Depdendency File Info X
7E4 LVRT.Check DLLs
7E3 Disconnect From Slave Disconnects the open connection between LabVIEW and an RT target.

This is equivalent to right-clicking the target in the project and selecting Disconnect from the shortcut menu. This method applies to Real-Time Module applications only.

961 LVRT.Get LibP Sigs
872 LVRT.Transfer Files
859 LVRT.Unload Startup App
98B All Methods Of LVClass Returns an array of names and an array of paths for all methods of a class. The methods of the class are member VIs that can be called as subVIs. In other words, LabVIEW excludes global VIs, control VIs, and polymorphic VIs from the output arrays. X
88F LVClass.Create Creates a new LabVIEW class.
98C LVClass Implementing VI Path Returns the path to the VI that implements the specified method within the specified class. If the specified class does not implement the method, this method returns an ancestor VI implementation. X
88E LVClass.Open Opens the LabVIEW class specified by Path.
956 Release LV Class Cookies X
826 Library.Create Creates a new LabVIEW project library.
895 Library.Deploy Libraries Deploys library files to the specified computer.

If you deploy a library programmatically that contains both shared variables and VIs, LabVIEW generates error code 1 and does not deploy the library to the engine. Deploy the library manually to avoid the error.

X
849 Library.Deploy Library Deploys a library file to the specified computer.

If you deploy a library programmatically that contains both shared variables and VIs, LabVIEW generates error code 1 and does not deploy the library to the engine. Deploy the library manually to avoid the error.

X
86E Library.GetFileLVVersion Returns the LabVIEW file format version of the library. The file format version of the library might be different from the version of LabVIEW in which the library was last saved. For example, if you use LabVIEW 9.0.1 to save a library, the library has a file format version of 9.0. X
935 Library.Get Ref By Qualified Name Retrieves a reference to a LabVIEW project library that is already loaded within the application instance. If the library cannot be found in memory, LabVIEW returns Not A Refnum. X
982 Library.Has Shared Variables
95D Library.IsOpenedInAnyContext
825 Library.Open Opens the LabVIEW project library specified by Path. X
89A Library.OpenAsUntitled
92F Library.Undeploy Libraries Undeploys library files from the specified computer. X
84E Library.UndeployLibrary Removes a library from a target. X
820 License.Check In X
81F License.Check Out X
92D License.Get Feature Activators X
848 License.Get Feature Status X
83A License.Get Licensed Version X
816 Linker.Notify of File Change
89C Linker.Read Info From File
998 Linker.Read Info From File Exclude LVRT Shipped Libs
843 Linker.Write Info To File
7D5 Mass Compile Loads and compiles VIs in a directory, including VIs in subdirectories, for the specified application instance.

This method is similar to the Mass Compile option in the Mass Compile dialog box.

918 CheckMathScriptWatchedPaths
937 LoadMSCompiler
980 LoadMSCompilerComponent
945 LocateMSTargetSyntaxVI
991 DSObserverCmd X
981 Refresh Menus Refreshes the File, Tools, and Help menus from disk programmatically.
933 Move VIs X
903 MultiPwdPromptOperation.Begin
904 MultiPwdPromptOperation.End
84B NI Sec.ChangePassword X
82A NI Security.Get Access Rights Validates the access control list with the current application user logged in. X
84C NI Sec.GetDomains X
829 NI Security.Invoke Login Dialog Invokes the NI Security Login dialog box programmatically. X
827 NI Security.Login Logs a user into the NI domain. X
828 NI Security.Logout Logs the current user out of the NI domain and reverts to the default user. X
865 NI Security.SVE Login X
866 NI Security.SVE Logout X
867 NI Security.SVE User X
949 OpenVIInNXTContext
941 UpdateNXTContextName
99A NativeEventTracingSetup X
7FF New LabVIEW Document Creates a new LabVIEW document. This method achieves the same results as when you create a new document in the New dialog box.
88D Notify LV SCC Enabled X
986 Object Manager:Get Classes X
985 Object Manager:Get Managers X
987 Object Manager:Get Properties X
988 Object Manager:Show Help X
81B Open.LV Document Opens a LabVIEW document.

This method is similar to selecting File»Open and browsing to the document.

919 Open.LV Documents
830 Open.Recently Opened File Opens the file specified by Index from the most recently used file list. X
854 Open.Recently Opened Project Opens the project specified by Index from the most recently used project list. X
90D OpenVIAsSystemVI X
901 OpenVIAsTemplate X
962 Open.VI Without Refees X
992 OpenBinaryLibrary X
95F Packed Library.Enable Caching X
95C Packed Library.Get Exported File List X
995 PackedLibrary.IsLoadableInBinaryCompatibleLV X
930 Close All Palettes Closes the Controls and Functions palette sets programmatically. To close the palette sets, add the Palettes:Close All Palettes method to the block diagram and run the VI.
966 Force Finsh Load All Palettes
80E Get Pal Menu Info
94C Get Pal Item Icon
959 Get Pal Item Path Returns the path to the palette item you specify. X
965 Get Palette Statistics
861 Refresh Palettes Updates the Controls and Functions palette set programmatically.

To update the palette set, place the Palettes:Refresh method on the block diagram to the right of the Write Palette VI and run the VI.

This method is similar to the Save Changes button on the Edit Controls and Functions Palette Set dialog box.

801 Pwd.Add To Cache X
800 Pwd.Clear Cache X
858 Pwd.Del From Cache X
94B App.PrepareToLoadFiles X
7D0 Print.Function To Printer
94E CreateProbeVIFromVariant
94F GetProbePathListFromVariant
893 Project.Close Refs X
818 Project.Do New Item
90F Project.DoingAutosaveRecovery X
954 Project.GetFileLVVersion Returns the LabVIEW file format version of the project. This version might be different from the version of LabVIEW in which the project was last saved. X
837 Project.Get Icon Of Type X
817 Project.Get New Items X
835 Project.Load Default Project X
814 Project.New Creates a new, empty LabVIEW project. You also can use the Project Explorer window to create a new project.
97B Project.NewWithPrompts Creates a new, empty LabVIEW project and prompts the user to add any open VIs from the main application instance.
813 Project.Open Loads a LabVIEW project from disk. If the project is already in memory, this method returns a reference to the existing project. You can use this reference with the Project properties.

You also can select File»Open Project to navigate to and open a project.

X
999 Project.Open And Suppress Source-Only
899 Project.OpenAsUntitled
871 Project.OpenPrivCtxts X
90B Project.Register Debug VI X
82F Project.Reg Proj Ref For Cleanup Proc
90C Project.Simulate File Open X
7E7 Query Internal Operation Tracking Data X
81C RecentOpen.LV Files Gets the list of most recently used files from LabVIEW and displays the paths and filenames. This method returns the same list as if you selected File»Recent Files.
853 RecentOpen.LVProjects Gets the list of most recently used LabVIEW projects from LabVIEW and displays the paths and project names. This method returns the same list as if you selected File»Recent Projects.
7F2 RP.Client Network Load X
804 RP.Client Release Control Returns control of the remote front panel to the server. The server grants control to the next client in the queue or regains control if no requests are in the queue.

This method is similar to the Release Control of VI shortcut menu item.

This method can return networking error codes.

Example

X
803 RP.Client Request Control Requests control of the front panel of a VI on the server computer.

This method is similar to the Request Control of VI shortcut menu item.

This method can return networking error codes.

Example

X
802 RP.Close Connection To Server Closes a connection to a VI on the server computer.

This method can return networking error codes.

X
7F1 RP.Open Connection To Server Opens a connection to a server and displays the front panel of a VI on the server computer. You also can request control of the front panel.

This method is similar to the Connect to Remote Panel dialog box.

This method can return networking error codes.

Example

X
7EE RP.Server Network Load X
97C ResetCrossCompileCount
969 Restart Quits and then restarts LabVIEW. This method is supported only on Windows.

Note When you invoke this method with unsaved files open, a dialog box prompts you to save any changes you made before the application terminates. If you cancel the dialog box, LabVIEW does not restart. This method is useful for restarting LabVIEW after you change the environment in a way that requires you to restart. For example, in an application that activates a license for a LabVIEW third-party add-on, you can use this method to programmatically restart LabVIEW, which then updates the status of the license.

X
955 Save All X
84D Save Stock Objects
877 Scene.Drawable.Geometry.New Box Creates a geometry that you can use to set an object in a 3D scene to a box. X
878 Scene.Drawable.Geometry.New Cone Creates a geometry that you can use to set an object in a 3D scene to a cone. X
879 Scene.Drawable.Geometry.New Cylinder Creates a geometry that you can use to set an object in a 3D scene to a cylinder. X
87A Scene.Drawable.Geometry.New Height Field Creates a new height field in a 3D scene.

The collection of values in the height field specify elevations at points above a grid.

X
87C Scene.Drawable.Geometry.New Mesh Creates a new mesh in a 3D scene.

The collection of polygons and vertices in the mesh define the shape of the 3D object.

X
87B Scene.Drawable.Geometry.New Sphere Creates a geometry that you can use to set an object in a 3D scene to a sphere. X
900 Scene.Drawable.New Text Creates a new text object in a 3D scene. X
87E Scene.New Clip Plane Creates a new clip plane in a 3D scene.

The clip plane defines values beyond which an object can or cannot be drawn. An object that encounters a clip plane will be cut off at the point at which it intersects the plane.

X
889 Scene.New Light Creates a new light in a 3D scene. X
873 Scene.New Object Creates a new object in a 3D scene.

You must assign a geometry to the object before it can appear in the 3D scene.

X
874 Scene.New Texture Gets a reference to a texture to apply to a geometry in a 3D scene. X
87F Scene.New Window Creates a new window in which LabVIEW generates the 3D scene. X
881 Scene.Read Scene File Reads a 3D scene file that you create with the Scene:Write Scene File method. The file being read must have a .lvsg or .dae extension.

If you read a scene saved to disk with textures, this method attempts to load the textures from the location where Scene:Write Scene File created the external images.

X
880 Scene.Write Scene File Writes a new 3D scene file. The filename must end with a .lvsg or .dae extension.

If the scene includes textures, this method writes the textures as .png files to the same directory as the .lvsg or .dae file. The filenames for the textures consist of an enumerated integer followed by the name of the .lvsg or .dae file.

X
93A SearchCloseSession
93C SearchInitSession
93B SearchLoadPlugin
939 SearchOpenSession
93E SearchSyncSearchForQD
93D SearchSyncSearch
888 Sig.GetSignatureFromVIFile X
887 Sig.GetUserCodeGUIDFromVIFile X
960 Simulation.GetParamOffsets X
898 Statechart.Create Creates a new statechart. You must save the statechart to disk.
897 Statechart.Open Opens the statechart specified by Path.
90E Statechart.Open Private X
914 Symbols.GetValue
890 SyncEverything X
85B Tag.Get Tag X
85D Tag.Remove All Tags X
85E Tag.Remove Tag X
85C Tag.Set Tag X
884 Get VI Tag X
896 Get VI Tag Names X
885 Set VI Tag
972 TracingTimerEnable
973 TracingTimerHarvestLogAndReset
869 TD.AddPathInfo
86A TD.CleanPathInfo
86F TD.HasCompletePathInfo
86B TD.RecTypedefDisconnect
88A Update Launch Message X
924 UI:Abort Merge VIs
7D6 UI.Cmp VIs
983 UI.Cmp VIs XML
931 UI.Edit Icon
7FD UI.Hilight Pal Menu Item Opens the Controls or Functions palette and highlights the specified control or function.
81A UI.Invoke Menu Item Simulates the user selecting a menu item. In general, this method works on global menu items but not document-specific menu items, in which case the method fails silently. X
839 UI.Invoke Prefs Dlg X
92B UI:Merge Clean Up Context
92A UI:Merge Close Library
928 UI:Merge Close VI
927 UI:Merge Cross Load VI
929 UI:Merge Load Library
92E UI:Merge Load Refees
925 UI:Merge Load VI
92C UI:Merge Save Library
926 UI:Merge Save VI
894 UI.Merge VIs
93F UI.PlaceObjectOnCursor Places an object on the cursor so the object is ready to add to the front panel window or the block diagram window. You can specify the object using either style or path.

This method enables you to access objects that do not exist on the Controls or Functions palette. You can use the User Interaction:Place Palette Object on Cursor method to access palette objects by name.

7FA UI.PlacePaletteObjOnCursor Places a palette object on the cursor so the object is ready to add to the front panel window or the block diagram window.
940 UI.Drop Proj Item Copy
81D UI.Search LabVIEW Help
7F4 UI.Show Inplaceness Terminals
98F UI.ShowPaletteObjContextHelp Updates the Context Help window to show content for a palette object you specify, similar to mousing over the palette menu item.
855 VIs Strings.Export Exports to a tagged text file all the User Interface related strings of the VIs specified by VI Array.

Exports the following strings about VI and front panel objects to a tagged text file: VI name and description, object caption labels, object free labels, default data (string, table, path, and array default data), private data (listbox item names, table row and column headers, graph plot names, graph cursor names, graph annotation names, and tab control page captions), and polymorphic VI data (instance names in the polymorphic VI and selector shortcut menus).

857 VIs Strings.Export Private
856 VIs Strings.Import Imports to a tagged text file all the User Interface related strings of the VIs specified by VI Array.

Imports the following strings about VI and front panel objects to a tagged text file: VI name and description, object caption labels, object free labels, default data (string, table, path, and array default data), private data (listbox item names, table row and column headers, graph plot names, graph cursor names, graph annotation names, and tab control page captions), and polymorphic VI data (instance names in the polymorphic VI and selector shortcut menus).

X
917 WebSrvr.Conf Configures the LabVIEW Web Server with the given file. If you do not wire Web Server to the configuration file, Web Server uses the default configuration file. X
831 XControl.Create Creates an XControl library.
833 XControl.Open Opens an XControl library and returns a reference to it.
832 XNode.Create
834 XNode.Open

Events

Show/Hide Application EventsTable

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
Application Events Table
Code Name Type
1073741888 Application Activation Notify
1073741850 Application Instance Close Notify
2147483652 Application Instance Close? Filter
1073741908 Auto Error Notification Notify
1073741906 Bookmark Info Change Notify
1073741896 Context Help Window Updated Notify
1073741883 NI Security User Change Notify
1073741889 OS Open Document Notify
2147483717 OS Open Document? Filter
1073741897 Selection Change Notify
1073741825 Timeout Notify
1073741857 VI Activation Notify
1073741907 VI Deactivation Notify
1073741858 VI Redraw Notify
1073741859 VI Scroll Notify
1073741899 Window Opened Notify
2147483722 Window Opened? Filter

History

Version Change(s)
LabVIEW 2018
  • Linker:Read Info From File Exclude LVRT Shipped Libs property added.
  • Application:SaveChangesAutoSelection method added.
LabVIEW 2017
  • Application:ImageTableMaxCount, Application:Enable Binary Compatibility Load, Application:EnableExcursionFreeExecSystems, Application:IgnoreUnresolvedDLLRef, Application:ImageTableCount, Application:PPL LoadInCompatible LVVersion Default Value, and Application:Treat LV 2016 As Binary Compatible properties added.
  • Application:ImageTableCount property deprecated.
  • Build:BCRTEEnabledPackedLibrary, Packed Library:Is Packed Library Loadable In Binary Compatible LabVIEW, BCRTE:SetGlobalBackwardCompatibleLoadEnabled, and BCRTE:IsGlobalBackwardCompatibleLoadEnabled methods added.
LabVIEW 2016
  • Application:Enable Inheritance LinkRef Addition, Application:Enable Inheritance LinkRefs, Application:Version Year Number Only, and Application:ImageTableCount Is Running Interactively properties added.
  • Application:ImageTableSize property deprecated.

See Also