Enabled

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 (LibTiePieHandle_t hDevice, uint16_t wCh)
	Check whether a specified channel is currently enabled. More...
bool8_t	ScpChSetEnabled (LibTiePieHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
	Set channel enable. More...

Function Documentation

bool8_t ScpChGetEnabled	(	LibTiePieHandle_t	hDevice,
		uint16_t	wCh
	)

Check whether a specified channel is currently enabled.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	wCh	The 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 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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also

ScpChSetEnabled

Since

0.4.0

bool8_t ScpChSetEnabled	(	LibTiePieHandle_t	hDevice,
		uint16_t	wCh,
		bool8_t	bEnable
	)

Set channel enable.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	wCh	The channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]	bEnable	BOOL8_TRUE or BOOL8_FALSE.

Returns

BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.

Status values

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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Remarks

Changing the channel enable may affect the sample frequency, record length and/or channel trigger enabled.

See also

ScpChGetEnabled

Since

0.4.0