Edit

Share via

WINBIO_UNIT_SCHEMA structure

  • Article

The WINBIO_UNIT_SCHEMA structure describes the capabilities of a biometric unit. It is used by the WinBioEnumBiometricUnits function.

Syntax

typedef struct _WINBIO_UNIT_SCHEMA {
  WINBIO_UNIT_ID                  UnitId;
  WINBIO_POOL_TYPE                PoolType;
  WINBIO_BIOMETRIC_TYPE           BiometricFactor;
  WINBIO_BIOMETRIC_SENSOR_SUBTYPE SensorSubType;
  WINBIO_CAPABILITIES             Capabilities;
  WINBIO_STRING                   DeviceInstanceId;
  WINBIO_STRING                   Description;
  WINBIO_STRING                   Manufacturer;
  WINBIO_STRING                   Model;
  WINBIO_STRING                   SerialNumber;
  WINBIO_VERSION                  FirmwareVersion;
} WINBIO_UNIT_SCHEMA, *PWINBIO_UNIT_SCHEMA;

Members

UnitId

A value that identifies the biometric unit.

PoolType

A ULONG value that specifies the type of the biometric unit. This can be one of the following values:

Value Meaning
WINBIO_POOL_UNKNOWN
 The type is unknown.
WINBIO_POOL_SYSTEM
 The session connects to a shared collection of biometric units managed by the service provider.
WINBIO_POOL_PRIVATE
 The session connects to a collection of biometric units that are managed by the caller.

BiometricFactor

A value that specifies the type of the biometric unit. Only WINBIO_TYPE_FINGERPRINT is currently supported.

SensorSubType

A sensor subtype defined for the biometric type specified by the BiometricFactor member. Only fingerprint types (WINBIO_TYPE_FINGERPRINT) are currently supported. The following subtypes are currently defined for fingerprints:

  • WINBIO_SENSOR_SUBTYPE_UNKNOWN
  • WINBIO_FP_SENSOR_SUBTYPE_SWIPE
  • WINBIO_FP_SENSOR_SUBTYPE_TOUCH

Capabilities

A bitmask of the biometric sensor capabilities. This can be a bitwise OR of the following values:

  • WINBIO_CAPABILITY_SENSOR
  • WINBIO_CAPABILITY_MATCHING
  • WINBIO_CAPABILITY_DATABASE
  • WINBIO_CAPABILITY_PROCESSING
  • WINBIO_CAPABILITY_ENCRYPTION
  • WINBIO_CAPABILITY_NAVIGATION
  • WINBIO_CAPABILITY_INDICATOR
  • WINBIO_CAPABILITY_VIRTUAL_SENSOR

    Note

    The WINBIO_CAPABILITY_VIRTUAL_SENSOR constant applies only for Windows 10 and later.

DeviceInstanceId

A string value that contains the device ID. The string can contain up to 256 Unicode characters including a terminating NULL character.

Description

A string value that contains a description of the biometric unit. The string can contain up to 256 Unicode characters including a terminating NULL character.

Manufacturer

A string value that contains the name of the manufacturer. The string can contain up to 256 Unicode characters including a terminating NULL character.

Model

A string value that contains the model number of the biometric unit. The string can contain up to 256 Unicode characters including a terminating NULL character.

SerialNumber

A NULL-terminated Unicode string that contains the serial number of the biometric unit. The string can contain up to 256 Unicode characters including a terminating NULL character.

FirmwareVersion

A WINBIO_VERSION structure that contains the major and minor version numbers for the biometric unit.

Requirements

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

See also

Client Application Structures

WinBioEnumBiometricUnits