Share via


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
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif DataEventEnroll Indicates the status of enrollment for captured biometrics data.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif DataEventVerify Indicates the status of data verification for captured biometrics data.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif 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)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif ExtendedErrorStatistics  Indicates a specified statistic could not be reset or updated. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif ExtendedErrorStatisticsDependency  (inherited from PosCommon )
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticAverageFalseAcceptRate Indicates the average false acceptance rate.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticAverageFalseRejectRate Indicates the average false rejection rate.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticCommunicationErrorCount  Holds the programmatic name of the Communication Error Count common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticDeviceCategory  Holds the programmatic name of the Device Category common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticFirmwareRevision  Holds the programmatic name of the Firmware Revision common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticHoursPoweredCount  Holds the programmatic name of the Hours Powered On common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticInstallationDate  Holds the programmatic name of the Installation Date common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticInterface  Holds the programmatic name of the Interface common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticManufactureDate  Holds the programmatic name of the Manufacture Date common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticManufacturerName  Holds the programmatic name of the Manufacturer Name common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticMechanicalRevision  Holds the programmatic name of the Mechanical Revision common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticModelName  Holds the programmatic name of the Model Name common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticSerialNumber  Holds the programmatic name of the Serial Number common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticSuccessfulMatchCount Increments the number when a match is completed successfully.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticUnifiedPOSVersion  Holds the programmatic name of the Unified POS Version common statistic. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatisticUnsuccessfulMatchCount Increments the number when a match is completed unsuccessfully.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveAway Indicates that the position was too close.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveBackward Indicates that the position was too far forward.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveCloser Indicates that the position was too far away.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveDown Indicates that the position was too high.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveFaster Indicates that the motion was too slow.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveForward Indicates that the position was too far backward.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveLeft Indicates that the position was too far to the right.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveRight Indicates that the position was too far to the left.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveSlower Indicates that the motion was too fast.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusMoveUp Indicates that the position was too low.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusPowerOff  Indicates that the device’s power is turned off or it is detached from the terminal. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusPowerOffline  Indicates that the device is powered on but is either not ready or unable to respond to requests. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusPowerOffOffline  Indicates that either the device’s power is off or it is offline. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusPowerOnline  Indicates that the device’s power is turned on and it is ready for use. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusRawData Indicates that raw image data is available.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusSensorComplete  
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusSensorDirty Indicates that the sensor is dirty.
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusSensorReady  
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusUnspecifiedReadFailure  
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareComplete  Indicates the update firmware process has completed successfully. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif 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)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif 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)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceOk  Indicates the update firmware process failed. However, the device is still operational. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceUnknown  Indicates the update firmware process failed. The device is in an indeterminate state. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareFailedDeviceUnrecoverable  Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif StatusUpdateFirmwareProgress  Indicates the update firmware process has completed 1 to 100 percent successfully. (inherited from PosCommon)
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif UseDefault  
Bb411810.pubfield(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif 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
Bb411810.pubproperty(en-US,WinEmbedded.11).gif Algorithm Gets or sets the biometric algorithm that is used for generating the biometrics template.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif AlgorithmList Gets the list of algorithms that are supported by the Biometrics device.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif AutoDisable Gets or sets a Boolean value that indicates whether the device is disabled after data is received.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif BiometricsInformationRecord Gets the biometric enrollment data that is returned to the application.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif 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)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapPowerReporting  Gets the power reporting capabilities of the device. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapPrematchData Gets a Boolean value that indicates whether the server can use Match-On-Card SmartCard technology to generate a processed BiometricsInformationRecord.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapRawSensorData Gets a Boolean value that indicates whether the service may return unprocessed data from the biometrics sensor.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapRealTimeData Gets a Boolean value that indicates whether the biometrics device may supply unprocessed biometrics data as it is captured.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapSensorColor Gets a value or combination of values that indicates whether the biometrics device supports image formats other than bi-tonal.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapSensorOrientation Gets a value that indicates whether the sensor image should be rotated before processing, and to what degree.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapSensorType Gets a value that indicates the type of biometric data that the sensor records.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapStatisticsReporting  Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapTemplateAdaptation Gets a Boolean value that indicates whether an adapted Biometrics Information Record can be returned by the service.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CapUpdateFirmware  Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif 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)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif CheckHealthText  Gets a string that indicates the health of the device. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif Claimed  Gets a Boolean value that indicates whether the device is claimed for exclusive access. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif Compatibility  Gets the compatibility level of a device. (inherited from PosDevice)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif DataCount Gets the number of currently queued DataEvent events.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif DataEventEnabled Get or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif DeviceDescription  Gets a string identifying the device and the company that manufactured it. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif DeviceEnabled  Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif DeviceName  Gets a short string identifying the device and any pertinent information about it. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif FreezeEvents  Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif PowerNotify  Gets or sets the type of power notification selection made by the application. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif PowerState  Gets the current power condition. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif RawSensorData Gets an unprocessed biometrics image as raw pixel data.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif RealTimeDataEnabled Gets or sets a Boolean value that indicates whether biometrics data is queued as it is captured.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif SensorColor Gets or sets which image capture mode will be applied to new biometrics data.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif SensorOrientation Gets or sets the requested orientation adjustment to the received sensor data before BiometricsInformationRecord creation.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif SensorType Gets or sets the type of biometrics sensor being accessed.
Bb411810.pubproperty(en-US,WinEmbedded.11).gif ServiceObjectDescription  Gets a string identifying the Service Object that supports the device and the company that produced it. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif ServiceObjectVersion  Gets the Service Object version number. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif State  Gets the current state of the device. (inherited from PosCommon)
Bb411810.pubproperty(en-US,WinEmbedded.11).gif 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
Bb411810.protproperty(en-US,WinEmbedded.11).gif DeviceInstanceId  (inherited from PosCommon )
Bb411810.protproperty(en-US,WinEmbedded.11).gif DevicePath  Gets or sets the hardware path of a device. (inherited from PosCommon)
Bb411810.protproperty(en-US,WinEmbedded.11).gif HardwareId  (inherited from PosCommon )
Bb411810.protproperty(en-US,WinEmbedded.11).gif IsExclusiveUseDevice Overridden. Gets a Boolean value that indicates whether Biometrics is an exclusive-use device.

