PoFxRegisterPlugin function (pep_x.h)

Article
02/22/2024

The PoFxRegisterPlugin routine registers a platform extension plug-in (PEP) with the Windows power management framework (PoFx).

Syntax

NTSTATUS PoFxRegisterPlugin(
  [in]      PPEP_INFORMATION        PepInformation,
  [in, out] PPEP_KERNEL_INFORMATION KernelInformation
);

Parameters

[in] PepInformation

A pointer to a PEP_INFORMATION structure.

[in, out] KernelInformation

A pointer to a PEP_KERNEL_INFORMATION_STRUCT_V3 structure.

Return value

PoFxRegisterPlugin returns STATUS_SUCCESS if the call successfully registers the PEP. Possible error return values include the following status codes.

Return value	Description
STATUS_INVALID_PARAMETER	The Version or Size member of the PEP_KERNEL_INFORMATION structure is set to an invalid value; or the AcceptDeviceNotification member of this structure is set to NULL.
STATUS_INVALID_PEP_INFO_VERSION	The Version member of the PEP_INFORMATION structure is set to an invalid value.
STATUS_INSUFFICIENT_RESOURCES	Unable to allocate the resources required to complete the requested registration.

Remarks

A PEP calls this routine to register itself with PoFx.

A PEP cannot unregister, and cannot register twice. If the PEP must be serviced, the operating system must restart.

The PoFxRegisterPluginEx routine is similar to PoFxRegisterPlugin, except that it takes an additional parameter, Flags.

The PEP must call PoFxRegisterPlugin at IRQL = PASSIVE_LEVEL.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 10.
Target Platform	Windows
Header	pep_x.h (include Pep_x.h)
Library	Ntoskrnl.lib
IRQL	PASSIVE_LEVEL