Skip to content

Latest commit

 

History

History
108 lines (85 loc) · 3.47 KB

nf-wdm-pofxregistercrashdumpdevice.md

File metadata and controls

108 lines (85 loc) · 3.47 KB
Raw
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:wdm.PoFxRegisterCrashdumpDevice
PoFxRegisterCrashdumpDevice function (wdm.h)
The PoFxRegisterCrashdumpDevice routine registers a crash-dump device.
kernel\pofxregistercrashdumpdevice.htm
kernel
04/30/2018
PoFxRegisterCrashdumpDevice function
PoFxRegisterCrashdumpDevice, PoFxRegisterCrashdumpDevice routine [Kernel-Mode Driver Architecture], kernel.pofxregistercrashdumpdevice, wdm/PoFxRegisterCrashdumpDevice
wdm.h
Pepfx.h
Windows
Available starting with Windows 8.1.
Ntoskrnl.lib
PASSIVE_LEVEL
Windows
PoFxRegisterCrashdumpDevice
wdm/PoFxRegisterCrashdumpDevice
APIRef
kbSyntax
LibDef
ntoskrnl.lib
ntoskrnl.dll
PoFxRegisterCrashdumpDevice

PoFxRegisterCrashdumpDevice function

-description

The PoFxRegisterCrashdumpDevice routine registers a crash-dump device.

-parameters

-param Handle

A handle that represents the registration of the crash-dump device with the Windows power management framework (PoFx). The device driver previously received this handle from the PoFxRegisterDevice routine.

-returns

PoFxRegisterCrashdumpDevice returns STATUS_SUCCESS if the routine successfully registers the crash-dump device. Possible error return values include the following status codes.

Return value Description
STATUS_INVALID_PARAMETER
 Not a valid handle value.
STATUS_UNSUCCESSFUL
 There is no PEP for this device.

-remarks

This routine is called by the driver for a crash-dump device to inform PoFx that the device is part of the crash-dump device chain. Several devices (storage controller, PCI controller, and so on) might need to be turned on so that the Windows kernel can write a crash-dump file to disk. When a fatal system error occurs, the kernel tries to turn on the crash-dump devices and save the crash-dump file.

The driver must call PoFxRegisterDevice to register the device with PoFx before calling PoFxRegisterCrashdumpDevice.

The driver for a crash-dump device can call the PoFxPowerOnCrashdumpDevice routine to request that the PEP turn the device on.

For more information about crash dumps, see Kernel-Mode Dump Files.

PoFxRegisterCrashdumpDevice must be called at IRQL = PASSIVE_LEVEL.

-see-also

PoFxPowerOnCrashdumpDevice

PoFxRegisterDevice