opensc/doc/api/init/sc_set_card_driver.xml

67 lines
1.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scsetcarddriver">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_set_card_driver</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_set_card_driver</refname>
<refpurpose>Force the use of a specified smart card driver</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_set_card_driver(struct sc_context *ctx, const char *short_name);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function forces the use of a a specific card driver to be used in context
<emphasis>ctx</emphasis>. The name of the driver is specified in <emphasis>short_name</emphasis>.
Possible options are:
<simplelist type="vert" columns="1">
<member>etoken</member>
<member>flex</member>
<member>cyberflex</member>
<member>gpk</member>
<member>miocos</member>
<member>mcrd</member>
<member>setcos</member>
<member>starcos</member>
<member>tcos</member>
<member>openpgp</member>
<member>jcop</member>
<member>oberthur</member>
<member>belpic</member>
<member>emv</member>
</simplelist>
</para>
<para>
This function only needs to be called if OpenSC fails to auto-detect your card. If used, it
should be called immediately after establishing a new context with <link
linkend="scestablishcontext">sc_establish_context()</link>, but before doing anything else with
the context.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
If an error occurred, a negative value is returned indicating the error. Otherwise, 0 is
returned.
</para>
</refsect1>
</refentry>