Gx3722HighBandwidthSetFrequency

Purpose

Sets the frequency of the specified High Bandwidth stimulus channel.

Syntax

Gx3722HighBandwidthSetFrequency (nHandle, nChannel, nFrequency, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX3722 board.
nChannel
SHORT
Select the stimulus channel to use:
1.      GX3722_HBW_STIM_CH1: High Bandwidth output channel 1.
2.      GX3722_HBW_STIM_CH2: High Bandwidth output channel 2.
3.      GX3722_HBW_STIM_CH3: High Bandwidth output channel 3.
4.    GX3722_HBW_STIM_CH4: High Bandwidth output channel 4.  
nFrequency
SHORT
Sets the frequency of the selected channel:
0.      GX3722_HBW_STIM_FREQ_OFF: Channel does not output.
1.      GX3722_HBW_STIM_FREQ_125KHZ: Frequency is 125 KHz.
2.      GX3722_HBW_STIM_FREQ_250KHZ: Frequency is 250 KHz.
3.      GX3722_HBW_STIM_FREQ_500KHZ: Frequency is 500 KHz.
4.      GX3722_HBW_STIM_FREQ_1MHZ: Frequency is 1 MHz.
5.      GX3722_HBW_STIM_FREQ_2MHZ: Frequency is 2 MHz.
6.      GX3722_HBW_STIM_FREQ_4MHZ: Frequency is 4 MHz.
7.    GX3722_HBW_STIM_FREQ_8MHZ: Frequency is 8 MHz.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

When programmed by a call to Gx3722HighBandwidthSetFrequency() API, the specified channel will output a square wave (pulse train, duty cycle: 50%).  Setting the channel to GX3722_HBW_STIM_FREQ_OFF will tri-state it.

Example

The following example sets the frequency of High Bandwidth output channel 4 to 2 MHz:

 

Gx3722HighBandwidthSetFrequency (nHandle, GX3722_HBW_STIM_CH4, GX3722_HBW_STIM_FREQ_2MHZ, &nStatus);

 

See Also

Gx3722HighBandwidthGetFrequency, GxFpgaGetErrorString