NDIS Structures (Windows Embedded CE 6.0)

1/6/2010

The following table shows the NDIS structures with a description of the purpose of each.

Programming element Description

MediaSpecificInformation

This structure contains information about the characteristics of the network hardware bound to a protocol.

NDIS_802_11_BSSID_LIST

The NDIS_802_11_BSSID_LIST structure is used by OID_802_11_BSSID_LIST to request that a miniport driver return a list containing all basic service set identifiers (BSSIDs) and their attributes, as listed in the 802.11 NIC database.

NDIS_802_11_CONFIGURATION

OID_802_11_CONFIGURATION uses an NDIS_802_11_CONFIGURATION structure to describe the configuration of a radio.

NDIS_802_11_CONFIGURATION_FH

NDIS_802_11_CONFIGURATION_FH specifies the frequency-hopping configuration for an NDIS_802_11_CONFIGURATION structure.

NDIS_802_11_LSM_MODE

OID_802_11_LATENCY_SENSITIVE_MODE uses this structure to notify the NIC driver of the presence or absence of latency sensitive traffic.

NDIS_802_11_LSM_PARAMETERS

OID_802_11_LATENCY_SENSITIVE_MODE uses this structure to notify the NIC driver of the presence or absence of latency sensitive traffic.

NDIS_802_11_NETWORK_TYPE_LIST

OID_802_11_NETWORK_TYPES_SUPPORTED uses the NDIS_802_11_NETWORK_TYPE_LIST structure to request that the miniport driver return an array of all physical layer network subtypes that the 802.11 NIC and the driver support.

NDIS_802_11_RADIO_POWER_STATE

OID_802_11_RADIO_POWER_STATE uses this structure to store the Radio Power State, indicating whether the radio is on or off.

NDIS_802_11_SSID

OID_802_11_SSID uses this structure when it requests a miniport driver to set or return the NIC service set identifier (SSID) value.

NDIS_802_11_STATISTICS

This structure describes statistics for the 802_11 interface.

NDIS_802_11_WEP

This structure describes the key index used by a wired equivalent privacy (WEP) algorithm.

NDIS_CONFIGURATION_PARAMETER

This structure describes the configuration parameters for a NIC.

NDIS_ENCAPSULATION_FORMAT

The NDIS_ENCAPSULATION_FORMAT structure used for the EncapsulationFormat member of the NDIS_TASK_OFFLOAD_HEADER structure.

NDIS_MAC_FRAGMENT

NDIS_MAC_FRAGMENT contains information associated with a fragment indication made by a WAN NIC miniport.

NDIS_MAC_LINE_DOWN

This structure contains information associated with a line-down indication made by a wide area network (WAN) network interface card (NIC) miniport.

NDIS_MAC_LINE_UP

This structure contains information associated with a line-up indication made by a wide area network (WAN) network interface card (NIC) miniport.

NDIS_MINIPORT_CHARACTERISTICS

NdisIMRegisterLayeredMiniport uses this structure when it registers a driver's miniport entry points and name with the NDIS library.

NDIS_PACKET

This structure contains chained buffer descriptors for which pointers are passed to many NdisXXX, MiniportXXX, and ProtocolXXX functions.

NDIS_PACKET_EXTENSION

This structure contains an array of pointers, each of which points to or contains per-packet (out-of-band) information associated with a packet descriptor.

NDIS_PACKET_OOB_DATA

This structure contains out-of-band (OOB) information associated with a packet descriptor that is used by drivers whose media supplies, requires, or accepts OOB information, such as information for an asynchronous transfer mode (ATM) NIC.

NDIS_PACKET_STACK

This structure is a descriptor of the current stack in a packet.

NDIS_PM_PACKET_PATTERN

This structure specifies a wake-up pattern, which, when detected by a NIC that has pattern-match enabled, causes the NIC to signal a power-management wake-up event.

NDIS_PM_WAKE_UP_CAPABILITIES

This structure specifies the wake-up capabilities for a NIC. This structure is used by NDIS_PNP_CAPABILITIES.

NDIS_PNP_CAPABILITIES

OID_PNP_CAPABILITIES requests a miniport to return the wake-up capabilities of its NIC or requests an intermediate driver to return the intermediate driver's wake-up capabilities.

