niDCPower Initialize With Options

NI DCPower LabView

JavaScript is disabled. Details


niDCPower Initialize With Options

Creates a new IVI instrument driver session to the power supply specified in resource name and returns a session handle you use to identify the power supply in all subsequent NI-DCPower VI calls. With this VI, you can optionally set the initial state of the following session properties: Simulate, Driver Setup, Range Check, Query Instrument Status, Cache, and Record Value Coercions. This VI also sends initialization commands to set the power supply to the state necessary for NI-DCPower to operate. To place the power supply in a known startup state when creating a new session, set reset device to TRUE. This action is equivalent to using the niDCPower Reset VI.

To open a session and leave the device in its existing configuration without passing through a transitional output state, set reset device to FALSE, and then immediately call the niDCPower Abort VI. To apply a new configuration without disrupting the output channels of the device, configure the device in Delayed Configuration mode as in the previous session changing only the desired settings, and then call the niDCPower Initiate VI.

niDCPower_Initialize_With_Options.gif
cio.gif resource name specifies the resource name assigned by Measurement & Automation Explorer (MAX), for example PXI1Slot3, where PXI1Slot3 is an instrument resource name. resource name can also be a logical IVI name.
cbool.gif id query specifies whether the device is queried to determine if the device is a valid instrument for NI-DCPower. The default is TRUE.
cbool.gif reset device specifies whether to reset the power supply during the initialization procedure. The default is TRUE.
cstr.gif option string specifies the initial value of certain properties for the session. The syntax for option string is a list of properties with an assigned value where 1 is TRUE and 0 is FALSE. Each property/value combination is delimited with a comma (,), as shown in the following example:

Simulate=0,RangeCheck=1,QueryInstrStatus=0,Cache=1

If you do not wire this input or pass an empty string, the session assigns the default values, shown in the preceding example, for these properties.

You do not have to specify a value for all the properties. If you do not specify a value for a property, the default value is used.

For more information about simulating a device, refer to Simulating a Power Supply or SMU.

ccclst.gif error in (no error) describes error conditions that occur before this VI runs.
cbool.gif status is TRUE (X) if an error occurred before this VI ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI ran. The default is FALSE.
ci32.gif code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.
cstr.gif source describes the origin of the error or warning and is, in most cases, the name of the VI that produced the error or warning. The default is an empty string.
iio.gif instrument handle out returns a handle that you use to identify the session in all subsequent NI-DCPower VI calls.
icclst.gif error out contains error information. If error in indicates that an error occurred before this VI ran, error out contains the same error information. Otherwise, it describes the error status that this VI produces.
ibool.gif status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
ii32.gif code the error or warning code. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.
istr.gif source describes the origin of the error or warning and is, in most cases, the name of the VI that produced the error or warning.