De Serialize

DeSerialize (byte[])
Deserializes a data object returned by the Serialize method.

Syntax
public void DeSerialize(
byte[] ArrayOfBytes
)
Parameters
Exceptions
Serialize(Stream)
Serializes a data object to a stream.
Syntax
public Stream Serialize(Stream DataStream)
Parameter
ArrayOfBytes Array of bytes that receives and returns a serialized data object
DPFP.Error.ErrorCodes Message Reason
Internal Bad Serialization Serialization failed, probably due to memory limitations
or bad arguments.
ArrayOfBytes Array of bytes that contains a deserialized data object
Internal Bad DeSerialization Deserialization failed, probably due to memory
limitations or bad arguments.
DataStream Data stream
Chapter 5: API Reference DPFP.Data Class
DigitalPersona One Touch for Windows SDK: .NET Edition | Developer Guide 40
Exception
DeSerialize(Stream)
Deserializes a data object returned by the Serialize method.
Syntax
public Stream DeSerialize(Stream DataStream)
Parameter
Exception
Public Properties
Bytes
Returns embedded raw data.
Syntax
public byte[] Bytes
Parameter
This property is read-only.
Size
Returns the size of the embedded raw data, in bytes.
Internal Bad Serialization Serialization failed, probably due to memory limitations
or bad arguments.
DataStream Data stream
Bytes Array of bytes that receives the embedded raw data
Chapter 5: API Reference DPFP.FeatureSet Class
Syntax
public int Size
Parameter
DPFP.FeatureSet Class
Represents a fingerprint feature set. The DPFP.FeatureSet object is supplied in the FeatureSet
parameter of the CreateFeatureSet method (page 83) and by the OnComplete event of the
fingerprint verification control event handler (page 82).
NOTE: The DPFP.FeatureSet class inherits all public methods and properties from the
DPFP.Data
class.
Public Constructors
FeatureSet()
Constructs a DPFP.FeatureSet object.
Syntax
public FeatureSet()
FeatureSet(Stream)
Constructs a DPFP.FeatureSet object from a given stream.
Syntax
public FeatureSet(Stream DataStream)
Parameter
Size Int that receives the size of the embedded raw data, in bytes
DataStream Data stream to deserialize
Chapter 5: API Reference DPFP.Sample Class
Exception
DPFP.Sample Class
Represents a fingerprint sample captured from a fingerprint reader. The DPFP.Sample object is
supplied by
the OnComplete event of the fingerprint sample capture operation event handler (page 65).
NOTE: The DPFP.Sample class inherits all public methods and properties from the DPFP.Data
class.
Public Constructors
Sample()
Constructs a DPFP.Sample object.
Syntax
public Sample()
Sample(Stream)
Constructs a DPFP.Sample object from a given stream.
Syntax
public Sample(Stream DataStream)
Parameter
Exception
Chapter 5: API Reference DPFP.Template Class
DPFP.Template Class
Represents a fingerprint template. The DPFP.Template object is supplied by the Template
property
(page 87) and by the OnEnroll event of the fingerprint enrollment control event handler (page 75).
NOTE: The DPFP.Template class inherits all public methods and properties from the DPFP.Data
class.
Public Constructors
Template()
Constructs a DPFP.Template object.
Syntax
public Template()
Template(Stream)
Constructs a DPFP.Template object from a given stream.
Syntax
public Template(Stream DataStream)
Parameter
Exception
DPFP.Error.SDKException Class
Provides SDK-specific exceptions.
Public Property
ErrorCode
Returns an embedded error code.
Chapter 5: API Reference DPFP.Error.SDKException Class
Syntax
public ErrorCodes ErrorCode
Possible Values
Public Enumeration
ErrorCodes
Defines the error codes returned by the SDKException class.
Syntax
public enum ErrorCodes
{
Success = 0,
NotInitialized = -1,
InvalidParameter = -2,
NotImplemented = -3,
IO = -4,
NoMemory = -7,
Internal = -8,
BadSetting = -9,
UnknownDevice = -10,
InvalidBuffer = -11,
FeatureSetTooShort = -16,
InvalidContext = -17,
InvalidFeatureSetType = -29,
InvalidFeatureSet = -32,
Unknown = -33
}
Members
ErrorCode Enumeration that receives one of the values from DPFP.Error.ErrorCodes
Success The function succeeded.
NotInitialized Some Engine components are missing or inaccessible.
InvalidParameter One or more parameters are not valid.
IO A generic I/O file error occurred.
NoMemory There is not enough memory to perform the action.
Chapter 5: API Reference Library
Remarks
The members of this enumeration are used by the DPFP.Error.ErrorCode property (page 43).
Library
DPFPShrNet.dll
Internal An unknown internal error occurred.
BadSetting Initialization settings are corrupted.
UnknownDevice The requested device is not known.
InvalidBuffer A buffer is not valid.
FeatureSetTooShort The specified fingerprint feature set or fingerprint template buffer size
is too small.
InvalidContext The given context is not valid.
InvalidFeatureSetType The feature set purpose is not valid.
InvalidFeatureSet Decrypted fingerprint features are not valid. Decryption may have
failed.
Unknown An unknown exception occurred.
Chapter 5: API Reference Capture Component
Capture Component
The capture component is wrapped within the DPFP.Capture namespace. The members of this
component
􀂄 Capture fingerprint samples from fingerprint readers
􀂄 Fire events from fingerprint readers
􀂄 Provide information about the fingerprint readers connected to a system
􀂄 Convert a fingerprint sample to an image
DPFP.Capture.Capture Class
Captures a fingerprint sample from a particular fingerprint reader or from all of the fingerprint
readers
connected to a system and may specify the priority for the capture operation.
Public Constructors
Capture(String, Priority)
Initializes a new instance of the Capture class for capturing a fingerprint sample from a particular
fingerprint reader using its serial number and specifies any valid value for the priority of the capture
operation.
Syntax
public Capture(String ReaderSerialNumber, Priority CapturePriority)
Parameters
Exception
ReaderSerialNumber String that contains a fingerprint reader serial number
CapturePriority Enumeration that specifies one of the values from DPFP.Capture.
Priority (page 64)
NotInitialized Failed to initialize The SDK failed to initialize properly, possibly due to
misconfiguration, incompatible binaries, or security/
memory limitations.
Chapter 5: API Reference DPFP.Capture.Capture Class
Capture(String)
Initializes a new instance of the Capture class for capturing a fingerprint sample from a particular
fingerprint reader using its serial number and assigns Normal priority to the capture operation.
Syntax
public Capture(String ReaderSerialNumber)
Parameter
Exception
Capture(Priority)
Initializes a new instance of the Capture class for capturing a fingerprint sample from all of the
fingerprint
readers connected to a system and specifies any valid value for the priority of the capture operation.
Syntax
public Capture(Priority CapturePriority)
Parameter
Exception
NotInitialized Failed to initialize The SDK failed to initialize properly possibly due to
memory limitations.
CapturePriority Enumeration that specifies one of the values from DPFP.Capture.
Priority (page 64)
memory limitations.
Capture()
Initializes a new instance of the Capture class for capturing a fingerprint sample from any of the
fingerprint
readers connected to a system and assigns Normal priority to the capture operation.
Syntax
public Capture()
Exception
Public Methods
StartCapture()
Begins capturing a fingerprint sample from a fingerprint reader. A call to this method is
asynchronous and
returns immediately. If a fingerprint sample capture operation event handler was loaded through the
EventHandler property, the application receives events from the fingerprint reader (page 50).
Every call to
the StartCapture() method must be paired with a call to the StopCapture() method.
Syntax
public void StartCapture()
Exception
memory limitations.
memory limitations.
UnknownDevice Failed to access the reader The specified reader ID is either not valid or does not
exist.
Internal Failed to create acquisition The fingerprint sample capture operation failed to
initialize.
Internal Failed to start acquisition The fingerprint sample capture operation failed to start.
StopCapture()
Stops the fingerprint sample capture operation started with a call to the StartCapture() method.
Syntax
public void StopCapture()
Exception
Public Properties
Priority
Returns a value that specifies the priority of a fingerprint sample capture operation.
Syntax
public Priority Priority
Possible Values
This property is read-only and may also be set through construction.
ReaderSerialNumber
Returns the serial number of a fingerprint reader that captures a fingerprint sample.
Syntax
public string ReaderSerialNumber
Possible Values
This property is read-only and may also be set through construction.
memory limitations.
Priority Enumeration that receives one of the values from DPFP.Capture.Priority
(page 64)
ReaderSerialNumber String that receives a fingerprint reader serial number
Chapter 5: API Reference DPFP.Capture.ReaderDescription Class
EventHandler
Loads a fingerprint sample capture operation event handler. Set this property to null to clear all
registered
event handlers.
IMPORTANT: At least one event handler should be loaded to receive events.
Syntax
public EventHandler EventHandler
Possible Values
This property is write-only.
DPFP.Capture.ReaderDescription Class
Provides information about a particular fingerprint reader, such as its technology or serial number.
Public Constructors
ReaderDescription(Guid)
Initializes a new instance of the ReaderDescription class using a fingerprint reader’s device GUID.
Syntax
public ReaderDescription(Guid DeviceGUID)
Parameter
Exception
EventHandler A DPFP.Capture.EventHandler object (page 65)
DeviceGUID Variable that contains a fingerprint reader device GUID
memory limitations.
exist.
ReaderDescription(String)
Initializes a new instance of the ReaderDescription class using a fingerprint reader’s serial
number.
Syntax
public ReaderDescription(String ReaderSerialNumber)
Parameter
Exceptions
Public Properties
FirmwareRevision
Returns the firmware revision number of a fingerprint reader.
Syntax
public ReaderVersion FirmwareVersion
Possible Values
NotInitialized Failed to initialize The SDK failed to initialize properly, possible due to
memory limitations.
InvalidParameter Invalid index or serial
number
The format of the specified serial number is not valid.
UnknownDevice Failed to access the device The specified reader ID is either not valid or does not
exist.
FirmwareRevision Variable that receives a fingerprint reader firmware revision number
HardwareRevision
Returns the hardware revision number of a fingerprint reader.
Syntax
public ReaderVersion HardwareVersion
Possible Values
Language
Returns the fingerprint reader language.
Syntax
public uint Language
Possible Values
ImpressionType
Returns a value that specifies the fingerprint reader impression type, for example, swipe reader or
touch (area)
reader.
Syntax
public ReaderImpressionType ImpressionType
Possible Values
HardwareVersion Variable that receives a fingerprint reader hardware revision number
Language Uint the receives the fingerprint reader language. The value of Language is
always 0x409, which is English.
ImpressionType Enumeration that receives one of the values from DPFP.Capture.
ReaderImpressionType (page 54)
ProductName
Returns the product name of a fingerprint reader, for example, “U.are.U.”
Syntax
public String ProductName
Possible Values
SerialNumber
Returns the serial number of a fingerprint reader.
Syntax
public String SerialNumber
Possible Values
SerialNumberType
Returns a value that specifies the type of fingerprint reader serial number.
Syntax
public ReaderSerialNumberType SerialNumberType
Possible Values
ProductName String that receives the fingerprint reader product name
SerialNumber String the receives the fingerprint reader serial number
SerialNumberType Enumeration that receives one of the values from DPFP.Capture.
SerialNumberType (page 56)
Technology
Returns a value that specifies the fingerprint reader technology.
Syntax
public ReaderTechnology Technology
Possible Values
Vendor
Returns the vendor name for a fingerprint reader, for example, “DigitalPersona, Inc.”
Syntax
public String Vendor
Possible Values
Public Enumerations
ReaderImpressionType
Defines the modality that a fingerprint reader uses to capture fingerprint samples.
Syntax
public enum ReaderImpressionType
{
Unknown = 0,
Swipe,
Area
};
Technology Enumeration that receives one of the values from DPFP.Capture.
ReaderTechnology (page 55)
Vendor String the receives the fingerprint reader vendor name
Members
Remarks
The members of this enumeration are used by the DPFP.Capture.Capture.ImpressionType
property (page 52).
ReaderTechnology
Defines the fingerprint reader technology.
Syntax
public enum ReaderTechnology
{
Unknown = 0,
Optical,
Capacitive,
Thermal,
Pressure
};
Members
Remarks
The members of this enumeration are used by the DPFP.Capture.Capture.Technology property
(page 54).
Unknown A fingerprint reader for which the modality is not known.
Swipe A swipe fingerprint reader.
Area An area (touch) sensor fingerprint reader.
Unknown A fingerprint reader for which the technology is not known.
Optical An optical fingerprint reader.
Capacitive A capacitive fingerprint reader.
Thermal A thermal fingerprint reader.
Pressure A pressure fingerprint reader.
Chapter 5: API Reference DPFP.Capture.ReadersCollection Class
SerialNumberType
Defines whether a fingerprint reader serial number persists after reboot.
Syntax
public enum ReaderSerialNumberType
{
Persistent = 0,
Volatile
};
Members
Remarks
The members of this enumeration are used by the DPFP.Capture.Capture.SerialNumberType
property (page 53).
DPFP.Capture.ReadersCollection Class
Provides information about all of the fingerprint readers connected to a system.
Public Constructor
ReadersCollection()
Initializes a new instance of the ReadersCollection class for enumerating all of the fingerprint
readers
connected to a system.
Syntax
public ReadersCollection()
Persistent A persistent serial number provided by the hardware.
Volatile A volatile serial number provided by the software.
Exceptions
Public Method
Refresh()
Clears and re-enumerates a ReadersCollection object.
Syntax
public void Refresh()
Exceptions
Public Indexers
ReaderDescription this[Guid]
Returns a specific ReaderDescription object using its device GUID.
Syntax
public ReaderDescription this[Guid ReaderSerialNumber]
Parameter
memory limitations.
Internal Failed to enumerate
readers
The device enumeration failed.
memory limitations.
Internal Failed to enumerate
readers
The device enumeration failed.
ReaderSerialNumber Variable that contains a fingerprint reader device GUID
Exception
ReaderDescription this[int]
Returns a specific fingerprint reader using its index.
Syntax
public ReaderDescription this[int Index]
Parameter
Exception
ReaderDescription this[string]
Returns a specific fingerprint reader using its serial number.
Syntax
public ReaderDescription this[string ReaderSerialNumber]
Parameter
exist.
Index Int that contains a fingerprint reader index
number
The specified index is not within the valid range.
Chapter 5: API Reference DPFP.Capture.ReaderVersion Class
Exceptions
DPFP.Capture.ReaderVersion Class
Represents information about the fingerprint reader version.
Public Constructor
ReaderVersion(uint, uint, uint)
Initializes a new instance of the ReaderVersion class for providing the structure of the fingerprint
reader
version number.
Syntax
public ReaderVersion(uint Build, uint Major, uint Minor)
Parameters
Public Method
ToString()
Converts a DPFP.Capture.ReaderVersion object to a string representation.
Syntax
public string ToString()
Parameters
number
The format of the specified serial number is not valid.
UnknownDevice Failed to access the device The specified reader ID is either not valid or does not
exist.
Build Uint that contains a build number
Major Uint that contains a major number
Minor Uint that contains a minor number
ToString String that contains a version number
Chapter 5: API Reference DPFP.Capture.ReaderVersion Class
Public Properties
Build
Returns the build number of the fingerprint reader version.
Syntax
public uint Build
Possible Values
Major
Returns the major number of the fingerprint reader version.
Syntax
public uint Major
Possible Values
Minor
Returns the minor number of the fingerprint reader version.
Syntax
public uint Major
Possible Values
Build Uint that receives the build number
Major Uint that receives the major number
Minor Uint that receives the minor number
Chapter 5: API Reference DPFP.Capture.SampleConversion Class
DPFP.Capture.SampleConversion Class
Provides methods for converting a fingerprint sample to an image in either bitmap image file format
or ANSI
381 format.
Public Constructor
SampleConversion()
Initializes a new instance of the SampleConversion class for converting a fingerprint sample to an
image.
Syntax
public SampleConversion()
Exceptions
Public Methods
ConvertToANSI381(Sample, ref byte[])
Converts a fingerprint sample to an image in ANSI 381 format.
Syntax
public byte[] ConvertToANSI381(
Sample Sample,
ref byte[] ANSI
)
Parameters
Return Value
Returns an array of bytes that receives and contains an image in ANSI 381 format.
memory limitations.
Sample A DPFP.Sample object (page 42)
ANSI Array of bytes that receives and contains an image in ANSI 381 format
Chapter 5: API Reference DPFP.Capture.SampleConversion Class
Exceptions
ConvertToPicture(Sample, ref Bitmap)
Converts a fingerprint sample to bitmap image file format.
Syntax
public Bitmap ConvertToPicture(
Sample Sample,
ref Bitmap Bitmap
)
Parameters
Return Value
Returns a bitmap that receives and contains an image in bitmap file format.
Exceptions
InvalidParameter Invalid Parameter The arguments provided for this function are either null
or contain no valid data.
Internal Failed to export ANSI 381
image
The conversion to ANSI 381 format failed.
Bitmap Variable that receives and contains an image in bitmap file format and scales the
image to a specified bitmap size, if provided
InvalidParameter Invalid Parameter The arguments provided for this function are either null
or contain no valid data.
Internal Failed to export ANSI 381
image
The conversion to bitmap image file format failed.
Chapter 5: API Reference DPFP.Capture.CaptureFeedback Enumeration
DPFP.Capture.CaptureFeedback Enumeration
Defines the values that provide feedback about a fingerprint sample capture operation.
Syntax
public enum CaptureFeedback
{
Good = 0,
None,
TooLight,
TooDark,
TooNoisy,
LowContrast,
NotEnoughFeatures,
NoCentralRegion,
NoFinger,
TooHigh,
TooLow,
TooLeft,
TooRight,
TooStrange,
TooFast,
TooSkewed,
TooShort,
TooSlow,
TooSmall
}
Members
Good The fingerprint sample is of decent quality.
None The fingerprint sample is missing, or was not received.
TooLight The fingerprint sample is too light.
TooDark The fingerprint sample is too dark
TooNoisy The fingerprint sample is too noisy.
LowContrast The fingerprint sample contrast is too low.
NotEnoughFeatures The fingerprint sample does not contain enough information.
NoCentralRegion The fingerprint sample is not centered.
Chapter 5: API Reference DPFP.Capture.Priority Enumeration
Remarks
The members of this enumeration are used by the DPFP.Processing.CreateFeatureSet method
(page 83) and by the OnSampleQuality event of the fingerprint sample capture event handler
(page 68).
DPFP.Capture.Priority Enumeration
Defines the priority of a fingerprint sample capture operation performed by a fingerprint reader.
Syntax
public enum Priority
{
Low = 0,
Normal,
High
};
NoFinger The scanned object is not a finger.
TooHigh The finger was too high on the swipe sensor.
TooLow The finger was too low on the swipe sensor.
TooLeft The finger was too close to the left border of the swipe sensor.
TooRight The finger was too close to the right border of the swipe sensor.
TooStrange The scan looks strange.
TooFast The finger was swiped too quickly.
TooSkewed The fingerprint sample is too skewed.
TooShort The fingerprint sample is too short.
TooSlow The finger was swiped too slowly.
TooSmall The size of the fingerprint sample is too small.
Chapter 5: API Reference DPFP.Capture.EventHandler Interface
Members
Remarks
The members of this enumeration are used by the DPFP.Capture.Priority property (page 49).
DPFP.Capture.EventHandler Interface
Defines the fingerprint sample capture operation events.
Syntax
public interface EventHandler
{
void OnComplete(Object, String, Sample);
void OnFingerGone(Object, String);
void OnFingerTouch(Object, String);
void OnReaderConnect(Object, String);
void OnReaderDisconnect(Object, String);
void OnSampleQuality(Object, String, CaptureFeedback);
}
Events
OnComplete(Object, String, Sample)
Fires when a fingerprint sample is successfully captured by a fingerprint reader.
Syntax
public void OnComplete(Object Capture,
String ReaderSerialNumber,
Sample Sample);
Low Low priority. An application uses this priority to acquire events from the fingerprint
reader only if there are no subscribers with high or normal priority. Only one subscriber
with this priority is allowed.
Normal Normal priority. An application uses this priority to acquire events from the fingerprint
reader only if the operation runs in a foreground process. Multiple subscribers with this
priority are allowed.
High High priority. (RESERVED. For internal use only.) A subscriber uses this priority to
acquire events from the fingerprint reader exclusively. Only one subscriber with this
priority is allowed. Note that under Windows Vista and later, the subscriber must be
the system account or a member of the Administrators Group
Parameters
OnFingerGone(Object, String)
Fires when a user removes a finger from a fingerprint reader.
Syntax
public void OnFingerGone(
Object Capture,
String ReaderSerialNumber
);
Parameters
OnFingerTouch(Object, String)
Fires when a user touches a fingerprint reader.
Syntax
public void OnFingerTouch(
Object Capture,
);
Capture A DPFP.Capture.Capture object (page 46)
ReaderSerialNumber String that contains the reader ID of the fingerprint reader from which
the fingerprint sample was captured
ReaderSerialNumber If Capture(Priority) or Capture() was used to initialize an
instance of the Capture class, this parameter is a string that contains
an empty reader ID, that is, all zeros.
If Capture(String, Priority) or Capture(String) was
used to initialize an instance of the Capture class, this parameter is a
string that contains the specified fingerprint reader serial number.
Parameters
OnReaderConnect(Object, String)
Fires when a fingerprint reader is attached to a system.
Syntax
public void OnReaderConnect(
Object Capture,
);
Parameters
OnReaderDisconnect(Object, String)
Fires when a fingerprint reader is disconnected from a system.
Syntax
public void OnReaderDisconnect(
Object Capture,
);
Parameters
ReaderSerialNumber If Capture(Priority) or Capture() was used to initialize an
instance of the Capture class, this parameter is a string that contains
an empty reader ID, that is, all zeros.
If Capture(String, Priority) or Capture(String) was
used to initialize an instance of the Capture class, this parameter is a
string that contains the specified fingerprint reader serial number.
Chapter 5: API Reference Libraries
OnSampleQuality(Object, String, CaptureFeedback)
Fires when the quality of a fingerprint sample is verified.
Syntax
public void OnSampleQuality(
Object Capture,
String ReaderSerialNumber,
CaptureFeedback CaptureFeedback
);
Parameters
Libraries
DPFPShrNet.dll for the DPFP.Capture.CaptureFeedback enumeration
DPFPDevNet.dll for all other members of the DPFP.Capture namespace

De Serialize

Uploaded by

Copyright:

Available Formats

De Serialize

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

De Serialize

Uploaded by

Copyright:

Available Formats

DeSerialize (byte[])

Deserializes a data object returned by the Serialize method.

You might also like