PSHED_PI_GET_ERROR_SOURCE_INFO callback function (ntddk.h)

Article
04/21/2023

A PSHED plug-in's GetErrorSourceInfo callback function returns an error source descriptor structure that represents a particular error source that is implemented by the hardware platform.

Syntax

PSHED_PI_GET_ERROR_SOURCE_INFO PshedPiGetErrorSourceInfo;

NTSTATUS PshedPiGetErrorSourceInfo(
  [in, out, optional] PVOID PluginContext,
  [in, out]           PWHEA_ERROR_SOURCE_DESCRIPTOR ErrorSource
)
{...}

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, out] ErrorSource

A pointer to a WHEA_ERROR_SOURCE_DESCRIPTOR structure that represents a particular error source that is implemented by the hardware platform.

Return value

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

Return code	Description
STATUS_SUCCESS	The error source information was successfully updated.
STATUS_UNSUCCESSFUL	An error occurred.

Remarks

A PSHED plug-in that participates in error source discovery sets the Callbacks.GetAllErrorSources member and, optionally, the Callbacks.GetErrorSourceInfo member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure to point to its GetAllErrorSources and GetErrorSourceInfo callback functions when the plug-in calls the PshedRegisterPlugin function to register itself with the PSHED. The PSHED plug-in must also set the PshedFADiscovery flag in the FunctionalAreaMask member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure.

The Windows kernel calls into the PSHED to obtain additional details about a particular error source. This occurs when a new error source is added to the system by a bus driver. For example, when the PCI driver discovers a PCI Express (PCIe) device that is capable of reporting PCIe errors, it reports the error source to the operating system.

If a PSHED plug-in is registered to participate in error source discovery and it has implemented a GetErrorSourceInfo callback function, after the PSHED has updated the error source descriptor structure with the information that it has collected about the error source, the PSHED calls the PSHED plug-in's GetErrorSourceInfo callback function so that the PSHED plug-in can provide additional details about the error source. The GetErrorSourceInfo callback function updates the contents of the error source descriptor structure so that it accurately represents the error source as it is implemented by the hardware platform.

Requirements

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