INtime SDK Help
hpe1588GetRxTimestampHeaderSize
INtime SDK v6 > About INtime > Networking and I/O > High-Performance Ethernet > hpe1588GetRxTimestampHeaderSize

Retrieve the size of the timestamp header. This function is useful to determine how much extra space must be allocated for time-stamped RX packets and to determine where the actual payload is located relative to the packet buffer start. This value may not be the size of an HPE_1588_TIMESTAMP structure.

HPESTATUS hpe1588GetRxTimestampHeaderSize(
    HPEHANDLE devhandle, 
    DWORD *size
);

Parameters

devhandle
A handle value for the device.
size
A pointer to a DWORD value to receive the size of the header.

Return Values

A status value indicating the success or failure of the operation:

E_OK The operation completed successfully.
E_EXIST The handle given is not a handle for an open HPE interface.
E_TIME Timed out waiting for the timestamp to become valid.
E_SUPPORT IEEE1588 functionality is not supported by the hardware interface.

Requirements

Versions Defined in Include Link to
INtime 6.0 (HPE3) intime/rt/include/hpeif2.h hpeif2.h hpeif2.lib
See Also