NI System Configuration API Reference

Get Available Software (VI)

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

Retrieves a list of software on the local system that is available for installation on a Real-Time target.

Get Available Sets

Retrieves a list of software sets on the local system that are available for installation to the specified target. Not all Real-Time systems support the installation of software sets.

Get Available Sets

cio.gif

Session in indicates the Real-Time system receiving the software installation from the local system.

cu32.gif

Item Types specifies which software components to return in the list of items for a software set.

all visible (0)

Specifies to return all visible software components. This includes all standard, startup, and essential components.

all including hidden (1)

Specifies to return all visible and hidden software components.

standard only (2)

Specifies to only return standard software components.

startup only (3)

Specifies to only return components that are startup applications.

cerrcodeclst.gif

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

iio.gif

Session out returns the refnum for the system.

i1dcclst.gif

Software Sets returns an array of software set information clusters.

icclst.gif

Information returns general information about the software set.

istr.gif

title is the title of the software set.

istr.gif

description is a short description of the software set.

istr.gif

ID is the unique identifier for the software set.

istr.gif

version is the version of the software set. For software sets, this parameter returns an empty string.

iu32.gif

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

i1dcclst.gif

Items returns the content of the software set, consisting of one or more software components.

istr.gif

title is the title of the software component.

istr.gif

description is a short description of the software component.

istr.gif

ID is the unique identifier for the software component.

istr.gif

version is the version of the software component.

iu32.gif

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

i1dcclst.gif

Add-Ons returns a list of software components that go with the particular software set.

istr.gif

title is the title of the add-on.

istr.gif

description is a short description of the add-on.

istr.gif

ID is the unique identifier for the add-on.

istr.gif

version is the version of the add-on.

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.

Get Available Components

Retrieves a list of software components on the local system that are available for installation to the specified target.

Get Available Components

cio.gif

Session in indicates the Real-Time system receiving the software installation from the local system.

cu32.gif

Item Types specifies which software components to return.

all visible (0)

Specifies to return all visible software components. This includes all standard, startup, and essential components.

all including hidden (1)

Specifies to return all visible and hidden software components.

standard only (2)

Specifies to only return standard software components.

startup only (3)

Specifies to only return components that are startup applications.

cerrcodeclst.gif

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

iio.gif

Session out returns the refnum for the system.

i1dcclst.gif

Software Components returns a list of software components on the system.

istr.gif

title is the title of the software component.

istr.gif

description is a short description of the software component.

istr.gif

ID is the unique identifier for the software component.

istr.gif

version is the version of the software component.

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.

Get Filtered Sets

Retrieves a list of software sets on the local system that are available for installation to the specified target. Not all Real-Time systems support the installation of software sets.

Get Filtered Sets

cstr.gif

Device Class specifies the type of device for which you are searching. Common values are PXI and cRIO . To specify multiple classes, use a comma to separate the values. For a listing of the other available values and an explanation of the intended use, refer to KnowledgeBase article extu82 .

cstr.gif

Operating System specifies the operating system.

cpath.gif

Repository in specifies the location that contains installable components.

cu32.gif

Item Types specifies which software components to return in the list of items for a software set.

all visible (0)

Specifies to return all visible software components. This includes all standard, startup, and essential components.

all including hidden (1)

Specifies to return all visible and hidden software components.

standard only (2)

Specifies to only return standard software components.

startup only (3)

Specifies to only return components that are startup applications.

cerrcodeclst.gif

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

ci32.gif

Product ID specifies the bus-specific product identifier code. This is not the product's sellable model number.

ipath.gif

Repository out returns the refnum for the repository.

i1dcclst.gif

Software Sets returns an array of software set information clusters.

icclst.gif

Information returns general information about the software set.

istr.gif

title is the title of the software set.

istr.gif

description is a short description of the software set.

istr.gif

ID is the unique identifier for the software set.

istr.gif

version is the version of the software set. For software sets, this parameter returns an empty string.

iu32.gif

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

i1dcclst.gif

Items returns the content of the software set, consisting of one or more software components.

istr.gif

title is the title of the software component.

istr.gif

description is a short description of the software component.

istr.gif

ID is the unique identifier for the software component.

istr.gif

version is the version of the software component.

iu32.gif

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

i1dcclst.gif

Add-Ons returns a list of software components that go with the particular software set.

istr.gif

title is the title of the add-on.

istr.gif

description is a short description of the add-on.

istr.gif

ID is the unique identifier for the add-on.

istr.gif

version is the version of the add-on.

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.

Get Filtered Components

Retrieves a list of software components on the local system that are available for installation to the specified target.

Get Filtered Components

cstr.gif

Device Class specifies the type of device for which you are searching. Common values are PXI and cRIO . To specify multiple classes, use a comma to separate the values. For a listing of the other available values and an explanation of the intended use, refer to KnowledgeBase article extu82 .

cstr.gif

Operating System specifies the operating system.

cpath.gif

Repository in specifies the location that contains installable components.

cu32.gif

Item Types specifies which software components to return.

all visible (0)

Specifies to return all visible software components. This includes all standard, startup, and essential components.

all including hidden (1)

Specifies to return all visible and hidden software components.

standard only (2)

Specifies to only return standard software components.

startup only (3)

Specifies to only return components that are startup applications.

cerrcodeclst.gif

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

ci32.gif

Product ID specifies the bus-specific product identifier code. This is not the product's sellable model number.

ipath.gif

Repository out returns the refnum for the repository.

i1dcclst.gif

Software Components returns a list of software components on the system.

istr.gif

title is the title of the software component.

istr.gif

description is a short description of the software component.

istr.gif

ID is the unique identifier for the software component.

istr.gif

version is the version of the software component.

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.

Get Filtered Base System Images

Retrieves a collection of base system images available from a repository path.

Get Filtered Base System Images

cstr.gif

Device Class specifies the type of device for which you are searching. Common values are PXI and cRIO . To specify multiple classes, use a comma to separate the values. For a listing of the other available values and an explanation of the intended use, refer to KnowledgeBase article extu82 .

cstr.gif

Operating System specifies the operating system.

cpath.gif

Repository in specifies the location that contains installable components.

cerrcodeclst.gif

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

ci32.gif

Product ID specifies the bus-specific product identifier code. This is not the product's sellable model number.

ipath.gif

Repository out returns the refnum for the repository.

i1dcclst.gif

Base System Images returns a list of base system images available for the system.

istr.gif

title is the title of the software component.

istr.gif

description is a short description of the software component.

istr.gif

ID is the unique identifier for the software component.

istr.gif

version is the version of the software component.

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.

Log in to get a better experience