giomba
/
opensc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Moved sc_wait_for_event() to card ops 

git-svn-id: https://www.opensc-project.org/svnp/opensc/trunk@2214 c6295689-39f2-0310-b995-f0e70906c6a9
This commit is contained in:
bert 2005-03-01 23:02:53 +00:00
parent ca8e74e854
commit ba8e15971f
3 changed files with 73 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/api/card/chapter.xml
View File

@ -11,6 +11,7 @@
<!ENTITY scgetchallenge SYSTEM "sc_get_challenge.xml">
<!ENTITY scgetdata SYSTEM "sc_get_data.xml">
<!ENTITY scputdata SYSTEM "sc_put_data.xml">
<!ENTITY scwaitforevent SYSTEM "sc_wait_for_event.xml">
]>
@ -19,6 +20,7 @@
&sccardctl;
&sclock;
&scunlock;
&scwaitforevent;
&scformatapdu;
&sctransmitapdu;
&scchecksw;

71
doc/src/api/card/sc_wait_for_event.xml Normal file
View File

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scwaitforevent">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_wait_for_event</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_wait_for_event</refname>
<refpurpose>Wait for an event on a smartcard reader</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_wait_for_event(sc_reader_t *readers[], int slots[], size_t numslots,
unsigned int event_mask,
int *reader, unsigned int *event, int timeout);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function blocks until an event occurs on any of the
readers/slots specified. The <emphasis>readers</emphasis> and
<emphasis>slots</emphasis> fields list the readers and the
respective slots to be watched. <emphasis>num_slots</emphasis>
holds the total number of slots passed. The <emphasis>event_mask</emphasis>
parameter specifies the types of events to wait for. This may a
combination of the following flags:
<variablelist>
<varlistentry>
<term><symbol>SC_EVENT_CARD_REMOVED</symbol></term>
<listitem><para>A card was removed from the reader/slot.</para></listitem>
</varlistentry>
<varlistentry>
<term><symbol>SC_EVENT_CARD_INSERTED</symbol></term>
<listitem><para>A card was insert into the reader/slot.</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>
On returning, the <emphasis>reader</emphasis> parameter holds the
reader which generated an event, and <emphasis>event</emphasis> holds
the event flag, as in <emphasis>event_mask</emphasis>.
</para>
<para>
The timeout parameter may be used to specify the maximum amount of
time to wait for an event, in milliseconds. This may be set to -1
to wait forever.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns 0 if successful, 1 if a timeout occurred, or a negative
value in case of error.
</para>
</refsect1>
</refentry>

1
doc/src/api/init/chapter.xml
View File

@ -10,7 +10,6 @@
<!ENTITY scdetectcardpresence SYSTEM "sc_detect_card_presence.xml">
<!ENTITY sccardvalid SYSTEM "sc_card_valid.xml">
<!ENTITY scsetcarddriver SYSTEM "sc_set_card_driver.xml">
<!ENTITY scwaitforevent SYSTEM "sc_wait_for_event.xml">
]>
<chapter>