File: sc_set_card_driver.xml

package info (click to toggle)
opensc 0.11.1-2etch2
  • links: PTS
  • area: main
  • in suites: etch
  • size: 7,284 kB
  • ctags: 7,257
  • sloc: ansic: 69,499; sh: 9,480; xml: 4,191; makefile: 346; lex: 92; perl: 25
file content (66 lines) | stat: -rw-r--r-- 1,853 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?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>