File: sc_list_files.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 (42 lines) | stat: -rw-r--r-- 1,148 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
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="sclistfiles">
	<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
	<refmeta>
		<refentrytitle>sc_list_files</refentrytitle>
		<manvolnum>3</manvolnum>
		<refmiscinfo>opensc</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>sc_list_files</refname>
		<refpurpose>List files</refpurpose>
	</refnamediv>

	<refsect1>
		<title>Synopsis</title>
		<para>
		<programlisting>
#include &lt;opensc.h&gt;

int sc_list_files(struct sc_card *card, unsigned char *buf, size_t buflen);
		</programlisting>
		</para>
	</refsect1>

	<refsect1>
		<title>Description</title>
		<para>
			This function lists all files in the currently selected DF, and stores the file IDs as big-endian
			16-bit words in <emphasis>buffer</emphasis>, which is <emphasis>buflen</emphasis> bytes long. If
			the supplied buffer is too small to hold all file IDs, the listing is silently truncated.
		</para>
	</refsect1>

	<refsect1>
		<title>Return value</title>
		<para>
			Returns the number of bytes stored in <emphasis>buffer</emphasis>, or a negative value in case of
			error.
		</para>
	</refsect1>
</refentry>