Description

Functions to control the record length of the oscilloscope.

The record length defines the number of samples in a measurement. With a given sample frequency, the record length determines the duration of the measurement. Increasing the record length, will increase the total measuring time. The result is that more of the measured signal is visible.

The maximum supported record length depends on the used instrument and its configuration. Use ScpGetRecordLengthMax to determine the maximum supported record length of a oscilloscope.

The record length can be affected by changing the channel enable, resolution, measure mode and/or sample frequency.

By default the record length is set to: 5000 samples.

Functions
uint64_t	ScpGetRecordLengthMax (LibTiePieHandle_t hDevice)
	Get the maximum supported record length of a specified oscilloscope. More...

uint64_t	ScpGetRecordLength (LibTiePieHandle_t hDevice)
	Get the currently selected record length of a specified oscilloscope. More...

uint64_t	ScpSetRecordLength (LibTiePieHandle_t hDevice, uint64_t qwRecordLength)
	Set the record length of a specified oscilloscope. More...

Function Documentation

uint64_t ScpGetRecordLengthMax ( LibTiePieHandle_t hDevice )

Get the maximum supported record length of a specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The maximum supported record length, or 0 when unsuccessful.

Status values

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: ScpGetRecordLength; ScpSetRecordLength

Since: 0.4.0

uint64_t ScpGetRecordLength ( LibTiePieHandle_t hDevice )

Get the currently selected record length of a specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The currently selected record length in samples, or 0 when unsuccessful.

Status values

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: ScpGetRecordLengthMax; ScpSetRecordLength

Since: 0.4.0

uint64_t ScpSetRecordLength	(	LibTiePieHandle_t	hDevice,
		uint64_t	qwRecordLength
	)

Set the record length of a specified oscilloscope.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	qwRecordLength	The required record length in samples.

Returns: The actually set record length in samples, or 0 when unsuccessful.

Remarks: Changing the record length may affect the segment count.

Status values

VALUE_CLIPPED	The requested record length is outside the valid range and clipped to the closest limit.
VALUE_MODIFIED	The requested record length is within the valid range but not available. The closest valid value is set.
INVALID_VALUE	The requested value 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: ScpGetRecordLengthMax; ScpGetRecordLength

Since: 0.4.0