LibTiePie  0.9.0
Library for interfacing TiePie engineering instruments

Description

Functions to control the input bandwidth of an oscilloscope channel.

By default the input bandwidth of a channel is set to the highest value available.

Functions

uint32_t ScpChGetBandwidths (LibTiePieHandle_t hDevice, uint16_t wCh, double *pList, uint32_t dwLength)
 Get the supported input bandwidths for a specified channel. More...
 
double ScpChGetBandwidth (LibTiePieHandle_t hDevice, uint16_t wCh)
 Get the current channel input bandwidth. More...
 
double ScpChSetBandwidth (LibTiePieHandle_t hDevice, uint16_t wCh, double dBandwidth)
 Set the channel input bandwidth. More...
 

Function Documentation

uint32_t ScpChGetBandwidths ( LibTiePieHandle_t  hDevice,
uint16_t  wCh,
double *  pList,
uint32_t  dwLength 
)

Get the supported input bandwidths for a specified channel.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[out]pListA pointer to an array for the input bandwidths.
[in]dwLengthThe number of elements in the array.
Returns
The total number of bandwidths.
Status values
UNSUCCESSFUL An error occurred during execution of the last called function.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChGetBandwidth
ScpChSetBandwidth
Since
0.6
double ScpChGetBandwidth ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Get the current channel input bandwidth.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
The current channel input bandwidth in Hz.
Status values
NOT_SUPPORTED The channel does not support reading the input bandwidth.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChGetBandwidths
ScpChSetBandwidth
Since
0.6
double ScpChSetBandwidth ( LibTiePieHandle_t  hDevice,
uint16_t  wCh,
double  dBandwidth 
)

Set the channel input bandwidth.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]dBandwidthThe requested input bandwidth in Hz.
Returns
The actually set channel input bandwidth in Hz.
Status values
NOT_SUPPORTED The channel does not support changing the input bandwidth.
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChGetBandwidths
ScpChGetBandwidth
Since
0.6