PSHED_PI_GET_INJECTION_CAPABILITIES callback function (ntddk.h)

Article
04/21/2023

A PSHED plug-in's GetInjectionCapabilities callback function returns an error injection capabilities union that describes the types of hardware errors that can be injected into the hardware platform.

Syntax

PSHED_PI_GET_INJECTION_CAPABILITIES PshedPiGetInjectionCapabilities;

NTSTATUS PshedPiGetInjectionCapabilities(
  [in, out, optional] PVOID PluginContext,
  [out]               PWHEA_ERROR_INJECTION_CAPABILITIES Capabilities
)
{...}

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.

[out] Capabilities

A pointer to a WHEA_ERROR_INJECTION_CAPABILITIES union. This union receives the data that describes the types of hardware errors that can be injected into the hardware platform.

Return value

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

Return code	Description
STATUS_SUCCESS	The data that describes the types of hardware errors that can be injected into the hardware platform was successfully returned in the WHEA_ERROR_INJECTION_CAPABILITIES union pointed to by the Capabilities parameter.
STATUS_UNSUCCESSFUL	An error occurred.

Remarks

A PSHED plug-in that participates in error injection sets the Callbacks.GetInjectionCapabilities and Callbacks.InjectError members of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure to point to its GetInjectionCapabilities and InjectError callback functions when the plug-in calls the PshedRegisterPlugin function to register itself with the PSHED. The PSHED plug-in must also set the PshedFAErrorInjection flag in the FunctionalAreaMask member of the WHEA_PSHED_PLUGIN_REGISTRATION_PACKET structure.

The Windows kernel calls into the PSHED to retrieve information about the types of hardware errors that can be injected into the hardware platform in response to an error injection capabilities inquiry by a WHEA management application. If a PSHED plug-in is registered to participate in error injection, the PSHED calls the PSHED plug-in's GetInjectionCapabilities callback function to retrieve information about additional types of hardware errors that can be injected into the hardware platform.

Requirements

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