NDIS_PROTOCOL_CHARACTERISTICS

This structure is used to specify the version numbers and various callback functions for a protocol.

NDIS_REQUEST

This structure specifies a packet set up by NDIS or by a protocol for a call to the NdisRequest function.

NDIS_TAPI_ACCEPT

OID_TAPI_ACCEPT uses the NDIS_TAPI_ACCEPT when it requests the miniport driver to accept the specified call.

NDIS_TAPI_ANSWER

OID_TAPI_ANSWER uses the NDIS_TAPI_ANSWER structure when it requests the miniport driver to answer the specified call on offer.

NDIS_TAPI_CLOSE

OID_TAPI_CLOSE uses the NDIS_TAPI_CLOSE structure when it requests the miniport driver to close the specified open line device.

NDIS_TAPI_CLOSE_CALL

OID_TAPI_CLOSE_CALL uses the NDIS_TAPI_CLOSE_CALL structure when it requests the miniport driver to close a specified call after completing or terminating all outstanding asynchronous requests on the call.

NDIS_TAPI_CONDITIONAL_MEDIA_DETECTION

The NDIS_TAPI_CONDITIONAL_MEDIA_DETECTION structure is used by NDISTAPI when it makes an OID_TAPI_CONDITIONAL_MEDIA_DETECTION request to the WAN protocol driver.

NDIS_TAPI_CONFIG_DIALOG

The NDIS_TAPI_CONFIG_DIALOG structure is used with the OID_TAPI_CONFIG_DIALOGG to retrieve the name of a user-mode dynamic link library that can be called to configure the specified device.

NDIS_TAPI_DEV_SPECIFIC

The NDIS_TAPI_DEV_SPECIFIC structure is used with the OID_TAPI_DEV_SPECIFIC when it requests the miniport driver to provide access to features not accessible through other object identifier requests.

NDIS_TAPI_DIAL

OID_TAPI_DIAL uses the NDIS_TAPI_DIAL structure when it requests the miniport driver to dial the specified number on the specified call.

NDIS_TAPI_DROP

OID_TAPI_DROP uses the NDIS_TAPI_DROP structure when it requests the miniport driver to drop or disconnect the specified call.

NDIS_TAPI_GET_ADDRESS_CAPS

OID_TAPI_GET_ADDRESS_CAPS uses the NDIS_TAPI_GET_ADDRESS_CAPS structure to query the telephony capabilities of a specified address.

NDIS_TAPI_GET_ADDRESS_ID

The NDIS_TAPI_GET_ADDRESS_ID structure is used by OID_TAPI_GET_ADDRESS_ID when it requests the WAN NIC driver to return the address identifier associated with the address in a different format on the specified line.

NDIS_TAPI_GET_ADDRESS_STATUS

The NDIS_TAPI_GET_ADDRESS_STATUS structure is used by OID_TAPI_GET_ADDRESS_STATUS when it requests the miniport driver to return the status that is current for the specified address.

NDIS_TAPI_GET_CALL_ADDRESS_ID

The NDIS_TAPI_GET_CALL_ADDRESS_ID structure describes an address identifier requested from the miniport driver by OID_TAPI_GET_CALL_ADDRESS_ID.

NDIS_TAPI_GET_CALL_INFO

The NDIS_TAPI_GET_CALL_INFO structure describes detailed call information requested from the miniport driver by OID_TAPI_GET_CALL_INFO.

NDIS_TAPI_GET_CALL_STATUS

The NDIS_TAPI_GET_CALL_STATUS structure is used by OID_TAPI_GET_CALL_STATUS when it requests the miniport driver to return the status of the specified call.

NDIS_TAPI_GET_DEV_CAPS

The NDIS_TAPI_GET_DEV_CAPS structure is used by OID_TAPI_GET_DEV_CAPS when it requests the miniport driver to return the telephony capabilities of a specified line device.

NDIS_TAPI_GET_DEV_CONFIG

The NDIS_TAPI_GET_DEV_CONFIG structure describes the current configuration of a device associated one-to-one with a particular line.

NDIS_TAPI_GET_EXTENSION_ID

OID_TAPI_GET_EXTENSION_ID uses the NDIS_TAPI_GET_EXTENSION_ID structure when it requests the miniport driver to return the extension identifier for the specified line device.

