niDCPower_ConfigurePowerLineFrequency

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_ConfigurePowerLineFrequency(ViSession vi, ViReal64 powerLineFrequency);

Purpose

Specifies the power line frequency for specified channel(s). NI-DCPower uses this value to select a timebase for setting the niDCPower_ConfigureApertureTime function in power line cycles (PLCs).

Note Note  This function is not supported on all devices. Refer to Supported Functions by Device for more information about supported devices.

Refer to the Measurement Configuration and Timing topic for your device in the NI DC Power Supplies and SMUs Help for more information about how to configure your measurements.

Related Topics:

Measurement Noise Rejection

Parameters

Input
Name Type Description
vi ViSession Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithChannels function.
powerLineFrequency ViReal64 Specifies the power line frequency in hertz for specified channel(s). NI-DCPower uses this value to select a timebase for the NIDCPOWER_ATTR_APERTURE_TIME attribute. Refer to the Measurement Configuration and Timing topic for your device for more information about how to configure your measurements.

Note Note  Set this parameter to the frequency of the AC power line.
Defined Values:
NIDCPOWER_VAL_50_HERTZ (50.0) Specifies 50 Hz.
NIDCPOWER_VAL_60_HERTZ (60.0)Specifies 60 Hz.

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