Biometrics Members (POS for .NET v1.12 SDK Documentation)
2/27/2008
Defines the programmatic interface for a UPOS Biometrics device.
The following tables list the members exposed by the Biometrics type.
Protected Constructors
| Name | Description | |
|---|---|---|
| Biometrics | Creates an instance of the Biometrics class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "Bb411810.pubfield(en-US,WinEmbedded.11).gif") .gif "Bb411810.static(en-US,WinEmbedded.11).gif") |
DataEventEnroll | Indicates the status of enrollment for captured biometrics data. |
|
DataEventVerify | Indicates the status of data verification for captured biometrics data. |
|
ExtendedErrorFirmwareBadFile | Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (inherited from PosCommon) |
|
ExtendedErrorStatistics | Indicates a specified statistic could not be reset or updated. (inherited from PosCommon) |
|
ExtendedErrorStatisticsDependency | (inherited from PosCommon ) |
|
StatisticAverageFalseAcceptRate | Indicates the average false acceptance rate. |
|
StatisticAverageFalseRejectRate | Indicates the average false rejection rate. |
|
StatisticCommunicationErrorCount | Holds the programmatic name of the Communication Error Count common statistic. (inherited from PosCommon) |
|
StatisticDeviceCategory | Holds the programmatic name of the Device Category common statistic. (inherited from PosCommon) |
|
StatisticFirmwareRevision | Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon) |
|
StatisticHoursPoweredCount | Holds the programmatic name of the Hours Powered On common statistic. (inherited from PosCommon) |
|
StatisticInstallationDate | Holds the programmatic name of the Installation Date common statistic. (inherited from PosCommon) |
|
StatisticInterface | Holds the programmatic name of the Interface common statistic. (inherited from PosCommon) |
|
StatisticManufactureDate | Holds the programmatic name of the Manufacture Date common statistic. (inherited from PosCommon) |
|
StatisticManufacturerName | Holds the programmatic name of the Manufacturer Name common statistic. (inherited from PosCommon) |
|
StatisticMechanicalRevision | Holds the programmatic name of the Mechanical Revision common statistic. (inherited from PosCommon) |
|
StatisticModelName | Holds the programmatic name of the Model Name common statistic. (inherited from PosCommon) |
|
StatisticSerialNumber | Holds the programmatic name of the Serial Number common statistic. (inherited from PosCommon) |
|
StatisticSuccessfulMatchCount | Increments the number when a match is completed successfully. |
|
StatisticUnifiedPOSVersion | Holds the programmatic name of the Unified POS Version common statistic. (inherited from PosCommon) |
|
StatisticUnsuccessfulMatchCount | Increments the number when a match is completed unsuccessfully. |
|
StatusMoveAway | Indicates that the position was too close. |
|
StatusMoveBackward | Indicates that the position was too far forward. |
|
StatusMoveCloser | Indicates that the position was too far away. |
|
StatusMoveDown | Indicates that the position was too high. |
|
StatusMoveFaster | Indicates that the motion was too slow. |
|
StatusMoveForward | Indicates that the position was too far backward. |
|
StatusMoveLeft | Indicates that the position was too far to the right. |
|
StatusMoveRight | Indicates that the position was too far to the left. |
|
StatusMoveSlower | Indicates that the motion was too fast. |
|
StatusMoveUp | Indicates that the position was too low. |
|
StatusPowerOff | Indicates that the device’s power is turned off or it is detached from the terminal. (inherited from PosCommon) |
|
StatusPowerOffline | Indicates that the device is powered on but is either not ready or unable to respond to requests. (inherited from PosCommon) |
|
StatusPowerOffOffline | Indicates that either the device’s power is off or it is offline. (inherited from PosCommon) |
|
StatusPowerOnline | Indicates that the device’s power is turned on and it is ready for use. (inherited from PosCommon) |
|
StatusRawData | Indicates that raw image data is available. |
|
StatusSensorComplete | |
|
StatusSensorDirty | Indicates that the sensor is dirty. |
|
StatusSensorReady | |
|
StatusUnspecifiedReadFailure | |
|
StatusUpdateFirmwareComplete | Indicates the update firmware process has completed successfully. (inherited from PosCommon) |
|
StatusUpdateFirmwareCompleteDeviceNotRestored | Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (inherited from PosCommon) |
|
StatusUpdateFirmwareFailedDeviceNeedsFirmware | Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (inherited from PosCommon) |
|
StatusUpdateFirmwareFailedDeviceOk | Indicates the update firmware process failed. However, the device is still operational. (inherited from PosCommon) |
|
StatusUpdateFirmwareFailedDeviceUnknown | Indicates the update firmware process failed. The device is in an indeterminate state. (inherited from PosCommon) |
|
StatusUpdateFirmwareFailedDeviceUnrecoverable | Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (inherited from PosCommon) |
|
StatusUpdateFirmwareProgress | Indicates the update firmware process has completed 1 to 100 percent successfully. (inherited from PosCommon) |
|
UseDefault | |
|
WaitForever | Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (inherited from PosCommon) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "Bb411810.pubproperty(en-US,WinEmbedded.11).gif") |
Algorithm | Gets or sets the biometric algorithm that is used for generating the biometrics template. |
|
AlgorithmList | Gets the list of algorithms that are supported by the Biometrics device. |
|
AutoDisable | Gets or sets a Boolean value that indicates whether the device is disabled after data is received. |
|
BiometricsInformationRecord | Gets the biometric enrollment data that is returned to the application. |
|
CapCompareFirmwareVersion | Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (inherited from PosCommon) |
|
CapPowerReporting | Gets the power reporting capabilities of the device. (inherited from PosCommon) |
|
CapPrematchData | Gets a Boolean value that indicates whether the server can use Match-On-Card SmartCard technology to generate a processed BiometricsInformationRecord. |
|
CapRawSensorData | Gets a Boolean value that indicates whether the service may return unprocessed data from the biometrics sensor. |
|
CapRealTimeData | Gets a Boolean value that indicates whether the biometrics device may supply unprocessed biometrics data as it is captured. |
|
CapSensorColor | Gets a value or combination of values that indicates whether the biometrics device supports image formats other than bi-tonal. |
|
CapSensorOrientation | Gets a value that indicates whether the sensor image should be rotated before processing, and to what degree. |
|
CapSensorType | Gets a value that indicates the type of biometric data that the sensor records. |
|
CapStatisticsReporting | Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon) |
|
CapTemplateAdaptation | Gets a Boolean value that indicates whether an adapted Biometrics Information Record can be returned by the service. |
|
CapUpdateFirmware | Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon) |
|
CapUpdateStatistics | Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (inherited from PosCommon) |
|
CheckHealthText | Gets a string that indicates the health of the device. (inherited from PosCommon) |
|
Claimed | Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon) |
|
Compatibility | Gets the compatibility level of a device. (inherited from PosDevice) |
|
DataCount | Gets the number of currently queued DataEvent events. |
|
DataEventEnabled | Get or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued. |
|
DeviceDescription | Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon) |
|
DeviceEnabled | Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon) |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon) |
|
FreezeEvents | Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon) |
|
PowerNotify | Gets or sets the type of power notification selection made by the application. (inherited from PosCommon) |
|
PowerState | Gets the current power condition. (inherited from PosCommon) |
|
RawSensorData | Gets an unprocessed biometrics image as raw pixel data. |
|
RealTimeDataEnabled | Gets or sets a Boolean value that indicates whether biometrics data is queued as it is captured. |
|
SensorColor | Gets or sets which image capture mode will be applied to new biometrics data. |
|
SensorOrientation | Gets or sets the requested orientation adjustment to the received sensor data before BiometricsInformationRecord creation. |
|
SensorType | Gets or sets the type of biometrics sensor being accessed. |
|
ServiceObjectDescription | Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon) |
|
ServiceObjectVersion | Gets the Service Object version number. (inherited from PosCommon) |
|
State | Gets the current state of the device. (inherited from PosCommon) |
|
SynchronizingObject | Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (inherited from PosCommon) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "Bb411810.protproperty(en-US,WinEmbedded.11).gif") |
DeviceInstanceId | (inherited from PosCommon ) |
|
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) |
|
HardwareId | (inherited from PosCommon ) |
|
IsExclusiveUseDevice | Overridden. Gets a Boolean value that indicates whether Biometrics is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "Bb411810.pubmethod(en-US,WinEmbedded.11).gif") |
BeginEnrollCapture | Begins capturing biometrics data for enrollment. |
|
BeginVerifyCapture | Begins capturing biometrics data for verification. |
|
CheckHealth | (inherited from PosCommon ) |
|
Claim | (inherited from PosCommon ) |
|
ClearInput | Clears all buffered device input. |
|
ClearInputProperties | Resets the values of properties altered by DataEvent or ErrorEvent. |
|
Close | Releases the device and its resources. (inherited from PosCommon) |
|
CompareFirmwareVersion | (inherited from PosCommon ) |
|
DirectIO | (inherited from PosCommon ) |
|
EndCapture | Ends the capturing of biometrics data. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Identify | Captures biometrics data, compares it to an array of BiometricsInformationRecords, and then returns a rank ordered array of indexes. |
|
IdentifyMatch | Compares a sample Biometrics Information Record against the entries of a collection of other Biometrics Information Records, and then returns a rank ordered array of indexes. |
|
Open | Opens a device for later input/output processing. (inherited from PosCommon) |
|
ProcessPrematchData | Creates biometric samples for use by Match-On-Card and enabled Match-On-Card implementations that require prematch data before matching operations. |
|
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PosCommon) |
|
ResetStatistic | (inherited from PosCommon ) |
|
ResetStatistics | Overloaded. (inherited from PosCommon ) |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (inherited from PosCommon ) |
|
ToString | (inherited from Object ) |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
|
Verify | Captures biometrics data and compares it against a designated Biometrics Information Record. |
|
VerifyMatch | Indicates the event type for DataEvent events. |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "Bb411810.protmethod(en-US,WinEmbedded.11).gif") |
DeleteConfigurationProperty | (inherited from PosCommon ) |
|
Finalize | (inherited from Object ) |
|
GetConfigurationProperty | (inherited from PosCommon ) |
|
Invoke | (inherited from PosCommon ) |
|
MemberwiseClone | (inherited from Object ) |
|
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
| Name | Description | |
|---|---|---|
.gif "Bb411810.pubevent(en-US,WinEmbedded.11).gif") |
DataEvent | Notifies the application that input data is available. |
|
DirectIOEvent | Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon) |
|
ErrorEvent | Notifies the application that a Biometrics device error has been detected and that a suitable response by the application is necessary to process the error condition. |
|
StatusUpdateEvent | Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "Bb411810.protevent(en-US,WinEmbedded.11).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top