IviDCPwr_ConfigureCurrentLimit
IviDCPwrBase Capability Group
C Function Prototype
ViStatus IviDCPwr_ConfigureCurrentLimit (ViSession vi, ViConstString channelName, ViInt32 behavior, ViReal64 limit);
Purpose
This function configures the current limit. It specifies the output current limit value and the behavior of the power supply when the output current is greater than or equal to that value.
Parameters
| Name | Type | Description | ||
|---|---|---|---|---|
| vi | ViSession | The instrument handle that you obtain from the IviDCPwr_init or IviDCPwr_InitWithOptions functions. The handle identifies a particular IVI session. | ||
| channelName | ViConstString | Pass the virtual channel name that you assign to the instrument through MAX.
Virtual channel names are aliases for instrument specific channel strings. The instrument specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument specific channel through MAX. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument specific channel names.
|
||
| behavior | ViInt32 | Pass the behavior you want the power supply to exhibit when the output current is greater than or equal to the value of the limit parameter. The driver sets the IVIDCPWR_ATTR_CURRENT_LIMIT_BEHAVIOR attribute to this value.
Defined Values: IVIDCPWR_ATTR_CURRENT_LIMIT—The power supply disables the output when the output current reaches or exceeds the value of the limit parameter. IVIDCPWR_VAL_CURRENT_REGULATE—The power supply regulates the output current at the value of the limit parameter when the output reaches or exceeds that value. |
||
| limit | ViReal64 | Pass the output current limit you want the power supply to use. The driver sets the IVIDCPWR_ATTR_CURRENT_LIMIT attribute to this value. |
