NdisOpenConfiguration

NdisOpenConfiguration returns a handle for a registry key in which an NDIS NIC driver’s advanced configuration parameters are stored.

VOID
  NdisOpenConfiguration(
    OUT PNDIS_STATUS  Status,
    OUT PNDIS_HANDLE  ConfigurationHandle,
    IN NDIS_HANDLE  WrapperConfigurationContext
    );

Parameters

Status

Pointer to a caller-supplied variable in which this function returns the status of its attempt to open the registry key. Possible return values are:

NDIS_STATUS_SUCCESS

NDIS has initialized accessed to the registry key in which the miniport driver's advanced configuration parameters are stored.

NDIS_STATUS_FAILURE

The key could not be opened.

ConfigurationHandle

Pointer to a caller-supplied variable in which this function returns a handle to the registry key in which an NDIS NIC driver's advanced configuration parameters are stored. Value entries under this key were provided by the driver’s installation script.

WrapperConfigurationContext

Specifies the handle input to MiniportInitialize.

Headers

Declared in Ndis.h. Include Ndis.h.

Comments

With the handle returned by NdisOpenConfiguration, an NDIS miniport driver can call NdisReadConfiguration one or more times to extract information about a NIC’s advanced configuration parameters from the registry. A miniport driver can also call NdisReadNetworkAddress with this handle to retrieve software-configurable network address information that was stored in the registry when its NIC was installed in the current machine.

A miniport driver can call NdisOpenConfigurationKeyByName or NdisOpenConfigurationKeyByIndex to open a subkey relative to the key for which NdisOpenConfiguration returned the handle.

A NIC driver should call NdisMSetAttributes or NdisMSetAttributesEx to identify the type of I/O bus on which its NIC is likely to be found before that driver calls any of the bus-type-specific configuration functions.

After a driver has consumed and, possibly, modified the registry configuration information, the driver must call NdisCloseConfiguration to release the handle obtained from NdisOpenConfiguration and to free any temporary storage NDIS allocated in the driver’s calls to NdisReadConfiguration, NdisReadNetworkAddress, and/or NdisWriteConfiguration.

Callers of NdisOpenConfiguration run at IRQL = PASSIVE_LEVEL.

See Also

MiniportInitialize, NdisCloseConfiguration, NdisIMRegisterLayeredMiniport, NdisMMapIoSpace, NdisMRegisterInterrupt, NdisMRegisterIoPortRange, NdisMRegisterMiniport, NdisMSetAttributes, NdisMSetAttributesEx, NdisOpenConfigurationKeyByIndex, NdisOpenConfigurationKeyByName, NdisOpenProtocolConfiguration, NdisReadConfiguration, NdisReadEisaSlotInformation, NdisReadNetworkAddress, NdisReadPciSlotInformation, NdisRegisterProtocol, NdisWriteConfiguration