WDF_FILEOBJECT_CONFIG_INIT function (wdfdevice.h)

[Applies to KMDF and UMDF]

The WDF_FILEOBJECT_CONFIG_INIT function initializes a driver's WDF_FILEOBJECT_CONFIG structure.

Syntax

void WDF_FILEOBJECT_CONFIG_INIT(
  [out]          PWDF_FILEOBJECT_CONFIG     FileEventCallbacks,
  [in, optional] PFN_WDF_DEVICE_FILE_CREATE EvtDeviceFileCreate,
  [in, optional] PFN_WDF_FILE_CLOSE         EvtFileClose,
  [in, optional] PFN_WDF_FILE_CLEANUP       EvtFileCleanup
);

Parameters

[out] FileEventCallbacks

A pointer to a driver-allocated WDF_FILEOBJECT_CONFIG structure.

[in, optional] EvtDeviceFileCreate

A pointer to the driver's EvtDeviceFileCreate event callback function.

[in, optional] EvtFileClose

A pointer to the driver's EvtFileClose event callback function.

[in, optional] EvtFileCleanup

A pointer to the driver's EvtFileCleanup event callback function.

Return value

None

Remarks

The WDF_FILEOBJECT_CONFIG_INIT function sets the specified WDF_FILEOBJECT_CONFIG structure's Size member, stores the specified callback function pointers, sets the FileObjectClass member to WdfFileObjectWdfCannotUseFsContexts, and sets the AutoForwardCleanupClose member to WdfUseDefault.

Examples

For a code example that uses WDF_FILEOBJECT_CONFIG_INIT, see WdfDeviceInitSetFileObjectConfig.

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header wdfdevice.h (include Wdf.h)
IRQL Any level