NI System Configuration API Reference

Install and Uninstall Components (VI)

  • Updated2023-02-21
  • 5 minute(s) read
Installed With: NI System Configuration

Use the Install and Uninstall Components VI to install components, uninstall components, or both install and uninstall components simultaneously (as long as two components do not overlap each other).

This VI installs components you specify in the Software Components to Install parameter, as well as any required hidden components. If Auto-select Dependencies is TRUE, this VI also installs other visible components if they are dependencies of any component you specified to install in the Software Components to Install parameter and they are not already installed on the system. This VI only uninstalls visible components that are specified in the Software IDs to Uninstall parameter.

Install And Uninstall Components

cbool.gif

Restart Automatically restarts the system into install mode by default before the operation is performed, and restarts back to a running state after the operation is complete. If you choose not to restart automatically, the operation will fail if the system is not already in install mode.

cio.gif

Session in specifies the IP address or hostname of the system on which to perform this operation. When left blank, this VI operates on the local system.

c1dcclst.gif

Software Components to Install specifies software to install.

cstr.gif

title is the title of the software components. This input is optional.

cstr.gif

description is a short description of the software components. This input is optional.

cstr.gif

ID is the unique identifier for the software components. This input is required.

cstr.gif

version is the version of the software components. This is required when installing if you require a certain minimum or exact version as specified by the Version Selection input.

cu32.gif

component type is the type of the component.

standard (0)

Specifies the component is a standard visible software component.

hidden (1)

Specifies the component is a hidden software component.

system (2)

Specifies the component is a required system component.

unknown (3)

Specifies the component type is unknown.

startup (4)

Specifies the component is a startup application.

image (5)

Specifies the component is a user-defined system image.

essential (6)

Specifies the component is a required visible software component.

c1dstr.gif

Software IDs to Uninstall specifies identifiers of software components to remove.

cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

ccclst.gif

Install Options specifies options that affect which versions of components and whether additional components get installed.

c1du32.gif

Version Selection specifies which versions to install.

Highest (0)

(default) specifies the version based on user input. If a version number is not specified, the highest installable version will be selected. If a version number is specified but is higher than any available software on the host, the installation will fail.

Exactly (1)

installs the exact specified version. If the specified version does not match the available software on the host the installation will fail.

cbool.gif

Auto-select Dependencies specifies whether to automatically select software components that are required by the software you have specified to install.

cbool.gif

Auto-select Recommends selects whether to automatically select recommended packages.

iio.gif

Session out returns the refnum for the system.

i1dcclst.gif

Broken Dependencies returns a list of broken dependencies, which are specific software components that cannot operate without another software component installed. This array will be empty when an installation succeeds.

icclst.gif

Depender is the software component that requires another software component (the dependee ) to install and operate correctly.

istr.gif

title is the title of the software components.

istr.gif

description is a short description of the software components.

istr.gif

ID is the unique identifier for the software components.

istr.gif

version is the version of the software components.

iu32.gif

component type is the component type. Components can be standard, hidden, system, unknown, startup, image, or essential.

icclst.gif

Dependee is the software component that must be present for the depender to install and operate correctly.

istr.gif

title is the title of the software components.

istr.gif

description is a short description of the software components.

istr.gif

ID is the unique identifier for the software components.

istr.gif

version is the version of the software components.

iu32.gif

component type is the component type. Components can be standard, hidden, system, unknown, startup, image, or essential.

ierrcodeclst.gif

error out returns error information. This output provides standard error out functionality.