PIBIO_ENGINE_SET_ACCOUNT_POLICY_FN callback function (winbio_adapter.h)

Article
10/13/2021

Called by the Windows Biometric Framework to set the extended default and per-user antispoofing policies used by the engine adapter.

Syntax

PIBIO_ENGINE_SET_ACCOUNT_POLICY_FN PibioEngineSetAccountPolicyFn;

HRESULT PibioEngineSetAccountPolicyFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      PWINBIO_ACCOUNT_POLICY PolicyItemArray,
  [in]      SIZE_T PolicyItemCount
)
{...}

Parameters

[in, out] Pipeline

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

[in] PolicyItemArray

Address of an array of WINBIO_ACCOUNT_POLICY structures, which the routine should use to update the policies it is applying to any identities it detects.

[in] PolicyItemCount

The number of elements in the array pointed to by the PolicyItemArray parameter.

Return value

If the function succeeds, it returns S_OK. If the function fails, it must return one of the following HRESULT values to indicate the error.

Return code	Description
E_some_error	Errors return by the method are logged but ignored.

Remarks

This method is called each time the biometric unit is activated.

This method executes in the context of the same thread that activated the biometric unit and that processed all other requests for the unit.

The Identity.Type field of the first element in the PolicyItemArray will always be WINBIO_ID_TYPE_WILDCARD. This indicates that the policy item contains a default AntiSpoofBehavior value which should be applied to any user account that isn’t explicitly listed in the rest of the array.

If the PolicyItemArray contains more than one element, the Identity.Type field of the remaining items will be WINBIO_ID_TYPE_WILDCARD, and the Identity.Value.AccountSid.Data field will contain the SID of a user account that requires the antispoof policy behavior specified in the AntiSpoofBehavior field of the array element.

Requirements

Requirement	Value
Minimum supported client	Windows 10 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	winbio_adapter.h (include Winbio_adapter.h)

Share via