Description

Functions to control the segment count.

The segment count can be affected by changing the record length.

Functions
uint32_t	ScpGetSegmentCountMax (TpDeviceHandle_t hDevice)
	Get the maximum supported number of segments of a specified oscilloscope. More...

uint32_t	ScpGetSegmentCount (TpDeviceHandle_t hDevice)
	Get the currently selected number of segments of a specified oscilloscope. More...

uint32_t	ScpSetSegmentCount (TpDeviceHandle_t hDevice, uint32_t dwSegmentCount)
	Set the number of segments of a specified oscilloscope. More...

Function Documentation

uint32_t ScpGetSegmentCountMax ( TpDeviceHandle_t hDevice )

Get the maximum supported number of segments of a specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The maximum supported number of segments, or 0 when unsuccessful.

Status values

NOT_SUPPORTED	Segment count is not supported by the hardware.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

uint32_t ScpGetSegmentCount ( TpDeviceHandle_t hDevice )

Get the currently selected number of segments of a specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The currently selected number of segments, or 0 when unsuccessful.

Status values

INVALID_VALUE	The requested value is not valid.
NOT_SUPPORTED	Segment count is not supported by the hardware.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Set the number of segments of a specified oscilloscope.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	dwSegmentCount	The required number of segments.

Status values

VALUE_CLIPPED	The requested segment count is outside the valid range and clipped to the closest limit.
VALUE_MODIFIED	The requested segment count is within the valid range but not available. The closest valid value is set.
INVALID_VALUE	The requested value is not valid.
NOT_SUPPORTED	Segment count is not supported by the hardware.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.