Top

Public Methods

(see also Protected Methods )

  Name Description
Bb411810.pubmethod(en-US,WinEmbedded.11).gif BeginEnrollCapture Begins capturing biometrics data for enrollment.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif BeginVerifyCapture Begins capturing biometrics data for verification.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif CheckHealth  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Claim  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif ClearInput Clears all buffered device input.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif ClearInputProperties Resets the values of properties altered by DataEvent or ErrorEvent.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Close  Releases the device and its resources. (inherited from PosCommon)
Bb411810.pubmethod(en-US,WinEmbedded.11).gif CompareFirmwareVersion  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif DirectIO  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif EndCapture Ends the capturing of biometrics data.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Equals  Overloaded. (inherited from Object )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif GetHashCode  (inherited from Object )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif GetType  (inherited from Object )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Identify Captures biometrics data, compares it to an array of BiometricsInformationRecords, and then returns a rank ordered array of indexes.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif 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.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Open  Opens a device for later input/output processing. (inherited from PosCommon)
Bb411810.pubmethod(en-US,WinEmbedded.11).gif ProcessPrematchData Creates biometric samples for use by Match-On-Card and enabled Match-On-Card implementations that require prematch data before matching operations.
Bb411810.pubmethod(en-US,WinEmbedded.11).gifBb411810.static(en-US,WinEmbedded.11).gif ReferenceEquals  (inherited from Object )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Release  Releases exclusive access to the device. (inherited from PosCommon)
Bb411810.pubmethod(en-US,WinEmbedded.11).gif ResetStatistic  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif ResetStatistics  Overloaded. (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif RetrieveStatistic  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif RetrieveStatistics  Overloaded. (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif ToString  (inherited from Object )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif UpdateFirmware  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif UpdateStatistic  (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif UpdateStatistics  Overloaded. (inherited from PosCommon )
Bb411810.pubmethod(en-US,WinEmbedded.11).gif Verify Captures biometrics data and compares it against a designated Biometrics Information Record.
Bb411810.pubmethod(en-US,WinEmbedded.11).gif VerifyMatch Indicates the event type for DataEvent events.

Top

Protected Methods

  Name Description
Bb411810.protmethod(en-US,WinEmbedded.11).gif DeleteConfigurationProperty  (inherited from PosCommon )
Bb411810.protmethod(en-US,WinEmbedded.11).gif Finalize  (inherited from Object )
Bb411810.protmethod(en-US,WinEmbedded.11).gif GetConfigurationProperty  (inherited from PosCommon )
Bb411810.protmethod(en-US,WinEmbedded.11).gif Invoke  (inherited from PosCommon )
Bb411810.protmethod(en-US,WinEmbedded.11).gif MemberwiseClone  (inherited from Object )
Bb411810.protmethod(en-US,WinEmbedded.11).gif SetConfigurationProperty  (inherited from PosCommon )

Top

Public Events

(see also Protected Events )

  Name Description
Bb411810.pubevent(en-US,WinEmbedded.11).gif DataEvent Notifies the application that input data is available.
Bb411810.pubevent(en-US,WinEmbedded.11).gif DirectIOEvent  Raised by the Service Object to communicate information directly to the application. (inherited from PosCommon)
Bb411810.pubevent(en-US,WinEmbedded.11).gif 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.
Bb411810.pubevent(en-US,WinEmbedded.11).gif StatusUpdateEvent  Raised by the Service Object to alert the application of a device status change. (inherited from PosCommon)

Top

Protected Events

  Name Description
Bb411810.protevent(en-US,WinEmbedded.11).gif DeviceAddedEvent  (inherited from PosCommon )
Bb411810.protevent(en-US,WinEmbedded.11).gif DeviceRemovedEvent  (inherited from PosCommon )

Top

See Also

Reference

Biometrics Class
Microsoft.PointOfService Namespace