Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 3.25 KB

nf-wdfdpc-wdfdpcwdmgetdpc.md

File metadata and controls

99 lines (67 loc) · 3.25 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:wdfdpc.WdfDpcWdmGetDpc
WdfDpcWdmGetDpc function (wdfdpc.h)
The WdfDpcWdmGetDpc method returns a pointer to the KDPC structure that is associated with a specified framework DPC object.
wdf\wdfdpcwdmgetdpc.htm
wdf
02/26/2018
WdfDpcWdmGetDpc function
DFDpcObjectRef_26bd69e5-277b-4af4-a5b7-659670b39fbb.xml, WdfDpcWdmGetDpc, WdfDpcWdmGetDpc method, kmdf.wdfdpcwdmgetdpc, wdf.wdfdpcwdmgetdpc, wdfdpc/WdfDpcWdmGetDpc
wdfdpc.h
Wdf.h
Universal
1.0
DriverCreate, KmdfIrql, KmdfIrql2
Wdf01000.sys (see Framework Library Versioning.)
Any level
Windows
WdfDpcWdmGetDpc
wdfdpc/WdfDpcWdmGetDpc
APIRef
kbSyntax
LibDef
Wdf01000.sys
Wdf01000.sys.dll
WdfDpcWdmGetDpc

WdfDpcWdmGetDpc function

-description

[Applies to KMDF only]

The WdfDpcWdmGetDpc method returns a pointer to the KDPC structure that is associated with a specified framework DPC object.

-parameters

-param Dpc [in]

A handle to a framework DPC object.

-returns

WdfDpcWdmGetDpc returns a pointer to the KDPC structure that is associated with the specified framework DPC object.

A bug check occurs if the driver supplies an invalid object handle.

-remarks

The framework creates a KDPC structure when a framework-based driver calls WdfDpcCreate to create a DPC object.

A driver might call WdfDpcWdmGetDpc from within its EvtDpcFunc callback function.

The pointer that WdfDpcWdmGetDpc returns is valid until the framework DPC object is deleted. If the driver provides an EvtCleanupCallback function for the framework DPC object, the pointer is valid until the callback function returns.

Examples

The following code example returns a pointer to the KDPC structure that is associated with a specified DPC object. The WdfDpcCreate code example shows how the specified DPC object was created.

PKDPC pWdmDpc;

pWdmDpc = WdfDpcWdmGetDpc(PDevExt->CompleteWriteDpc);

-see-also

EvtDpcFunc

KDPC

WDF_DPC_CONFIG

WdfDpcCreate