RtndExtractLastTxTimestamp

RtndExtractLastTxTimestamp determines whether the Egress Timestamp register associated with a given Transmit Queue is valid and, if it is, returns the Egress Timestamp value.

Syntax

Copy

BOOL RtndExtractLastTxTimestamp(
  [in]            ULONG_PTR RtndInterfaceId,
  [in]            ULONG TxQueueIndex,
  [out]           RTND_TIMESTAMP *pTimestamp
);

Parameters

[in] RtndInterfaceId

The number or pointer used to identify the interface. This value is returned by RtndManageInterface.

[in] TxQueueIndex

The index of the Transmit Queue with which the Egress Timestamp is associated.

[out] pTimestamp

The Egress Timestamp value.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.

Common error codes:

Error code	Meaning
ERROR_IO_DEVICE	An unexpected error occurred while trying to access the device.
ERROR_INVALID_DATA	A new Egress Timestamp value is not available for the specified Transmit Queue.

Note: Custom drivers may return other error codes not listed above.

Remarks

This function must be called from the main thread of the NL2 process.

Characteristics

Real-time requirements
Deterministic behavior	Not required
Shutdown-safe behavior	Required
Local memory allocation/deallocation restrictions
Process	External MSpace	Internal MSpace
System	Not allowed	Not allowed
RTSS process	Not allowed	Not allowed
Windows contiguous memory allocation/deallocation restrictions
Contiguous memory	Not allowed

Requirements

Minimum supported version	Header
wRTOS 1.0 SDK	Rtnd.h