WinBioGetProperty function (winbio.h)
Retrieves a session, unit, or template property. Starting with Windows 10, build 1607, this function is available to use with a mobile image.
Syntax
HRESULT WinBioGetProperty(
[in] WINBIO_SESSION_HANDLE SessionHandle,
[in] WINBIO_PROPERTY_TYPE PropertyType,
[in] WINBIO_PROPERTY_ID PropertyId,
[in, optional] WINBIO_UNIT_ID UnitId,
[in, optional] WINBIO_IDENTITY *Identity,
[in, optional] WINBIO_BIOMETRIC_SUBTYPE SubFactor,
PVOID *PropertyBuffer,
[out, optional] SIZE_T *PropertyBufferSize
);
Parameters
[in] SessionHandle
A WINBIO_SESSION_HANDLE value that identifies an open biometric session. Open a synchronous session handle by calling WinBioOpenSession. Open an asynchronous session handle by calling WinBioAsyncOpenSession.
[in] PropertyType
A WINBIO_PROPERTY_TYPE value that specifies the source of the property information. Currently this must be WINBIO_PROPERTY_TYPE_UNIT or WINBIO_PROPERTY_TYPE_ACCOUNT. For more information about property types, see WINBIO_PROPERTY_TYPE Constants.
The WINBIO_PROPERTY_TYPE_ACCOUNT value is supported starting in Windows 10.
[in] PropertyId
A WINBIO_PROPERTY_ID value that specifies the property that you want to query. The following values are possible.
| Value | Meaning |
|---|---|
|
Estimates the maximum number of good biometric samples that are required to complete an enrollment template. The result of the property query is returned in the buffer to which to the PropertyBuffer parameter points as a ULONG value that contains the hint. |
|
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 in the buffer to which to the PropertyBuffer parameter points as a WINBIO_EXTENDED_SENSOR_INFO structure. This value is supported starting in Windows 10. |
|
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 in the buffer to which to the PropertyBuffer parameter points as a WINBIO_EXTENDED_ENGINE_INFO structure. This value is supported starting in Windows 10. |
|
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 in the buffer to which to the PropertyBuffer parameter points as a WINBIO_EXTENDED_STORAGE_INFO structure. This value is supported starting in Windows 10. |
|
Contains extended information about the status of an enrollment that is in progress on a specific biometric unit. The result of the property query is returned in the buffer to which to the PropertyBuffer parameter points as a WINBIO_EXTENDED_ENROLLMENT_STATUS structure. If no enrollment is in progress on the biometric unit, the TemplateStatus member of the returned structure has a value of WINBIO_E_INVALID_OPERATION. This value is supported starting in Windows 10. |
|
Contains the values of the antispoofing policy for a specific user account. The property operation is returned in the buffer to which to the PropertyBuffer parameter points as a WINBIO_ANTI_SPOOF_POLICY structure. This value is supported starting in Windows 10. |
For more information about these properties, see WINBIO_PROPERTY Constants.
[in, optional] UnitId
A WINBIO_UNIT_ID value that identifies the biometric unit. You can find a unit identifier by calling the WinBioEnumBiometricUnits or WinBioLocateSensor functions.
If you specify WINBIO_PROPERTY_ANTI_SPOOF_POLICY as the value for the PropertyId parameter, specify 0 for the UnitId parameter. If you specify any other property with the PropertyId parameter, you cannot specify 0 for the UnitId parameter.
[in, optional] Identity
A WINBIO_IDENTITY structure that provides the SID of the account for which you want to get the antispoofing policy, if you specify WINBIO_PROPERTY_ANTI_SPOOF_POLICY as the value of the PropertyId parameter.
If you specify any other value for the PropertyId parameter, the Identity parameter must be NULL.
[in, optional] SubFactor
Reserved. This must be WINBIO_SUBTYPE_NO_INFORMATION.
PropertyBuffer
Address of a pointer to a buffer that receives the property value. For information about the contents of this buffer for different properties, see the descriptions of the property values for the PropertyId parameter.
[out, optional] PropertyBufferSize
Pointer to a variable that receives the size, in bytes, of the buffer pointed to by the PropertyBuffer parameter.
Return value
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 |
|---|---|
|
The session handle specified by the SessionHandle parameter is not valid. |
|
The Identity, PropertyBuffer, or PropertyBufferSize arguments cannot be NULL. |
|
The UnitId, Identity, or SubFactor arguments are incorrect. |
|
The value of the PropertyType argument is incorrect. |
|
The value of the PropertyId argument is incorrect. |
|
The caller attempted to query a property that resides inside of a locked region. |
|
The object being queried does not support the specified property. |
|
The operation could not be completed because the specified biometric unit is currently being used for an enrollment transaction (system pool only). |
Remarks
To use WinBioGetProperty synchronously, call the function with a session handle created by calling WinBioOpenSession. The function blocks until the operation completes or an error is encountered. To prevent memory leaks when you use WinBioGetProperty synchronously, you must call WinBioFree to release the memory pointed to by the PropertyBuffer parameter when you are finished using the data contained in the buffer.
To use WinBioGetProperty asynchronously, call the function with a session handle created by calling WinBioAsyncOpenSession. The framework allocates a WINBIO_ASYNC_RESULT structure and uses it to return information about operation success or failure. If the operation is successful, the framework returns information in a nested GetProperty structure. The WINBIO_ASYNC_RESULT structure is returned to the application callback or to the application message queue, depending on the value you set in the NotificationMethod parameter of the WinBioAsyncOpenSession function:
- If you choose to receive completion notices by using a callback, you must implement a PWINBIO_ASYNC_COMPLETION_CALLBACK function and set the NotificationMethod parameter to WINBIO_ASYNC_NOTIFY_CALLBACK.
- If you choose to receive completion notices by using the application message queue, you must set the NotificationMethod parameter to WINBIO_ASYNC_NOTIFY_MESSAGE. The framework returns a WINBIO_ASYNC_RESULT pointer to the LPARAM field of the window message.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | winbio.h (include Winbio.h) |
| Library | Winbio.lib |
| DLL | Winbio.dll |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for