IviPwrMeter_ConfigureChannelEnabled

CVI/LabWindows IVI Class Driver

IviPwrMeter_ConfigureChannelEnabled

IviPwrMeterChannelAcquisition Capability Group

C Function Prototype

ViStatus IviPwrMeter_ConfigureChannelEnabled (ViSession vi, ViConstString channelName, ViBoolean channelEnabled);

Purpose

This function enables or disables a specified channel for measurement.

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

channelEnabled ViBoolean Pass VI_TRUE to enable the channel. Pass VI_FALSE to disable the channel. The driver sets the IVIPWRMETER_ATTR_CHANNEL_ENABLED
attribute to this value.

Valid Values:
VI_TRUE - "On"
VI_FALSE - "Off"

Default Value:
VI_TRUE - "On"

Return Values