opensc/doc/api/card/sc_card_ctl.xml

47 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="sccardctl">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_card_ctl</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_card_ctl</refname>
<refpurpose>Send a control command to a card</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_card_ctl(struct sc_card *card, unsigned long cmd, void *args);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>This function is used to send various control commands to the smart card associated with
<emphasis>card</emphasis>. The command is specified in <emphasis>cmd</emphasis>, and any
command-specific arguments are pointed to by <emphasis>args</emphasis>.
</para>
<para>
Commands are specific to cards. For more details on which cards accept which
commands, check the documentation for your card.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns 0 if successful, or a negative value in case of error.
</para>
</refsect1>
</refentry>