niDCPower_ConfigureOutputFunction
ViStatus niDCPower_ConfigureOutputFunction (ViSession vi, ViConstString channelName, ViBoolean 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
Parameters
| Input | ||||||
| Name | Type | Description | ||||
| vi | ViSession | Identifies a particular instrument session. vi is obtained from the niDCPower_init or niDCPower_InitWithOptions function. | ||||
| channelName | ViConstString | Specifies to which output channel(s) to apply this configuration value. You can specify multiple channels by using a channel list or a channel range. A channel list is a comma (,) separated sequence of channel names (e.g. 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 (e.g. 0-2 specifies channels 0, 1, and 2). In Immediate mode, 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:
Default Value: NIDCPOWER_VAL_DC_VOLTAGE | ||||
Return Value
| Name | Type | Description |
| Status | ViStatus | Reports 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. |