niDMM Initialize With Options

NI Digital Multimeters Help (NI-DMM 18.1)

Edition Date: March 2018

Part Number: 370384V-01

»View Product Info
Download Help (Windows Only)

This VI completes the following tasks:

- Creates a new IVI instrument driver session and optionally sets the initial state of the following session properties: Range Check, Query Instrument Status, Cache, Simulate, and Record Value Coercions.

- Opens a session to the device you specify for the Instrument Descriptor parameter. If the ID Query parameter is set to TRUE (1), this function queries the instrument ID and checks that it is valid for this instrument driver.

- If the Reset Device parameter is set to TRUE (1), this VI resets the instrument to a known state.

- Sends initialization commands to set the instrument to the state necessary for the operation of the instrument driver.

- Returns a ViSession handle that you use to identify the instrument in all subsequent instrument driver function calls.

niDMM Initialize With Options

/images/reference/en-XX/help/370384V-01/cio.gif

Instrument Descriptor contains the resource name of the device to initialize.

The resource name is assigned in Measurement & Automation Explorer (MAX). Refer to Related Documentation for the NI Digital Multimeters Getting Started Guide for more information about configuring and testing the DMM in MAX. Valid Syntax:

  • NI-DAQmx name
  • DAQ::NI-DAQmx name[::INSTR]
  • DAQ::Traditional NI-DAQ device number[::INSTR]
  • IVI logical name
Caution  All IVI names for the Instrument Descriptor, such as logical names or virtual names, are case-sensitive. If you use logical names, driver session names, or virtual names in your program, you must make sure that the name you use matches the name in the IVI Configuration Store file exactly, without any variations in the case of the characters in the name.
/images/reference/en-XX/help/370384V-01/cbool.gif

ID Query verifies that the device you initialize is one that the driver supports. NI-DMM automatically performs this query, so setting this parameter is not necessary.

TRUE (default) 1 Perform ID Query
FALSE 0 Skip ID Query
/images/reference/en-XX/help/370384V-01/cbool.gif

Reset Device specifies whether to reset the instrument during the initialization procedure.

TRUE (default) 1 Reset device
FALSE 0 Do not reset device
/images/reference/en-XX/help/370384V-01/cstr.gif

Option String sets the initial value of certain properties for the session.

The following table lists the properties and the name you use in this parameter to identify the attribute:

RangeCheck TRUE 1
QueryInstrumentStatus FALSE 0
Cache TRUE 1
Simulate FALSE 0
RecordValueCoercions FALSE 0
DriverSetup ""—empty string ""

The format of this string is "PropertyName=Value." To set multiple properties, separate their assignments with a comma.

If you pass NULL or an empty string for this parameter, the session uses the default values for the property. You can override the default values by assigning a value explicitly in an Option String parameter. You do not have to specify all of the properties and may leave any of them out. Properties that are left out use the default value.

Refer to Simulating NI Digital Multimeters for more information.

/images/reference/en-XX/help/370384V-01/cerrcodeclst.gif

error in describes error conditions that occur before this VI runs. If an error occurred before this VI runs, the VI passes the error in value to error out. This VI runs normally only if no error occurs before this VI runs. If an error occurs while this VI runs, it continues and sets its own error status in error out. Use niDMM Error Message to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

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

/images/reference/en-XX/help/370384V-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/370384V-01/iio.gif

instrument handle out returns a handle that you use to identify the instrument in all subsequent instrument driver VI calls.

/images/reference/en-XX/help/370384V-01/ierrcodeclst.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. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

/images/reference/en-XX/help/370384V-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/370384V-01/ii32.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.

/images/reference/en-XX/help/370384V-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. The default is an empty string.

WAS THIS ARTICLE HELPFUL?

Not Helpful