WINBIO_BIR_HEADER structure (winbio_types.h)

The WINBIO_BIR_HEADER structure contains the Common Biometric Exchange File Format (CBEFF) Patron Format A information that describes the rest of the BIR.

Syntax

typedef struct _WINBIO_BIR_HEADER {
  USHORT                   ValidFields;
  WINBIO_BIR_VERSION       HeaderVersion;
  WINBIO_BIR_VERSION       PatronHeaderVersion;
  WINBIO_BIR_DATA_FLAGS    DataFlags;
  WINBIO_BIOMETRIC_TYPE    Type;
  WINBIO_BIOMETRIC_SUBTYPE Subtype;
  WINBIO_BIR_PURPOSE       Purpose;
  WINBIO_BIR_QUALITY       DataQuality;
  LARGE_INTEGER            CreationDate;
  struct {
    LARGE_INTEGER BeginDate;
    LARGE_INTEGER EndDate;
  } ValidityPeriod;
  WINBIO_REGISTERED_FORMAT BiometricDataFormat;
  WINBIO_REGISTERED_FORMAT ProductId;
} WINBIO_BIR_HEADER;

Members

ValidFields

A Patron Format A bitmask that indicates which CBEFF optional fields are present in the BIR. For more information about all members of WINBIO_BIR_HEADER, follow the link in the Remarks section to the NISTIR 6529-A Specification.

HeaderVersion

A structure of type WINBIO_BIR_VERSION that specifies the CBEFF header version.

Versions are represented as 8-bit values of the form: 0xNM, where N is the major version and M is the minor version.

typedef UCHAR WINBIO_BIR_VERSION, *PWINBIO_BIR_VERSION;

PatronHeaderVersion

A structure of type WINBIO_BIR_VERSION that specifies PATRON_HEADER_VERSION.

DataFlags

A structure of type WINBIO_BIR_DATA_FLAGS that specifies the level of processing expected for a data capture.

Type

A structure of type WINBIO_BIOMETRIC_TYPE that specifies the biometric type.

Subtype

A structure of type WINBIO_BIOMETRIC_SENSOR_SUBTYPE that specifies the biometric subtype.

Purpose

A structure of type WINBIO_BIR_PURPOSE that specifies the intended use of the data.

DataQuality

A structure of type WINBIO_BIR_QUALITY that specifies the biometric data quality. Quality measurements are represented as signed integers in the range 0-100, except:

-1 Quality measurements are supported by the BIR creator, but no value is set in the BIR.

-2 Quality measurements are not supported by the BIR creator.

typedef CHAR WINBIO_BIR_QUALITY, *PWINBIO_BIR_QUALITY;

CreationDate

Specifies the creation date and time of this BIR in UTC by using the format YYYYMMDDhhmmss.

ValidityPeriod

Specifies the validity period of this BIR by using the format described in CreationDate.

ValidityPeriod.BeginDate

ValidityPeriod.EndDate

BiometricDataFormat

A structure of type WINBIO_REGISTERED_FORMAT that specifies the data format of the StandardDataBlock for this WINBIO_BIR.

ProductId

A structure of type WINBIO_REGISTERED_FORMAT that specifies the product identifier for the component that generated the StandardDataBlock for this WINBIO_BIR.

Remarks

You can find more information about the fields of the standard biometric header in the NISTIR 6529-A Specification.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 7 and later versions of Windows.
Header	winbio_types.h

See also

WINBIO_BIR

WINBIO_BIR_DATA