LibTiePie  0.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages

Description

Functions to control the enabled state of an oscilloscope channel.

The enabled state of a channel determines whether the channel is measured.

By default all channels are enabled (BOOL8_TRUE).

Functions

bool8_t ScpChGetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether a specified channel is currently enabled. More...
 
bool8_t ScpChSetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
 Set channel enable. More...
 

Function Documentation

bool8_t ScpChGetEnabled ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether a specified channel is currently enabled.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
Status values
INVALID_CHANNEL The requested channel number is not valid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChSetEnabled
Since
0.4.0
bool8_t ScpChSetEnabled ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
bool8_t  bEnable 
)

Set channel enable.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]bEnableBOOL8_TRUE or BOOL8_FALSE.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
Status values
INVALID_CHANNEL The requested channel number is not valid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Remarks
Changing the channel enable may affect the sample frequency and/or record length.
See also
ScpChGetEnabled
Since
0.4.0