IviPwrMeter_ConfigureAveragingCount

CVI/LabWindows IVI Class Driver

IviPwrMeter_ConfigureAveragingCount

IviPwrMeterAveragingCount Capability Group

C Function Prototype

ViStatus IviPwrMeter_ConfigureAveragingCount (ViSession vi, ViConstString channelName, ViInt32 averagingCount);

Purpose

This function sets the average count that the instrument uses in manual averaging mode. The averaging count specifies the number of samples that the instrument takes before the measurement is complete.

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 configure.

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.

averagingCount ViInt32 Specifies the averaging count. The driver sets the IVIPWRMETER_ATTR_AVERAGING_COUNT attribute to this value.

Default Value: 5

Return Values