NetAdapterOpenConfiguration function (netadapter.h)

Article
02/22/2024

The NetAdapterOpenConfiguration function opens a net adapter’s configuration database.

Syntax

NTSTATUS NetAdapterOpenConfiguration(
  [_In_]     NETADAPTER            Adapter,
  [_In_opt_] WDF_OBJECT_ATTRIBUTES *ConfigurationAttributes,
  [_Out_]    NETCONFIGURATION      *Configuration
);

Parameters

[_In_] Adapter

The network adapter object that the client created in a prior call to NetAdapterCreate.

[_In_opt_] ConfigurationAttributes

A pointer to a WDF_OBJECT_ATTRIBUTES structure that contains driver-supplied attributes for the new configuration object. This parameter is optional and can be WDF_NO_OBJECT_ATTRIBUTES.

[_Out_] Configuration

A pointer to a location that receives a handle to the new adapter configuration object.

Return value

The function returns STATUS_SUCCESS if the operation succeeds. Otherwise, this function may return an appropriate NTSTATUS error code.

Remarks

Typically, the client calls this function from its EVT_WDF_DRIVER_DEVICE_ADD callback function.

If the client provides a WDF_OBJECT_ATTRIBUTES, it specifies NULL for ParentObject. The adapter configuration object is automatically parented to the adapter object.

As a result, WDF automatically deletes the configuration object when the adapter is deleted. However, the client can manually delete a configuration object by calling WdfObjectDelete, typically from its EVT_WDF_OBJECT_CONTEXT_CLEANUP callback function.

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.21
Header	netadapter.h (include netadaptercx.h)
Library	NetAdapterCxStub.lib
IRQL	PASSIVE_LEVEL