NdisOpenAdapter

Article
06/30/2006

This function sets up a binding between the calling protocol and a particular underlying network adapter driver or NDIS intermediate driver.

VOID NdisOpenAdapter(OUT PNDIS_STATUS Status, 
OUT PNDIS_STATUS OpenErrorStatus, 
OUT PNDIS_HANDLE NdisBindingHandle, 
OUT PUINT SelectedMediumIndex, 
IN PNDIS_MEDIUM MediumArray, 
IN UINT MediumArraySize, 
IN NDIS_HANDLE NdisProtocolHandle, 
IN NDIS_HANDLE ProtocolBindingContext, 
IN PNDIS_STRING AdapterName, 
IN UINT OpenOptions, 
IN PSTRING AddressingInformation );

Parameters

Status
Pointer to a caller-supplied variable that can be one of the following values on return from this function:

Value	Description
STATUS_SUCCESS	The requested binding is now set up, so the caller can use the values returned at NdisBindingHandle and SelectedMediumIndex in subsequent calls to the NdisXXX functions.
NDIS_STATUS_PENDING	The requested operation is being handled asynchronously, and the caller's ProtocolOpenAdapterComplete function will be called when the open is completed.
NDIS_STATUS_RESOURCES	The requested operation failed because NDIS could not allocate sufficient memory or initialize the state that it uses to track an open binding.
NDIS_STATUS_ADAPTER_NOT_FOUND	The requested operation failed because the name at AdapterName could not be found in the system object namespace.
NDIS_STATUS_UNSUPPORTED_MEDIA	The array at MediumArray did not specify any medium that is supported by NDIS or by the underlying driver.
NDIS_STATUS_CLOSING	Either the caller or the physical or virtual device designated at AdapterName is being closed.
NDIS_STATUS_OPEN_FAILED	The open attempt failed for none of the preceding specific reasons. For example, possibly, NDIS could not initialize the filter package for the selected medium.

OpenErrorStatus
Pointer to a caller-supplied variable that can contain an NDIS_STATUS_XXX error supplying more information if this function returns an error at Status. For example, the driver of a token ring network adapter might return a ring error in this variable.
NdisBindingHandle
Pointer to a caller-supplied variable in which NDIS returns a handle representing a successful binding between the caller and the specified physical or virtual network adapter specified at AdapterName.
SelectedMediumIndex
Pointer to a caller-supplied variable in which NDIS returns the index of the array element that specifies the type of media that the underlying NDIS driver uses.

MediumArray
Pointer to an array of NDIS_MEDIUM-type values specifying the types of media that the caller supports. Possible elements include any proper subset of the following:

Value	Description
NdisMedium802_3	Specifies an Ethernet (802.3) network.
NdisMedium802_5	Specifies a Token Ring (802.5) network.
NdisMediumWan	Specifies a wide area network. This type covers various forms of point-to-point and WAN network adapters, as well as variant address and header formats that must be negotiated between the protocol driver and the underlying driver after the binding is established.
NdisMediumIrda	This value is reserved for future use.

MediumArraySize
Specifies the number of elements at MediumArray.
NdisProtocolHandle
Handle returned by NdisRegisterProtocol.
ProtocolBindingContext
Handle to a caller-supplied resident context area in which the protocol maintains state information about this binding after it has been established.
AdapterName
Pointer to a counted string, specified in the system-default character set, naming the network adapter or the virtual adapter of an underlying NDIS driver that exports a set of upper-edge (MiniportXXX) functions.
OpenOptions
Specifies a bitmask containing flags that the caller passes to the next-lower driver, assumed to be a network adapter driver. Currently, this parameter is reserved for system use.
AddressingInformation
Pointer to an optional variable-length counted string containing information specific to the underlying network adapter that the network adapter driver can use to program the netcard. This pointer can be NULL.

If it is supplied, the addressing information must remain valid until the open operation completes. An underlying network adapter driver that supports an asynchronous modem can use this information for dialing.

Remarks

Protocol drivers call this function from either their DriverEntry or their ProtocolBindAdapter functions. NDIS intermediate drivers usually make this call from their ProtocolBindAdapter functions.

The string at AdapterName remains valid only until this function returns control, even if it returns NDIS_STATUS_PENDING at Status.

The variables at NdisBindingHandle and SelectedMediumIndex should be ignored until the ProtocolOpenAdapterComplete function is called if this function returns NDIS_STATUS_PENDING. Because these variables can remain invalid until ProtocolOpenAdapterComplete is called, they cannot be on the stack. Usually, these variables reside in the ProtocolBindingContext area since this handle is an input parameter to ProtocolOpenAdapterComplete.

A protocol driver should keep the handle returned at NdisProtocolHandle. It is a required parameter to other NDIS functions that the driver calls subsequently. The supplied ProtocolBindingContext is an input parameter to the caller's protocol functions.

The caller uses the value returned at SelectedMediumIndex in subsequent calls to the NdisRequest function. The OIDs that it sets in the request packet depend on the returned NdisMediumXXX function. For example, if NdisMediumWan is returned at SelectedMediumIndex, the protocol driver calls NdisRequest specifying OID_WAN_MEDIUM_SUBTYPE in a query to determine which of the WAN media types that the underlying driver uses.

If a previously issued global query of OID_NETWORK_TYPE for wireless media indicates that the driver and underlying network adapter support more than one NdisMediumWirelessWan-type medium, the protocol must select one of the supported media as soon as NDIS has set up the binding and before the protocol selects the header format.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.0 and later	Ndis.h		Ndislib.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

Last updated on Tuesday, July 13, 2004

NdisOpenAdapter

Additional resources