RtndSetDispatcherUdpPortEntry
RtndSetDispatcherUdpPortEntry updates an entry in the UDP Port Hardware Dispatcher.
Syntax
BOOL RtndSetDispatcherUdpPortEntry(
[in] ULONG_PTR RtndInterfaceId,
[in] ULONG EntryIndex,
[in] const RTND_DISPATCHER_UDP_PORT_ENTRY *pEntry,
[in] ULONG EntryStructSize
);
Parameters
[in] RtndInterfaceId
The number or pointer used to identify the interface. This value is returned by RtndManageInterface.
[in] EntryIndex
The index of the UDP Port entry to update.
[in] pEntry
The address of the structure describing the new content.
[in] EntryStructSize
The size of the structure pointed to by pEntry.
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. |
|
RTND_ERROR_BAD_REQUEST |
The supplied pEntry 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 entry structure at compilation time and zeros out the structure before populating it and calling this function.
In this function, the driver is expected to write the provided data to the hardware and update a local copy so that subsequent calls to RtndGetDispatcherUdpPortEntry will not have to read a hardware register.
Characteristics
| Real-time requirements | ||
|
Deterministic behavior |
Not required |
|
|
Shutdown-safe behavior |
Required |
|
| Local memory allocation/deallocation restrictions | ||
|
Process |
External MSpace |
Internal MSpace |
|
System |
Not allowed |
Not allowed |
|
RTSS process |
Not allowed |
Not allowed |
| Windows contiguous memory allocation/deallocation restrictions | ||
|
Contiguous memory |
Not allowed |
|
Requirements
| Minimum supported version | Header |
|---|---|
|
wRTOS 1.0 SDK |
Rtnd.h |
See Also: