opensc/doc/api/apps/sc_find_app_by_aid.xml

51 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scfindappbyaid">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_find_app_by_aid</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_find_app_by_aid</refname>
<refpurpose>Find an application on a card</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
const sc_app_info_t *sc_find_app_by_aid(sc_card_t *card,
const unsigned char *aid,
size_t aid_len);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function finds an application on <emphasis>card</emphasis> by its
<emphasis>aid</emphasis>. The AID's length is specified in
<emphasis>aid_len</emphasis>.
</para>
<para>
Before calling this function, you MUST call <link
linkend="scenumapps">sc_enum_apps()</link> first.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns a <link linkend="scappinfot">sc_app_info_t</link> structure
describing the application corresponding to <emphasis>aid</emphasis>, or NULL
if none was found.
</para>
</refsect1>
</refentry>