fp_print_data_get_data ()

size_t
fp_print_data_get_data (struct fp_print_data *data,
                        unsigned char **ret);

Convert a stored print into a unified representation inside a data buffer. You can then store this data buffer in any way that suits you, and load it back at some later time using fp_print_data_from_data().

fp_print_data_from_data ()

struct fp_print_data *
fp_print_data_from_data (unsigned char *buf,
                         size_t buflen);

Load a stored print from a data buffer. The contents of said buffer must be the untouched contents of a buffer previously supplied to you by the fp_print_data_get_data() function.

fp_print_data_save ()

int
fp_print_data_save (struct fp_print_data *data,
                    enum fp_finger finger);

Saves a stored print to disk, assigned to a specific finger. Even though you are limited to storing only the 10 human fingers, this is a per-device-type limit. For example, you can store the users right index finger from a DigitalPersona scanner, and you can also save the right index finger from a UPEK scanner. When you later come to load the print, the right one will be automatically selected.

This function will unconditionally overwrite a fingerprint previously saved for the same finger and device type. The print is saved in a hidden directory beneath the current user's home directory.

fp_print_data_load ()

int
fp_print_data_load (struct fp_dev *dev,
                    enum fp_finger finger,
                    struct fp_print_data **data);

Loads a previously stored print from disk. The print must have been saved earlier using the fp_print_data_save() function.

A return code of -ENOENT indicates that the fingerprint requested could not be found. Other error codes (both positive and negative) are possible for obscure error conditions (e.g. corruption).

fp_print_data_delete ()

int
fp_print_data_delete (struct fp_dev *dev,
                      enum fp_finger finger);

Removes a stored print from disk previously saved with fp_print_data_save().

fp_print_data_from_dscv_print ()

int
fp_print_data_from_dscv_print (struct fp_dscv_print *print,
                               struct fp_print_data **data);

Attempts to load a stored print based on a fp_dscv_print discovered print record.

A return code of -ENOENT indicates that the file referred to by the discovered print could not be found. Other error codes (both positive and negative) are possible for obscure error conditions (e.g. corruption).

fp_print_data_free ()

void
fp_print_data_free (struct fp_print_data *data);

Frees a stored print. Must be called when you are finished using the print.

fp_print_data_get_driver_id ()

uint16_t
fp_print_data_get_driver_id (struct fp_print_data *data);

Gets the driver ID for a stored print. The driver ID indicates which driver the print originally came from. The print is only usable with a device controlled by that driver.

fp_print_data_get_devtype ()

uint32_t
fp_print_data_get_devtype (struct fp_print_data *data);

Gets the devtype for a stored print. The devtype represents which type of device under the parent driver is compatible with the print.

enum fp_finger

Numeric codes used to refer to fingers (and thumbs) of a human. These are purposely not available as strings, to avoid getting the library tangled up in localization efforts.

struct fp_print_data

struct fp_print_data;

fp_print_data is an opaque structure type. You must access it using the functions in this section.