opensc/doc/api/card/sc_unlock.xml

41 lines
897 B
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scunlock">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_unlock</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_unlock</refname>
<refpurpose>Unlock a card</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_unlock(struct sc_card *card);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function unlocks <emphasis>card</emphasis>. That is, the lock count is decreased, and the
card unlocked if it reaches zero.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns 0 if successful, or a negative value in case of error.
</para>
</refsect1>
</refentry>