RtndSetInterface
RtndSetInterface writes a given setting to the interface.
Syntax
BOOL RtndSetInterface(
[in] ULONG_PTR RtndInterfaceId,
[in] ULONG QueueIndex,
[in] RTND_SETTING_ID SettingId,
[in] const VOID *pSettingData,
[in] ULONG SettingStructSize
);
Parameters
[in] RtndInterfaceId
The number or pointer used to identify the interface. This value is returned by RtndManageInterface.
[in] QueueIndex
The target index of the Transmit or Receive queue. This parameter is ignored if the operation is at the interface level.
[in] SettingId
The identifier of the setting type.
[in] pSettingData
The address of the setting structure. The exact type depends on the setting type.
[in] SettingStructSize
The size of the structure pointed to by pSettingData.
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_NOT_SUPPORTED |
The supplied setting identified by SettingId is not supported by this driver. |
|
RTND_ERROR_BAD_REQUEST |
The supplied pSettingData structure contains fields that this driver doesn’t know how to interpret. |
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 setting structure at compilation time and zeros out the structure before populating it and calling this function.
Characteristics
| Real-time requirements | ||
|
Deterministic behavior |
Not required |
|
| Local memory allocation/deallocation restrictions | ||
|
Process |
External MSpace |
Internal MSpace |
|
System |
Allowed |
Allowed |
|
Process |
Allowed |
Allowed |
| Contiguous memory allocation/deallocation restrictions | ||
|
Contiguous memory |
Allowed |
|
Requirements
| Minimum supported version | Header |
|---|---|
|
eRTOS 1.0 SDK |
Rtnd.h |
See Also: