RtndQueryLinkStatus

RtndQueryLinkStatus gets the Link Status of an interface.

Syntax

Copy

BOOL RtndQueryLinkStatus(
  [in]    ULONG_PTR RtndInterfaceId,
  [in]    RTND_LINK_STATUS *pLinkStatus,
  [in]    ULONG LinkStatusStructSize
);

Parameters

[in] RtndInterfaceId

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

[in] pLinkStatus

The address of the Link Status structure.

[in] LinkStatusStructSize

The size of the structure pointed to by pLinkStatus.

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.

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

Remarks

The NL2 always calls this function from the main thread of the NL2 process.

To ensure backward and forward compatibility, the NL2 always uses sizeof to get the size of its link status structure at compilation time and zeros out the structure before calling this function.

Characteristics

Real-time requirements
Deterministic behavior	Not required
Local memory allocation/deallocation restrictions
Process	External MSpace	Internal MSpace
System	Not allowed	Not allowed
Process	Not allowed	Not allowed
Contiguous memory allocation/deallocation restrictions
Contiguous memory	Not allowed

Requirements

Minimum supported version	Header
eRTOS 1.0 SDK	Rtnd.h