LibTiePie  0.7.1
Library for interfacing TiePie engineering instruments
Segment count

Description

Functions to control the segment count.

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

Functions

uint32_t ScpGetSegmentCountMax (LibTiePieHandle_t hDevice)
 Get the maximum supported number of segments of a specified oscilloscope. More...
 
uint32_t ScpGetSegmentCount (LibTiePieHandle_t hDevice)
 Get the currently selected number of segments of a specified oscilloscope. More...
 
uint32_t ScpSetSegmentCount (LibTiePieHandle_t hDevice, uint32_t dwSegmentCount)
 Set the number of segments of a specified oscilloscope. More...
 

Function Documentation

uint32_t ScpGetSegmentCountMax ( LibTiePieHandle_t  hDevice)

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

Parameters
[in]hDeviceA 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.
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
ScpGetSegmentCount
ScpSetSegmentCount
Since
0.4.3
uint32_t ScpGetSegmentCount ( LibTiePieHandle_t  hDevice)

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

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
The currently selected number of segments, or 0 when unsuccessful.
Status values
INVALID_VALUE The requested value is invalid.
NOT_SUPPORTED Segment count is not supported by the hardware.
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
ScpGetSegmentCountMax
ScpSetSegmentCount
Since
0.4.3
uint32_t ScpSetSegmentCount ( LibTiePieHandle_t  hDevice,
uint32_t  dwSegmentCount 
)

Set the number of segments of a specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]dwSegmentCountThe required number of segments.
Returns
The actually set number of segments, or 0 when unsuccessful.
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 invalid.
NOT_SUPPORTED Segment count is not supported by the hardware.
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
ScpGetSegmentCountMax
ScpGetSegmentCount
Since
0.4.3