niDCPower Initialize With Options VI

NI DC Power Supplies and SMUs Help (NI-DCPower)

Edition Date: January 2018

Part Number: 370736U-01

View Product Info

DOWNLOAD (Windows Only)


NI-DCPower (English | Japanese)
Installed With: NI-DCPower

This VI is deprecated, use niDCPower Initialize With Channels instead.

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. Then configure the device as in the previous session changing only the desired settings, and then call the niDCPower Initiate VI. See the Deprecated Programming States topic for information about the specific software states.

niDCPower Initialize With Options

/images/reference/en-XX/help/370736U-01/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.

/images/reference/en-XX/help/370736U-01/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.

/images/reference/en-XX/help/370736U-01/cbool.gif

reset device specifies whether to reset the power supply during the initialization procedure. The default is TRUE.

/images/reference/en-XX/help/370736U-01/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. For example:

Simulate=0, DriverSetup=Model:<model number>; BoardType:<type>

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 in the NI DC Power Supplies and SMUs Help.

/images/reference/en-XX/help/370736U-01/cerrcodeclst.gif

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

/images/reference/en-XX/help/370736U-01/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.

/images/reference/en-XX/help/370736U-01/ci32.gif

code is the error or warning code. The default is 0. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.

/images/reference/en-XX/help/370736U-01/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.

/images/reference/en-XX/help/370736U-01/iio.gif

instrument handle out passes the handle used to identify the session in all subsequent NI-DCPower VI calls.

/images/reference/en-XX/help/370736U-01/ierrcodeclst.gif

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

/images/reference/en-XX/help/370736U-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370736U-01/ii32.gif

code is 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.

/images/reference/en-XX/help/370736U-01/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.

WAS THIS ARTICLE HELPFUL?

Not Helpful