PSHED_PI_ATTEMPT_ERROR_RECOVERY callback function (ntddk.h)

Article
04/21/2023

A PSHED plug-in's AttemptRecovery callback function attempts to recover from a recoverable hardware error.

Syntax

PSHED_PI_ATTEMPT_ERROR_RECOVERY PshedPiAttemptErrorRecovery;

NTSTATUS PshedPiAttemptErrorRecovery(
  [in, out, optional] PVOID PluginContext,
  [in]                ULONG BufferLength,
  [in]                PWHEA_ERROR_RECORD ErrorRecord
)
{...}

Parameters

[in, out, optional] PluginContext

A pointer to the context area that was specified in the Context member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure when the PSHED plug-in called the PshedRegisterPlugin function to register itself with the PSHED.

[in] BufferLength

The size, in bytes, of the error record that is pointed to by the ErrorRecord parameter.

[in] ErrorRecord

A pointer to a WHEA_ERROR_RECORD structure that describes an error record for a recoverable hardware error.

Return value

A PSHED plug-in's AttemptRecovery callback function returns one of the following NTSTATUS codes.

Return code	Description
STATUS_SUCCESS	The attempt to recover from the hardware error was successful.
STATUS_UNSUCCESSFUL	The attempt to recover from the hardware error was unsuccessful.

Remarks

A PSHED plug-in that participates in error recovery sets the Callbacks.AttemptRecovery member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure to point to its AttemptRecovery callback function when the plug-in calls the PshedRegisterPlugin function to register itself with the PSHED. The PSHED plug-in must also set the PshedFAErrorRecovery flag in the FunctionalAreaMask member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure.

The Windows kernel attempts to recover from a recoverable hardware error while it processes the error after all of the hardware error data has been put into the error record. The Windows kernel then calls into the PSHED to give it an opportunity to perform any required recovery operations. If a PSHED plug-in is registered to participate in error recovery, the PSHED calls the PSHED plug-in's AttemptRecovery callback function so that it can attempt to correct the error and/or perform any additional operations that are required to fully recover from the error condition.

If the Windows kernel or the PSHED successfully recovers from the hardware error, it updates the WHEA_ERROR_RECORD structure that describes the error before it calls the PSHED plug-in's AttemptRecovery callback function as follows:

The Header.Severity member is changed from WheaErrSevRecoverable to WheaErrSevCorrected.
The Header.Flags.Recovered bit is set.

If the PSHED plug-in successfully recovers from the hardware error, the PSHED will update the WHEA_ERROR_RECORD structure on behalf of the PSHED plug-in after the call to the PSHED plug-in's AttemptRecovery callback function returns. A PSHED plug-in's AttemptRecovery callback function should not modify the error record.

The PSHED calls a PSHED plug-in's AttemptRecovery callback function at IRQL <= HIGH_LEVEL. The exact IRQL at which this callback function is called depends on the specific type of hardware error that occurred.

Requirements

Requirement	Value
Target Platform	Desktop
Header	ntddk.h (include Ntddk.h)
IRQL	IRQL >= DISPATCH_LEVEL