RtNalGetTransmitTimeStamp

RtNalGetTransmitTimeStamp returns the timestamp for the last transmit packet.

Syntax

BOOL RtNalGetTransmitTimeStamp(
	RTNAL_QUEUE_HANDLE queueHandle,
	PRTNAL_HW_TIME pHardwareTimeStamp
);

Parameters

queueHandle

The transmit queue handle returned by RtNalAcquireQueue.

pHardwareTimeStamp

An output pointer to RTNAL_HW_TIME structure filled in by the NAL with hardware timestamp values. This parameter cannot be NULL.

Return Value

Returns TRUE if the function succeeds. Otherwise it returns FALSE. Call GetLastError to obtain an error code. The possible error codes are listed below:

Error Code	Meaning
ERROR_DEVICE_FEATURE_NOT_SUPPORTED	The NIC driver does not support transmit timestamps.
ERROR_INVALID_DATA	The driver does not contain valid time stamps.
ERROR_INVALID_HANDLE	The argument queueHandle is invalid.
ERROR_INVALID_PARAMETER	queueHandle or pHardwareTimeStamps is a NULL pointer
ERROR_NOT_READY	RtNalInit has not completed successfully.

Remarks

For a list of supported functions for specific drivers, see Matrix of Supported Real-Time NAL Functions by NIC Driver.

To get a result the caller must first enable time-stamping and set the PTP message type from RTNAL_PTP_MESSAGE_TYPES by calling RtNalSetTransmitTimeStampType. The result is read from the timestamp registers on the NIC. Once it's read, the value is no longer accessible as the registers are automatically cleared.

The RtNalE1000 and RtNalIPCH drivers don’t support transmit timestamps.

Requirements

Minimum Supported Version	RTX64 4.0
Header	rtnapi.h, RtNalApi.h
Library	RtNal.lib