niHSDIO_AdjustSampleClockRelativeDelay

NI Digital Waveform Generator/Analyzer

niHSDIO_AdjustSampleClockRelativeDelay

Specific Function

C Function Prototype

ViStatus niHSDIO_AdjustSampleClockRelativeDelay (ViSession vi, ViReal64 adjustmentTime);

Purpose

Delays the Sample clock relative to the Reference clock. Use this function to align the Sample clock of your device to the Sample clock of another device in your system.

Only call this function after your session is committed. The effect of this function is immediate.

This function generates an error if NIHSDIO_ATTR_REF_CLOCK_SOURCE is set to NIHSDIO_VAL_NONE_STR.

This function can only align the device Sample clock to another Sample clock if the other device is using the same Reference clock source.

Parameters

Name Type Description
vi ViSession This handle identifies your instrument session. vi was obtained from the function used to initialize the session.
adjustmentTime ViReal64 Specifies the time in seconds to delay the Sample clock. Values range between 0 and the Sample clock period (1/NIHSDIO_ATTR_SAMPLE_CLOCK_RATE).

Return Value