RtndGetDispatcherPcpEntry

RtndGetDispatcherPcpEntry gets an entry in the PCP Hardware Dispatcher table.

Syntax

BOOL RtndGetDispatcherPcpEntry(
  [in]    ULONG_PTR RtndInterfaceId,
  [in]    ULONG EntryIndex,
  [out]   RTND_DISPATCHER_PCP_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 PCP entry to read.

[out] pEntry

The address of the structure describing the retrieved 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:

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 calling this function.

In this function, the driver is expected to read its local copy of the PCP Hardware Dispatcher table. It must NOT access a hardware register. This is important because the NL2 doesn’t keep a copy of the table. Instead, it makes frequent calls to this function.

Characteristics

Requirements

See Also:

• RTND_DISPATCHER_PCP_ENTRY
• RtndManageInterface
• RtndSetDispatcherPcpEntry