niDCPower_ConfigureLCRCustomCableCompensation
- Updated2025-10-06
- 1 minute(s) read
This function is deprecated, use niDCPower_ConfigureLCRCompensation instead.
Syntax
ViStatus _VI_FUNC niDCPower_ConfigureLCRCustomCableCompensation(ViSession vi, ViConstString channelName, ViInt32 customCableCompensationDataSize, ViAddr customCableCompensationData)
Remarks
Applies previously generated open and short custom cable compensation data to LCR measurements.
This function applies custom cable compensation data when you have set NIDCPOWER_ATTR_CABLE_LENGTH to NIDCPOWER_VAL_CUSTOM_AS_CONFIGURED.
Call this function after you have obtained custom cable compensation data. If NIDCPOWER_ATTR_LCR_SHORT_CUSTOM_CABLE_COMPENSATION_ENABLED is set to true, you must generate data with both niDCPower_PerformLCROpenCustomCableCompensation and niDCPower_PerformLCRShortCustomCableCompensation; if false, you must only use niDCPower_PerformLCROpenCustomCableCompensation, and NI-DCPower uses default short data.
Call niDCPower_GetLCRCustomCableCompensationData and pass the custom cable compensation data to this function.
This function is not supported on all devices. Refer to Supported Functions by Device for more information about supported devices.
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| vi | [in] | ViSession | Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function. |
| channelName | [in] | ViConstString | Specifies the channel(s) to use. Specify the channel(s) using the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3 or PXI1Slot3/0,PXI1Slot3/2:3,PXI1Slot4/2:3, where PXI1Slot3 and PXI1Slot4 are instrument resource names and 0, 2, and 3 are channels. If you pass "" for this control, all channels in the session are used. |
| customCableCompensationDataSize | [in] | ViInt32 | Specifies the size, in bytes, of customCableCompensationData to apply. |
| customCableCompensationData | [in] | ViAddr | The open and short custom cable compensation data to apply. |
Returns
Reports the status of this operation. To obtain a text description of the status code, call niDCPower_error_message. To obtain additional information concerning the error condition, call niDCPower_GetError. The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |