Description

Functions to control the auto resolution mode.

The resolution can be set manually, but can also be set automatically, based on the selected sample frequency. Use ScpGetAutoResolutionModes() to determine the available auto resolution modes. Possible auto resolution modes are:

AR_DISABLED : Resolution does not automatically change.
AR_NATIVEONLY : Highest possible native resolution for the current sample frequency is used.
AR_ALL : Highest possible native or enhanced resolution for the current sample frequency is used.

When auto resolution mode is set to AR_DISABLED, the selected resolution will determine the maximum available sample frequency of the oscilloscope. When auto resolution mode is enabled, the selected sample frequency will determine the resolution of the oscilloscope.

Changing thesample frequency may change the resolution if auto resolution mode is AR_NATIVEONLY or AR_ALL.

Manually setting a resolution will set auto resolution mode to AR_DISABLED.

By default the auto resolution mode is set to AR_DISABLED for the Handyprobe HP3 and to AR_NATIVEONLY for all other supported instruments.

Functions
uint32_t	ScpGetAutoResolutionModes (TpDeviceHandle_t hDevice)
	Get the supported auto resolution modes of the specified oscilloscope. More...

uint32_t	ScpGetAutoResolutionMode (TpDeviceHandle_t hDevice)
	Get the current auto resolution mode of the specified oscilloscope. More...

uint32_t	ScpSetAutoResolutionMode (TpDeviceHandle_t hDevice, uint32_t dwAutoResolutionMode)
	Set the auto resolution mode of the specified oscilloscope. More...

Function Documentation

uint32_t ScpGetAutoResolutionModes ( TpDeviceHandle_t hDevice )

Get the supported auto resolution modes of the specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The supported auto resolution modes, a set of OR-ed AR_* values, ARM_NONE when unsuccessful.

Status values

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.

See also: ScpGetAutoResolutionMode; ScpSetAutoResolutionMode

Since: 0.4.3

uint32_t ScpGetAutoResolutionMode ( TpDeviceHandle_t hDevice )

Get the current auto resolution mode of the specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The currently selected auto resolution mode, a AR_* value, AR_UNKNOWN when unsuccessful.

Status values

NOT_SUPPORTED	Auto resolution 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.

See also: ScpGetAutoResolutionModes; ScpSetAutoResolutionMode

Since: 0.4.3

uint32_t ScpSetAutoResolutionMode	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwAutoResolutionMode
	)

Set the auto resolution mode of the specified oscilloscope.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	dwAutoResolutionMode	The required auto resolution mode, a AR_* value.

Returns: The actually set auto resolution mode, a AR_* value, AR_UNKNOWN when unsuccessful.

Status values

INVALID_VALUE	The requested value is not valid.
NOT_SUPPORTED	Auto resolution 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.

See also: ScpGetAutoResolutionModes; ScpGetAutoResolutionMode

Since: 0.4.3