NDIS_TAPI_GET_ID

The NDIS_TAPI_GET_ID structure is used by OID_TAPI_GET_ID when it requests the miniport driver to return a device identifier for the specified device class associated with the selected line, address, or call.

NDIS_TAPI_GET_LINE_DEV_STATUS

OID_TAPI_GET_LINE_DEV_STATUS uses NDIS_TAPI_GET_LINE_DEV_STATUS structure when it requests the miniport driver to return the status for the specified open line device.

NDIS_TAPI_MAKE_CALL

OID_TAPI_MAKE_CALL uses NDIS_TAPI_MAKE_CALL when it requests the miniport driver to place a call on the specified line to the specified destination address.

NDIS_TAPI_NEGOTIATE_EXT_VERSION

The NDIS_TAPI_NEGOTIATE_EXT_VERSION structure is used by OID_TAPI_NEGOTIATE_EXT_VERSION when it requests the miniport driver to return the highest version extension number the miniport driver is willing to operate under for this device, given the range of possible extension versions.

NDIS_TAPI_OPEN

The NDIS_TAPI_OPEN structure is used by OID_TAPI_OPEN when it requests the miniport driver to open the line device designated by the given device identifier and return the NIC driver's handle for the device.

NDIS_TAPI_PROVIDER_INITIALIZE

OID_TAPI_PROVIDER_INITIALIZE uses the NDIS_TAPI_PROVIDER_INITIALIZE structure when it requests that the miniport driver initialize itself as a TAPI provider.

NDIS_TAPI_PROVIDER_SHUTDOWN

OID_TAPI_PROVIDER_SHUTDOWN uses the NDIS_TAPI_PROVIDER_SHUTDOWN structure when it requests the miniport driver to shut down its TAPI operations when TAPI is cleaning up its state because applications are no longer using TAPI services.

NDIS_TAPI_SECURE_CALL

The NDIS_TAPI_SECURE_CALL structure is used by OID_TAPI_SECURE_CALLL when it requests the miniport driver to secure a particular call from any interruptions or interference that can affect the call's media stream.

NDIS_TAPI_SELECT_EXT_VERSION

OID_TAPI_SELECT_EXT_VERSION uses the NDIS_TAPI_SELECT_EXT_VERSION structure when it requests the miniport driver to select the indicated extension version for the indicated line device.

NDIS_TAPI_SEND_USER_USER_INFO

OID_TAPI_SEND_USER_USER_INFO uses the NDIS_TAPI_SEND_USER_USER_INFO structure when it requests the miniport driver to send user-to-user information to the remote party on the specified call.

NDIS_TAPI_SET_APP_SPECIFIC

OID_TAPI_SET_APP_SPECIFIC uses the NDIS_TAPI_SET_APP_SPECIFIC structure when it requests the miniport driver to set the ulAppSpecific member of the specified call's LINECALLINFO structure.

NDIS_TAPI_SET_CALL_PARAMS

The NDIS_TAPI_SET_CALL_PARAMS structure is used by OID_TAPI_SET_CALL_PARAMS when it requests the miniport driver to set certain call parameters for an existing call.

NDIS_TAPI_SET_DEFAULT_MEDIA_DETECTION

The NDIS_TAPI_SET_DEFAULT_MEDIA_DETECTION structure is used by OID_TAPI_SET_DEFAULT_MEDIA_DETECTION when it requests the miniport driver to use a new set of media modes to detect for the indicated line, thereby replacing whatever set it was using.

NDIS_TAPI_SET_DEV_CONFIG

The NDIS_TAPI_SET_DEV_CONFIG structure is used by OID_TAPI_SET_DEV_CONFIG when it requests the miniport driver to restore the configuration of a device associated one-to-one with the line device from a configuration previously obtained using OID_TAPI_SET_DEV_CONFIG.

NDIS_TAPI_SET_MEDIA_MODE

OID_TAPI_SET_MEDIA_MODE uses the NDIS_TAPI_SET_MEDIA_MODE structure when it requests the miniport driver to change a call's media mode as stored in the LINE_CALL_INFO structure for that call.

NDIS_TAPI_SET_STATUS_MESSAGES

