Description

Functions to control the clock source of the oscilloscope.

Oscilloscopes can support multiple clock sources, use ScpGetClockSources() to determine the available clock sources for an oscilloscope.

When an oscilloscope supports selecting an external clock source, refer to the instrument manual for the location of the external clock input and the specifications of the required external clock signal.

By default the clock source is set to: Internal (CS_INTERNAL).

Functions
uint32_t	ScpGetClockSources (TpDeviceHandle_t hDevice)
	Get the supported clock sources of the specified oscilloscope. More...

uint32_t	ScpGetClockSource (TpDeviceHandle_t hDevice)
	Get the currently selected clock source of the specified oscilloscope. More...

uint32_t	ScpSetClockSource (TpDeviceHandle_t hDevice, uint32_t dwClockSource)
	Set the clock source of the specified oscilloscope. More...

Function Documentation

uint32_t ScpGetClockSources ( TpDeviceHandle_t hDevice )

Get the supported clock sources of the specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The supported clock sources, a set of OR-ed CS_* values, or 0 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: ScpGetClockSource; ScpSetClockSource

Since: 0.4.0

uint32_t ScpGetClockSource ( TpDeviceHandle_t hDevice )

Get the currently selected clock source of the specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The current clock source, a CS_* value, or 0 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: ScpGetClockSources; ScpSetClockSource

Since: 0.4.0

uint32_t ScpSetClockSource	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwClockSource
	)

Set the clock source of the specified oscilloscope.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	dwClockSource	The requested clock source, a CS_* value.

Returns: The actually set clock source, a CS_* value, or 0 when unsuccessful.

Status values

INVALID_VALUE	The requested value is not valid.
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: ScpGetClockSources; ScpGetClockSource

Since: 0.4.0