55 lines
1.6 KiB
XML
55 lines
1.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<refentry id="screadrecord">
|
|
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>sc_read_record</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>opensc</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>sc_read_record</refname>
|
|
<refpurpose>Read a record from a file</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Synopsis</title>
|
|
<para>
|
|
<programlisting>
|
|
#include <opensc.h>
|
|
|
|
int sc_read_record(struct sc_card *card, unsigned int record,
|
|
unsigned char *buf, size_t buflen,
|
|
unsigned long flags);
|
|
</programlisting>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
This function reads a record-structured elementary file (EF) from <emphasis>card</emphasis>. The
|
|
function corresponds to the ISO 7816 READ RECORD function. Call
|
|
<link linkend="scselectfile">sc_select_file()</link> first to select the file to read from.
|
|
</para>
|
|
|
|
<para>
|
|
<emphasis>record</emphasis> specifies the ID of the record to be read, or, if
|
|
<emphasis>flags</emphasis> is set to <symbol>SC_RECORD_BY_REC_NR</symbol>, the record number. If
|
|
<emphasis>record</emphasis> is set to zero, the current record will be read.
|
|
</para>
|
|
|
|
<para>
|
|
The read data is stored in <emphasis>buf</emphasis>, which is <emphasis>buflen</emphasis> bytes
|
|
long.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Return value</title>
|
|
<para>
|
|
Returns the number of bytes read if successful, or a negative value in case of error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|