Rtnl2CloseInterface closes a handle to an interface object.
Syntax
BOOL Rtnl2CloseInterface(
[in] RTNL2_HINTERFACE Interface
);Parameters
[in] Interface
A handle to the interface to close.
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 |
The supplied interface handle is invalid. |
|
RTNL2_ERROR_LINK_STATUS_CHANGE_EVENT_EXISTS |
A Link Status Change event associated with the interface handle exists. |
|
RTNL2_ERROR_SERIALIZED_COMMAND_TIMEOUT |
The NL2 process didn’t reply within an acceptable delay. |
|
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
After a successful call to this function, the supplied interface handle is no longer valid and can't be used as a parameter of other API functions.
This function will fail if there exists a Link Status Change event associated with the interface handle. Please call Rtnl2DestroyLinkStatusChangeEvent before closing the interface handle.
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:
