Sindbad~EG File Manager
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Copyright (c) 2019 Yubico AB. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SPDX-License-Identifier: BSD-2-Clause
-->
<head>
<meta charset="utf-8"/>
<link rel="stylesheet" href="style.css" type="text/css" media="all"/>
<title>FIDO_BIO_ENROLL_NEW(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_BIO_ENROLL_NEW(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_BIO_ENROLL_NEW(3)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<code class="Nm">fido_bio_enroll_new</code>,
<code class="Nm">fido_bio_enroll_free</code>,
<code class="Nm">fido_bio_enroll_last_status</code>,
<code class="Nm">fido_bio_enroll_remaining_samples</code> —
<div class="Nd">FIDO2 biometric enrollment API</div>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<code class="In">#include <<a class="In">fido.h</a>></code>
<br/>
<code class="In">#include <<a class="In">fido/bio.h</a>></code>
<div class="Bd Pp">
<pre>
#define FIDO_BIO_ENROLL_FP_GOOD 0x00
#define FIDO_BIO_ENROLL_FP_TOO_HIGH 0x01
#define FIDO_BIO_ENROLL_FP_TOO_LOW 0x02
#define FIDO_BIO_ENROLL_FP_TOO_LEFT 0x03
#define FIDO_BIO_ENROLL_FP_TOO_RIGHT 0x04
#define FIDO_BIO_ENROLL_FP_TOO_FAST 0x05
#define FIDO_BIO_ENROLL_FP_TOO_SLOW 0x06
#define FIDO_BIO_ENROLL_FP_POOR_QUALITY 0x07
#define FIDO_BIO_ENROLL_FP_TOO_SKEWED 0x08
#define FIDO_BIO_ENROLL_FP_TOO_SHORT 0x09
#define FIDO_BIO_ENROLL_FP_MERGE_FAILURE 0x0a
#define FIDO_BIO_ENROLL_FP_EXISTS 0x0b
#define FIDO_BIO_ENROLL_FP_DATABASE_FULL 0x0c
#define FIDO_BIO_ENROLL_NO_USER_ACTIVITY 0x0d
#define FIDO_BIO_ENROLL_NO_USER_PRESENCE_TRANSITION 0x0e
</pre>
</div>
<br/>
<var class="Ft">fido_bio_enroll_t *</var>
<br/>
<code class="Fn">fido_bio_enroll_new</code>(<var class="Fa" style="white-space: nowrap;">void</var>);
<p class="Pp"><var class="Ft">void</var>
<br/>
<code class="Fn">fido_bio_enroll_free</code>(<var class="Fa" style="white-space: nowrap;">fido_bio_enroll_t
**enroll_p</var>);</p>
<p class="Pp"><var class="Ft">uint8_t</var>
<br/>
<code class="Fn">fido_bio_enroll_last_status</code>(<var class="Fa" style="white-space: nowrap;">const
fido_bio_enroll_t *enroll</var>);</p>
<p class="Pp"><var class="Ft">uint8_t</var>
<br/>
<code class="Fn">fido_bio_enroll_remaining_samples</code>(<var class="Fa" style="white-space: nowrap;">const
fido_bio_enroll_t *enroll</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
Ongoing FIDO2 biometric enrollments are abstracted in <i class="Em">libfido2</i>
by the <var class="Vt">fido_bio_enroll_t</var> type.
<p class="Pp">The functions described in this page allow a
<var class="Vt">fido_bio_enroll_t</var> type to be allocated, deallocated,
and inspected. For device operations on
<var class="Vt">fido_bio_enroll_t</var>, please refer to
<a class="Xr" href="fido_bio_dev_get_info.html">fido_bio_dev_get_info(3)</a>.</p>
<p class="Pp">The <code class="Fn">fido_bio_enroll_new</code>() function returns
a pointer to a newly allocated, empty
<var class="Vt">fido_bio_enroll_t</var> type. If memory cannot be allocated,
NULL is returned.</p>
<p class="Pp">The <code class="Fn">fido_bio_enroll_free</code>() function
releases the memory backing <var class="Fa">*enroll_p</var>, where
<var class="Fa">*enroll_p</var> must have been previously allocated by
<code class="Fn">fido_bio_enroll_new</code>(). On return,
<var class="Fa">*enroll_p</var> is set to NULL. Either
<var class="Fa">enroll_p</var> or <var class="Fa">*enroll_p</var> may be
NULL, in which case <code class="Fn">fido_bio_enroll_free</code>() is a
NOP.</p>
<p class="Pp">The <code class="Fn">fido_bio_enroll_last_status</code>() function
returns the enrollment status of <var class="Fa">enroll</var>.</p>
<p class="Pp">The <code class="Fn">fido_bio_enroll_remaining_samples</code>()
function returns the number of samples left for <var class="Fa">enroll</var>
to complete.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<a class="Xr" href="fido_bio_dev_get_info.html">fido_bio_dev_get_info(3)</a>,
<a class="Xr" href="fido_bio_template.html">fido_bio_template(3)</a>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">September 13, 2019</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists