Rtnl2GetLinkStatus
Rtnl2GetLinkStatus gets the current link status of an interface.
Syntax
BOOL Rtnl2GetLinkStatus(
[in] RTNL2_HINTERFACE Interface,
[out] RTNL2_LINK_STATUS *pLinkStatus,
[in] ULONG LinkStatusStructSize
);
Parameters
[in] Interface
A handle to the interface.
[out] pLinkStatus
A link status structure allocated by the caller and populated by this function.
[in] LinkStatusStructSize
The size of the RTNL2_LINK_STATUS structure.
Return Value
If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.
Possible error codes:
| Error code | Meaning |
|---|---|
|
ERROR_NOT_READY |
The calling process has not called Rtnl2Init. |
|
ERROR_INVALID_PARAMETER |
One of the following conditions occurred:
|
|
RTNL2_ERROR_NO_MORE_COMMUNICATION |
Unable to communicate with the NL2 process. This might be because the NL2 process is not running anymore, or because an application process thread was terminated during a previous call to an NL2 API function. |
Remarks
The caller MUST set LinkStatusStructSize to sizeof(RTNL2_LINK_STATUS) to ensure backward and forward compatibility.
Characteristics
| Real-time | ||
|
Deterministic |
No |
|
| Local memory usage | ||
|
Process |
External MSpace usage |
Internal MSpace usage |
|
System |
No |
No |
|
NL2 process |
No |
No |
|
Calling process |
No |
No |
| Contiguous memory usage | ||
|
Usage |
No |
|
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
eRTOS 1.0 SDK |
Rtnl2Api.h |
Rtnl2Api.lib |
See Also: