opensc/doc/api/init/sc_disconnect_card.xml

48 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scdisconnectcard">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_disconnect_card</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_disconnect_card</refname>
<refpurpose>Disconnect from a smart card</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_disconnect_card(<link linkend="sccardt">sc_card_t</link> *card, int action);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function disconnects from <emphasis>card</emphasis>, and frees the card structure. Any locks made
by the application must be released before calling this function.
</para>
<para>
The <emphasis>action</emphasis> parameter is not used at the moment and should be set to 0.
</para>
<para>
The card is not reset nor powered down after the operation.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>Returns 0 if successful, or a negative value in case of error.</para>
</refsect1>
</refentry>