The OnCleanup method releases any references to a WDF object to prevent interface leakage.

void
  OnCleanup(
    IN IWDFObject*  pWdfObject
    );

Parameters

pWdfObject

A pointer to the IWDFObject interface of a object that is about to be released.

Return Value

None

Comments

The framework calls OnCleanup as part of a WDF object destruction sequence. The framework calls OnCleanup before the WDF object is destroyed.

A driver can register the IObjectCleanup interface when the driver calls any of the following methods that creates a WDF object or that assigns a context to the WDF object:

• IWDFDevice::CreateIoQueue
• IWDFDevice::CreateRequest
• IWDFDriver::CreateDevice
• IWDFDriver::CreatePreallocatedWdfMemory
• IWDFDriver::CreateWdfMemory
• IWDFDriver::CreateWdfObject
• IWDFObject::AssignContext

Requirements

Headers: Declared in Wudfddi.h. Include Wudfddi.h.

See Also

IObjectCleanup, IWDFDevice::CreateIoQueue, IWDFDevice::CreateRequest, IWDFDriver::CreateDevice, IWDFDriver::CreatePreallocatedWdfMemory, IWDFDriver::CreateWdfMemory, IWDFDriver::CreateWdfObject, IWDFObject, IWDFObject::AssignContext

APIScan Requirements

Header: Wudfddi.h
Function: IObjectCleanup::OnCleanup