niDCPower_ConfigureOutputFunction

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)

ViStatus niDCPower_ConfigureOutputFunction(ViSession vi, ViConstString channelName, ViInt32 function);

Purpose

Configures the function the device attempts to generate for the specified channel(s).

When NIDCPOWER_VAL_DC_VOLTAGE is selected, the device generates the desired voltage level on the output as long as the output current is below the current limit. The following functions can be used to configure the channel when NIDCPOWER_VAL_DC_VOLTAGE is selected:

  • niDCPower_ConfigureVoltageLevel
  • niDCPower_ConfigureCurrentLimit
  • niDCPower_ConfigureVoltageLevelRange
  • niDCPower_ConfigureCurrentLimitRange

When NIDCPOWER_VAL_DC_CURRENT is selected, the device generates the desired current level on the output as long as the output voltage is below the voltage limit. The following functions can be used to configure the channel when NIDCPOWER_VAL_DC_CURRENT is selected:

  • niDCPower_ConfigureCurrentLevel
  • niDCPower_ConfigureVoltageLimit
  • niDCPower_ConfigureCurrentLevelRange
  • niDCPower_ConfigureVoltageLimitRange

When NIDCPOWER_VAL_PULSE_VOLTAGE is selected, the device generates pulses at the desired voltage levels on the output as long as the output current is below the current limit. The following VIs can be used to configure the channel when NIDCPOWER_VAL_PULSE_VOLTAGE is selected:

  • niDCPower_ConfigurePulseVoltageLevel
  • niDCPower_ConfigurePulseBiasVoltageLevel
  • niDCPower_ConfigurePulseCurrentLimit
  • niDCPower_ConfigurePulseBiasCurrentLimit
  • niDCPower_ConfigurePulseVoltageLevelRange
  • niDCPower_ConfigurePulseCurrentLimitRange

When NIDCPOWER_VAL_PULSE_CURRENT is selected, the device generates pulses at the desired current levels on the output as long as the output voltage is below the voltage limit. The following VIs can be used to configure the channel when NIDCPOWER_VAL_PULSE_CURRENT is selected:

  • niDCPower_ConfigurePulseCurrentLevel
  • niDCPower_ConfigurePulseBiasCurrentLevel
  • niDCPower_ConfigurePulseVoltageLimit
  • niDCPower_ConfigurePulseBiasVoltageLimit
  • niDCPower_ConfigurePulseCurrentLevelRange
  • niDCPower_ConfigurePulseVoltageLimitRange

Related Topics:

Constant Voltage Mode

Constant Current Mode

Parameters

Input
Name Type Description
vi ViSession Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithChannels function.
channelName ViConstString Specifies the output channel(s) to which this configuration value applies. Specify multiple channels by using a channel list or a channel range. A channel list is a comma (,) separated sequence of channel names (for example, 0,2 specifies channels 0 and 2). A channel range is a lower bound channel followed by a hyphen (-) or colon (:) followed by an upper bound channel (for example, 0-2 specifies channels 0, 1, and 2). In the Running state, multiple output channel configurations are performed sequentially based on the order specified in this parameter.
function ViInt32 Configures the function to generate for the specified channel(s).

Defined Values:
NIDCPOWER_VAL_DC_VOLTAGE (1006)Sets the output function to DC voltage.
NIDCPOWER_VAL_DC_CURRENT (1007)Sets the output function to DC current.
NIDCPOWER_VAL_PULSE_VOLTAGE (1049)Sets the output function to pulse voltage.
NIDCPOWER_VAL_PULSE_CURRENT (1050)Sets the output function to pulse current.

Return Value

Name Type Description
StatusViStatusReports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

WAS THIS ARTICLE HELPFUL?

Not Helpful