IviPwrMeter_ConfigureCorrectionFrequency

CVI/LabWindows IVI Class Driver

IviPwrMeter_ConfigureCorrectionFrequency

IviPwrMeterBase Capability Group

C Function Prototype

ViStatus IviPwrMeter_ConfigureCorrectionFrequency (ViSession vi, ViConstString channelName, ViReal64 frequency);

Purpose

This function specifies the frequency of the input signal in Hertz. The instrument uses this value to determine the appropriate correction factor for the sensor.

Parameters

Name Type Description
vi ViSession The ViSession handle that you obtain from the IviPwrMeter_init or IviPwrMeter_InitWithOptions function. The handle identifies a particular instrument session.

Default Value: None

channelName ViConstString The name of the channel to be configured.

Pass the virtual channel name that you assign to the instrument in the Configuration Utility.

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 the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.

Default Value: ""

Notes: You can specify the channel name as a string variable or as a literal enclosed in double quotes.

frequency ViReal64 Specifies the expected frequency of the input signal in Hertz. The instrument uses this parameter to determine the appropriate correction factor for the sensor. The driver sets the IVIPWRMETER_ATTR_CORRECTION_FREQUENCY attribute to this value.

Units: Hz

Default Value: 50 MHz

Return Values