opensc/doc/api/init/sc_detect_card_presence.xml

44 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scdetectcardpresence">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_detect_card_presence</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_detect_card_presence</refname>
<refpurpose>Detect presence of smart card in a reader</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_detect_card_presence(sc_reader_t *reader, int slot_id);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function checks whether <emphasis>reader</emphasis> has a card present in
<emphasis>slot_id</emphasis>.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
If an error occurred, the return value is a a negative OpenSC error code. If no card is present, 0
is returned. Otherwise, a positive value is returned, which is a combination of flags. The flag
SC_SLOT_CARD_PRESENT is always set. In addition, if the card was exchanged, the
SC_SLOT_CARD_CHANGED flag is set.
</para>
</refsect1>
</refentry>