nc-winbio_adapter-pibio_storage_notify_power_change_fn.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NC:winbio_adapter.PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN	PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN (winbio_adapter.h)	Receives notification about a change in the computer power state and prepares the storage adapter accordingly.	PBT_APMPOWERSTATUSCHANGE PBT_APMRESUMEAUTOMATIC PBT_APMSUSPEND PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN callback StorageAdapterNotifyPowerChange StorageAdapterNotifyPowerChange callback function [Windows Biometric Framework API] secbiomet.storageadapternotifypowerchange winbio_adapter/StorageAdapterNotifyPowerChange	secbiomet\storageadapternotifypowerchange.htm	SecBioMet	22c2ce7b-6e30-40e1-bbe8-f0e479ddcc77	12/05/2018	PBT_APMPOWERSTATUSCHANGE, PBT_APMRESUMEAUTOMATIC, PBT_APMSUSPEND, PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN, PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN callback, StorageAdapterNotifyPowerChange, StorageAdapterNotifyPowerChange callback function [Windows Biometric Framework API], secbiomet.storageadapternotifypowerchange, winbio_adapter/StorageAdapterNotifyPowerChange	winbio_adapter.h		Windows	Windows 8 [desktop apps only]	Windows Server 2012 [desktop apps only]													Windows			19H1	PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN winbio_adapter/PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN	c++	APIRef kbSyntax	UserDefined	Winbio_adapter.h	StorageAdapterNotifyPowerChange

PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN callback function

-description

Called by the Windows Biometric Framework when the system is ready to enter a low-power state or when the system has been awakened from a low-power state. The purpose of this function is to enable the adapter to respond to transitions in the computer power state.

-parameters

-param Pipeline [in, out]

Pointer to the WINBIO_PIPELINE structure associated with the biometric unit performing the operation.

-param PowerEventType [in]

Indicates the nature of the change. It can be one of the following values:

Value	Meaning
PBT_APMSUSPEND	The system is entering a low-power state
PBT_APMRESUMEAUTOMATIC	The system is returning from a low-power state.
PBT_APMPOWERSTATUSCHANGE	The status of the system's power source is changing (e.g., the system has switched from battery to line power, or the battery is getting low).

-returns

If the function succeeds, it returns S_OK. If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following table. For a list of common error codes, see Common HRESULT Values.

Return code	Description
E_POINTER	The Pipeline argument was NULL.
E_INVALIDARG	The PowerEventType argument was not one of the values listed in the table.

-remarks

When it receives a PBT_APMPOWERSTATUSCHANGE event, the adapter should call the Microsoft Win32 GetSystemPowerStatus API to determine the new power status.

The biometric framework calls this adapter entry point asynchronously, in the context of an arbitrary thread. It is the adapter's responsibility to synchronize the processing of this call with any other work it may be doing.

-see-also

GetSystemPowerStatus

PBT_APMPOWERSTATUSCHANGE