Description

Functions to control the clock output type.

Oscilloscopes can support supplying a clock output signal, use ScpGetClockOutputs() to determine the available clock outputs for an oscilloscope.

When an oscilloscope supports selecting a clock output signal, refer to the instrument manual for the location of the clock output and the specifications of the clock output signal.

By default the clock output is disabled (CO_DISABLED).

Functions
uint32_t	ScpGetClockOutputs (TpDeviceHandle_t hDevice)
	Get the supported clock outputs of the specified oscilloscope. More...

uint32_t	ScpGetClockOutput (TpDeviceHandle_t hDevice)
	Get the currently selected clock output of the specified oscilloscope. More...

uint32_t	ScpSetClockOutput (TpDeviceHandle_t hDevice, uint32_t dwClockOutput)
	Set the clock output of the specified oscilloscope. More...

Function Documentation

uint32_t ScpGetClockOutputs ( TpDeviceHandle_t hDevice )

Get the supported clock outputs of the specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The supported clock outputs, a set of OR-ed CO_* 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: ScpGetClockOutput; ScpSetClockOutput

Since: 0.4.0

uint32_t ScpGetClockOutput ( TpDeviceHandle_t hDevice )

Get the currently selected clock output of the specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The current clock output, a CO_* 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: ScpGetClockOutputs; ScpSetClockOutput

Since: 0.4.0

uint32_t ScpSetClockOutput	(	TpDeviceHandle_t	hDevice,
		uint32_t	dwClockOutput
	)

Set the clock output of the specified oscilloscope.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	dwClockOutput	The requested clock output, a CO_* value.

Returns: The actually set clock output, a CO_* 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: ScpGetClockOutputs; ScpGetClockOutput

Since: 0.4.0