NetDeviceOpenConfiguration function (netdevice.h)

The NetDeviceOpenConfiguration function opens a net device's configuration database.

Syntax

NTSTATUS NetDeviceOpenConfiguration(
  [_In_]     WDFDEVICE             Device,
  [_In_opt_] WDF_OBJECT_ATTRIBUTES *ConfigurationAttributes,
  [_Out_]    NETCONFIGURATION      *Configuration
);

Parameters

[_In_] Device

The WDFDEVICE object the client driver previously created with a call to WdfDeviceCreate.

[_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 the location that receives the new NETCONFIGURATION object.

Return value

This 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 device configuration object is automatically parented to the device object.

As a result, WDF automatically deletes the configuration object when the device 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

See also

Accessing configuration information