opensc/doc/api/file/sc_delete_record.xml

43 lines
1.0 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scdeleterecord">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_delete_record</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_delete_record</refname>
<refpurpose>Delete a record from a file</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_delete_record(struct sc_card *card, unsigned int rec_nr);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function deletes a record specified by <emphasis>rec_nr</emphasis> on
<emphasis>card</emphasis>. This is not a standard ISO
7816 operation, and is currently only supported on the
Oberthur smart cards.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns 0 if successful, or a negative value in case of error.
</para>
</refsect1>
</refentry>