Sindbad~EG File Manager
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Copyright (c) 2020 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_DEV_GET_TOUCH_BEGIN(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_DEV_GET_TOUCH_BEGIN(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_DEV_GET_TOUCH_BEGIN(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_dev_get_touch_begin</code>,
<code class="Nm">fido_dev_get_touch_status</code> —
<div class="Nd">asynchronously wait for touch on a FIDO2 authenticator</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>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_get_touch_begin</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_get_touch_status</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">int *touched</var>,
<var class="Fa" style="white-space: nowrap;">int ms</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The functions described in this page allow an application to asynchronously wait
for touch on a FIDO2 authenticator. This is useful when multiple
authenticators are present and the application needs to know which one to use.
<p class="Pp">The <code class="Fn">fido_dev_get_touch_begin</code>() function
initiates a touch request on <var class="Fa">dev</var>.</p>
<p class="Pp">The <code class="Fn">fido_dev_get_touch_status</code>() function
continues an ongoing touch request on <var class="Fa">dev</var>, blocking up
to <var class="Fa">ms</var> milliseconds. On success,
<var class="Fa">touched</var> will be updated to reflect the touch request
status. If <var class="Fa">touched</var> is 1, the device was touched, and
the touch request is terminated. If <var class="Fa">touched</var> is 0, the
application may call <code class="Fn">fido_dev_get_touch_status</code>() to
continue the touch request, or <code class="Fn">fido_dev_cancel</code>() to
terminate it.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
The error codes returned by <code class="Fn">fido_dev_get_touch_begin</code>()
and <code class="Fn">fido_dev_get_touch_status</code>() are defined in
<code class="In"><<a class="In">fido/err.h</a>></code>. On success,
<code class="Dv">FIDO_OK</code> is returned.
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
Please refer to <i class="Em">examples/select.c</i> in
<i class="Em">libfido2's</i> source tree.
</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_dev_cancel.html">fido_dev_cancel(3)</a>
</section>
<section class="Sh">
<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
The <code class="Fn">fido_dev_get_touch_status</code>() function will cause a
command to be transmitted to U2F authenticators. These transmissions should
not exceed a frequency of 5Hz.
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">August 5, 2020</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists