RtecatGetDCSystemTime

RtecatGetDCSystemTime gets the timestamp of the selected Sync0's signal of the DC (distributed clock).

Syntax

Copy

RTECAT_ERROR RtecatGetDCSystemTime(
  [in]    RTECAT_HANDLE MainDevice,
  [in]    RTECAT_DC_CYCLE Cycle,
  [out]   DWORD64* pTime
);

Parameters

[in] MainDevice

A handle to a MainDevice. To retrieve the corresponding handle, use RtecatOpenMainDevice.

[in] Cycle

The DC system time to acquire. See RTECAT_DC_CYCLE.

[out] pTime

A pointer to a variable that stores the DC system time.

Return Values

The function returns an RTECAT_ERROR value. If the function succeeds, it returns ecatErrNoError. If the function fails, it returns a different value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter pTime is NULL.
ecatErrWrongParameter	Parameter MainDevice or Cycle is invalid.
ecatErrMainDeviceNotReady	The MainDevice instance does not exist.
ecatErrWrongEnvironment	The MainDevice has not started.

Remarks

RtecatGetDCSystemTime is a synchronous function that executes immediately and returns a result upon completion.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtecatApi.h	RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS)