Rtnl2EnumInterface returns the name of an interface specified by its index.
Syntax
BOOL Rtnl2EnumInterface(
[in] ULONG Index,
[out] CHAR *Name,
[in] ULONG NameBufferSize
);Parameters
[in] Index
The index of the interface.
[out] Name
The name of the interface.
[in] NameBufferSize
The length, in bytes, of the name buffer.
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_NO_MORE_ITEMS |
Index is equal to the number of the started interfaces. |
|
ERROR_INVALID_PARAMETER |
One of the following conditions occurred:
|
|
ERROR_BUFFER_OVERFLOW |
The supplied buffer is too small to contain the full name of the interface. |
|
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 index of an interface has no specific meaning; it simply serves for iterating through all the started interfaces and retrieving their names within this function.
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 |
