RtnGetDataLong

RtnGetDataLong retrieves the value placed at offset index of the network device pointed to by ndp.

Syntax

ULONG RtnGetDataLong(
    PVOID ndp,
    LONG offset
);

Parameters

ndp

Network Device Pointer. Opaque network device identifier (pointer).

offset

Offset of data to retrieve.

Return Value

Value placed in offset index of network device pointed to by ndp.

Remarks

RtnSetDataLong and RtnGetDataLong allow a driver writer to save driver specific data in the network device data structure.

The number of data elements is application-specific. The TCP/IP Stack uses 4 data elements.

RtnGetDataLong is used in RTND functions that are passed a network device pointer to identify the particular driver instance. Offset 0 is used to store the index to the local driver configuration structure initialized in RtndInitializeInterface and RtndConfigure. This allows a single driver to support multiple NICs simultaneously. Each instance of a driver (and NIC) will have its own network device data structure.

Offset 1 is used in RTND functions that are passed a network device pointer to identify the device queue number.

Offset 2 is used by the TCP/IP Stack.

Requirements

Minimum Supported Version

RTX64 2013

NOTE: RTX64 Network Abstraction Layer (NAL) support requires RTX64 4.0 or later

Header

rtnapi.h

Library

To use with the NAL: RTX64Nal.lib

To use with the TCP/IP Stack: RtTcpip.lib

See Also:

RtnSetDataLong

RtndInitializeInterface

RtndConfigure