Add Item Method

LabView Local Project Settings

Add Item Method

Short Name: AddItem

Installed With: Base Package

Class: ProjectItem Methods

Adds a new project item of the specified type to the LabVIEW project with the referenced item as the parent. You also can use the Project Explorer window to add an item to a project.

This method returns an error if the specified type cannot be created under the current item. The method also returns an error when you try to add a shared variable to a library that is not opened in a project.

Note  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

Example

Parameters

NameRequiredDescription
outputNoReturns a reference to the added file.
NameNoName of the project item you want to add.
PathNoPath to the project item you want to add.
TypeNoSpecifies the project item type. The following values are the most common Type values:
  • VI
  • Folder
  • Library
  • XControl
  • EXE
  • DLL
  • Source Distribution
  • Installer
  • Zip File
  • Hyperlink
Some of the values listed above are supported only on certain LabVIEW Development Systems. Refer to ni.com/labview for more information about LabVIEW Development Systems.

To determine the value of Type for a project item that is not listed above, use the Type String property to programmatically return the type of the item.

Remarks

The following table lists the characteristics of this method.

Available in Run-Time Engine and Real-Time Operating SystemNo
Settable when the VI is runningNo
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access disallowedNo
Must wait until user interface is idleNo
Available with control VIsNo
Available with global VIsNo
Available with strict type definitionsNo
Available with polymorphic VIsNo

Example

Refer to the Add Files to Project VI in the labview\examples\project\viserver directory for an example of using the Add Item method.

 Open example  Browse related examples