opensc/doc/api/card/sc_check_sw.xml

50 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scchecksw">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_check_sw</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_check_sw</refname>
<refpurpose>Check return status from a card transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_check_sw(struct sc_card *card, int sw1, int sw2);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function checks the return status as given in <emphasis>sw1</emphasis>
and <emphasis>sw2</emphasis> against the card-specific errors of
<emphasis>card</emphasis>. These are set by <link
linkend="sctransmitapdu">sc_transmit_apdu()</link> in the
<structfield>apdu.sw1</structfield> and <structfield>apdu.sw2</structfield>
fields, respectively.
</para>
<para>
The function should be called after every APDU transmission, to convert the
card's status code to an OpenSC error code.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns 0 if successful, or a negative value in case of error.
</para>
</refsect1>
</refentry>