The NDIS_TAPI_SET_STATUS_MESSAGES structure is used by OID_TAPI_SET_STATUS_MESSAGES when it requests the miniport driver to allow NDISTAPI to specify which notification messages the miniport driver should generate for events related to status changes for the specified line or any of its addresses.

NDIS_TASK_OFFLOAD

When a miniport supplies the structure in response to OID_TCP_TASK_OFFLOAD, this structure specifies a NIC's capabilities for performing a particular type of task offloaded from the TCP/IP transport.

NDIS_TASK_OFFLOAD_HEADER

This structure contains the encapsulation format for send and receive packets on which a miniport may perform tasks offloaded from the TCP/IP transport.

NDIS_TASK_TCP_IP_CHECKSUM

This structure contains information used in offloading checksum tasks from the TCP/IP transport to a NIC.

NDIS_TASK_TCP_LARGE_SEND

This structure contains the miniport's NIC capabilities for segmenting large TCP packets into smaller packets, if supplied by a miniport in response to a query of OID_TCP_TASK_OFFLOAD.

NDIS_TCP_IP_CHECKSUM_PACKET_INFO

This structure contains information used in offloading checksum tasks from the TCP/IP transport to a NIC.

NDIS_WAN_COMPRESS_INFO

The NDIS_WAN_COMPRESS_INFO structure describes compression information for use in OID_WAN_GET_COMP_INFO.

NDIS_WAN_GET_COMP_INFO

The NDIS_WAN_GET_COMP_INFO structure returns compression information to OID_WAN_GET_COMP_INFO.

NDIS_WAN_GET_LINK_INFO

The NDIS_WAN_GET_LINK_INFO structure formats information for OID_WAN_GET_LINK_INFO.

NDIS_WAN_GET_STATS_INFO

The NDIS_WAN_GET_STATS_INFO structure returns statistics requested by OID_WAN_GET_STATS_INFO.

NDIS_WAN_INFO

The NDIS_WAN_INFO structure formats information for OID_WAN_GET_INFO.

NDIS_WAN_PACKET

This structure contains the packet passed to the MiniportWanSend functions of WAN NIC drivers.

NDIS_WAN_SET_COMP_INFO

The NDIS_WAN_SET_COMP_INFO structure describes a protocol-selected compression scheme requested by OID_WAN_SET_COMP_INFO.

NDIS_WAN_SET_LINK_INFO

The NDIS_WAN_SET_LINK_INFO structure formats information for OID_WAN_SET_LINK_INFO.

NDIS_WLAN_BSSID

This structure contains an array of Basic Service Set (BSS) data used by NDIS_802_11_BSSID_LIST.

NDIS_WORK_ITEM

This structure is used to specify the entry point of a caller-supplied function that processes a work item when it is de-queued.

NDISUIO_DEVICE_NOTIFICATION

This structure is used to specify device notifications of media state, bind or unbind, and so on.

NDISUIO_REQUEST_NOTIFICATION

This structure is used by IOCTL_NDISUIO_REQUEST_NOTIFICATION to subscribe to adapter-related notifications.

NDISUIO_OPEN_CONTEXT

This structure represents the network device object when opened.

NDISUIO_QUERY_BINDING

This structure is used by IOCTL_NDISUIO_QUERY_BINDING to obtain information about the network adapter binding.

NDISUIO_QUERY_OID

This structure is used by IOCTL_NDISUIO_QUERY_OID_VALUE to query an NDIS object identifier.

NDISUIO_SET_OID

This structure is used by IOCTL_NDISUIO_SET_OID_VALUE.

NETWORK_ADDRESS

The NETWORK_ADDRESS structure describes the network-layer addresses that help define NETWORK_ADDRESS_LIST.

NETWORK_ADDRESS_LIST

OID_GEN_NETWORK_LAYER_ADDRESSES notifies underlying miniport and other layered drivers about the list of network-layer addresses that are associated with bound instances.

NIC_STATISTICS

This structure supports a NIC statistics query through IOCTL_NDISUIO_NIC_STATISTICS.

TRANSPORT_HEADER_OFFSET

Transports use a TRANSPORT_HEADER_OFFSET structure to indicate the size of additional headers for packets that a particular transport sends and receives.

VAR_STRING

This structure is an object-specific structured information buffer.

See Also

Reference

Network Driver Structures