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

Reports the current status of the media interface of the Ethernet controller.

Note: hpeGetMediaStatus is a slow function because it accesses PHY interface. This function should be used only at start up time when media status needs to be determined after hpeOpen is called.  To check the link status at runtime, use the return value of hpeAttachTransmitBufferSet function. hpeAttachTransmitBufferSet returns E_TRANSMISSION when link is down.
HPESTATUS hpeGetMediaStatus(
    HPEHANDLE devhandle, 
    HPEMEDIASTATUS  *media_status
);

Parameters

devhandle
A handle value for the device.
media_status
A pointer to a HPEMEDIASTATUS structure where the information is to be returned.

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_INVALID_ADDR The media_status parameter was not a valid pointer.

Requirements

Versions Defined in Include Link to
INtime 4.0 intime/rt/include/hpeif2.h hpeif2.h hpeif2.lib
See Also