WINBIO_PROPERTY Constants

The following constants are WINBIO_PROPERTY_ID values that can be used to specify the property to be queried in the PropertyId parameter of the WinBioGetProperty function. Some properties can also be set using the same parameter in the WinBioSetProperty function. The results of the query are returned or specified in the PropertyBuffer parameter of those functions, and the type and size of the result vary depending on what property is queried.

Constant/value Description
WINBIO_PROPERTY_SAMPLE_HINT
1
This read-only biometric property estimates the maximum number of good biometric samples that are required to complete an enrollment template. The result of the property query is returned as a ULONG value that contains the hint.
When this property is queried, the passed SessionHandle and UnitId parameters must be valid, the Identity parameter must be NULL, and the SubFactor parameter must be WINBIO_SUBTYPE_NO_INFORMATION.
WINBIO_PROPERTY_EXTENDED_SENSOR_INFO
2
This read-only biometric property contains extended information about the capabilities and attributes of the sensor component that is connected to a specific biometric unit. The result of the property query is returned as a WINBIO_EXTENDED_SENSOR_INFO structure.
When this property is queried, the passed SessionHandle and UnitId parameters must be valid, the Identity parameter must be NULL, and the SubFactor parameter must be WINBIO_SUBTYPE_NO_INFORMATION.
WINBIO_PROPERTY_EXTENDED_ENGINE_INFO
3
This read-only biometric property contains extended information about the capabilities and attributes of the engine component that is connected to a specific biometric unit. The result of the property query is returned as a WINBIO_EXTENDED_ENGINE_INFO structure.
When this property is queried, the passed SessionHandle and UnitId parameters must be valid, the Identity parameter must be NULL, and the SubFactor parameter must be WINBIO_SUBTYPE_NO_INFORMATION.
WINBIO_PROPERTY_EXTENDED_STORAGE_INFO
4
This read-only biometric property contains extended information about the capabilities and attributes of the storage component that is connected to a specific biometric unit. The result of the property query is returned as a WINBIO_EXTENDED_STORAGE_INFO structure.
When this property is queried, the passed SessionHandle and UnitId parameters must be valid, the Identity parameter must be NULL, and the SubFactor parameter must be WINBIO_SUBTYPE_NO_INFORMATION.
WINBIO_PROPERTY_EXTENDED_ENROLLMENT_STATUS
5
This read-only biometric property contains extended information about the status of an in-progress enrollment on a specific biometric unit. The result of the property query is returned as a WINBIO_EXTENDED_STORAGE_INFO structure. If no enrollment is in progress on the BU, the TemplateStatus member of the returned structure has a value of WINBIO_E_INVALID_OPERATION.
When this property is queried, the passed SessionHandle and UnitId parameters must be valid, the Identity parameter must be NULL, and the SubFactor parameter must be WINBIO_SUBTYPE_NO_INFORMATION.
WINBIO_PROPERTY_ANTI_SPOOF_POLICY
1
This read-write biometric property contains the values of the antispoofing policy for a specific user account. The property operation is specified or returned as a WINBIO_ANTI_SPOOF_POLICY structure.
When this property is queried, the passed SessionHandle parameter must be valid, the UnitId parameter must be zero, the Identity parameter must be the account security identifier (SID) value to be queried or changed (to use the SID value associated with SessionHandle, specify NULL), and the SubFactor parameter must be WINBIO_SUBTYPE_NO_INFORMATION.
If this property is queried using the wildcard identity, the system default value of this policy is returned. Nonprivileged users can only modify their own policy setting. If a nonprivileged user attempts to call the WinBioSetProperty function with an Identity parameter that represents another user account or contains a wildcard identifier value, the property write attempt will fail.

Requirements

Requirement Value
Minimum supported client
Windows 10 [desktop apps only]
Minimum supported server
Windows Server 2016 [desktop apps only]
Header
Winbio_types.h (include Winbio.h)