opensc/doc/api/file/sc_list_files.xml

43 lines
1.1 KiB
XML

<?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>