NI System Configuration API Reference

Content Type
Programming Language
Current manual

Initialize Session (VI)

Initialize Session (VI)

Installed With: NI System Configuration

Initializes any system configuration VI to gather information from a specified target. You must use this VI to obtain a handle for a specified target that can be used in other System Configuration VIs.

Note  This VI communicates to the device at the specified address. If the device is no longer online, but it has previously been discovered in Measurement & Automation Explorer (MAX), this VI succeeds, allowing you to retrieve cached information about the device. To determine if a Real-Time target is online, use the System Property Node to return the System Status property.

Initialize Session

cstr.gif

Password specifies the password for the system you are initializing. Leave this input blank if no password has been set.

cstr.gif

User Name specifies the username for the system you are initializing. Leave this input blank if no username has been set.

cio.gif

Target specifies the IP address (ex. "224.102.13.24" ), MAC address (ex. "00:80:12:34:56:AB" ), or DNS name (ex. "myhost" ) of the target on a local or Real-Time system. The default is localhost .

cbool.gif

Force Property Refresh forces properties to be refreshed every time they are read by default. If FALSE, properties may return cached results to improve performance. This input is optional.

ci32.gif

Language specifies the language. This input is optional.

Automatic (0)

(default) automatically chooses the language based on the language of LabVIEW installed

Chinese Simplified (x804)

Simplified Chinese

English (x409)

English

French (x40C)

French

German (x407)

German

Japanese (x411)

Japanese

Korean (x412)

Korean

cerrcodeclst.gif

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

cu32.gif

Connect Timeout specifies the time in milliseconds that the VI waits before the operation times out. The default is 4000 ms (4 s). In some cases, this operation may take longer to complete. Use this timeout with remote systems during initialization only. This input is optional.

iio.gif

Session out returns the refnum for the system.

ierrcodeclst.gif

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

Was this information helpful?