IviFgen_ConfigureAMEnabled

CVI/LabWindows IVI Class Driver

IviFgen_ConfigureAMEnabled

IviFgenModulateAM Capability Group

C Function Prototype

ViStatus IviFgen_ConfigureAMEnabled (ViSession vi, ViConstString channelName, ViBoolean enabled);

Purpose

Configures whether the function generator applies amplitude modulation to a channel.

Parameters

Name Type Description
vi ViSession The instrument handle that you obtain from the IviFgen_init or IviFgen_InitWithOptions functions. The handle identifies a particular IVI session.
channelName ViConstString Pass the virtual channel name that you assign to the instrument in MAX.

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

Note  You can specify the channel name as a string variable or as a literal enclosed in double quotes.
enabled ViBoolean Pass whether you want the function generator to apply amplitude modulation to the channel. The driver uses this value to set the IVIFGEN_ATTR_AM_ENABLED attribute.

Return Values