PSHED_PI_CLEAR_ERROR_STATUS callback function (ntddk.h)

Article
04/21/2023

A PSHED plug-in's ClearErrorStatus callback function clears any platform-specific error status registers for a corrected hardware error condition.

Syntax

PSHED_PI_CLEAR_ERROR_STATUS PshedPiClearErrorStatus;

NTSTATUS PshedPiClearErrorStatus(
  [in, out, optional] PVOID PluginContext,
  [in]                PWHEA_ERROR_SOURCE_DESCRIPTOR ErrorSource,
  [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] ErrorSource

A pointer to a WHEA_ERROR_SOURCE_DESCRIPTOR structure that describes the error source that reported the hardware error.

[in] BufferLength

The size, in bytes, of the buffer pointed to by the ErrorRecord parameter.

[in] ErrorRecord

A pointer to a WHEA_ERROR_RECORD structure that describes an error record. The error record describes the corrected hardware error condition for which the platform-specific error status registers are being cleared.

Return value

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

Return code	Description
STATUS_SUCCESS	The platform-specific error status registers for the corrected hardware error condition were successfully cleared.
STATUS_NOT_SUPPORTED	The PSHED plug-in does not support the specified error source.
STATUS_UNSUCCESSFUL	An error occurred.

Remarks

A PSHED plug-in that participates in error information retrieval sets the Callbacks.RetrieveErrorInfo, Callbacks.FinalizeErrorRecord, and Callbacks.ClearErrorStatus members of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure to point to its RetrieveErrorInfo, FinalizeErrorRecord, and ClearErrorStatus callback functions when the plug-in calls the PshedRegisterPlugin function to register itself with the PSHED. The PSHED plug-in must also set the PshedFAErrorInfoRetrieval flag in the FunctionalAreaMask member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure.

For corrected hardware error conditions, the Windows kernel calls into the PSHED to clear the error source's error status registers as the final step of processing the error. If a PSHED plug-in is registered to participate in error information retrieval, the PSHED calls the PSHED plug-in's ClearErrorStatus callback function so that the PSHED plug-in can clear any additional platform-specific error status registers.

Requirements

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