WDF_WORKITEM_CONFIG structure

[Applies to KMDF and UMDF]

The WDF_WORKITEM_CONFIG structure contains information that is associated with a work item.

Syntax


typedef struct _WDF_WORKITEM_CONFIG {
  ULONG            Size;
  PFN_WDF_WORKITEM EvtWorkItemFunc;
  BOOLEAN          AutomaticSerialization;
} WDF_WORKITEM_CONFIG, *PWDF_WORKITEM_CONFIG;

Members

Size

The size, in bytes, of this WDF_WORKITEM_CONFIG structure.

EvtWorkItemFunc

The address of an EvtWorkItem event callback function.

AutomaticSerialization

A Boolean value that, if TRUE, indicates that the framework will synchronize execution of the EvtWorkItem callback function with callback functions from other objects that are underneath the work-item object's parent object. For more information, see the following Remarks section. If FALSE, the framework does not synchronize execution of the EvtWorkItem callback function.

Remarks

Your driver must initialize the WDF_WORKITEM_CONFIG structure by calling WDF_WORKITEM_CONFIG_INIT. Your driver can then pass the structure to the WdfWorkItemCreate method as an input parameter.

Setting the AutomaticSerialization member of WDF_WORKITEM_CONFIG to TRUE has no effect if the parent object's synchronization scope is set to WdfSynchronizationScopeNone.

If AutomaticSerialization is TRUE, the parent object's execution level must be WdfExecutionLevelPassive.

For more information about AutomaticSerialization and synchronizing driver callback functions, see Synchronization Techniques for Framework-Based Drivers.

Requirements

Minimum KMDF version

1.0

Minimum UMDF version

2.0

Header

Wdfworkitem.h (include Wdf.h)

See also

EvtWorkItem
WDF_WORKITEM_CONFIG_INIT
WdfWorkItemCreate

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft