84 lines
2.6 KiB
XML
84 lines
2.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<refentry id="scpatht">
|
|
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>sc_path_t</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>opensc</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>sc_file_t</refname>
|
|
<refpurpose>OpenSC path structure</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Synopsis</title>
|
|
<para>
|
|
<programlisting>
|
|
#include <opensc.h>
|
|
|
|
#define SC_MAX_PATH_SIZE 16
|
|
|
|
typedef struct sc_path {
|
|
unsigned char value[SC_MAX_PATH_SIZE];
|
|
size_t len;
|
|
|
|
int index;
|
|
int count;
|
|
|
|
int type;
|
|
} sc_path_t;
|
|
|
|
</programlisting>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
This structure describes a path object on a smart card. It contains the following
|
|
members:
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><structfield>value</structfield></term>
|
|
<listitem><para>This is the full path to the file, starting at the MF.</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><structfield>length</structfield></term>
|
|
<listitem><para>The length of the path.</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><structfield>index</structfield></term>
|
|
<listitem><para>Used only in PKCS15, this indicates the offset into the file.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><structfield>count</structfield></term>
|
|
<listitem><para>Used only in PKCS15, this indicates the number of octets in the
|
|
record, starting from <structfield>index</structfield> above.</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><structfield>type</structfield></term>
|
|
<listitem><para>The path type. This can be one of:
|
|
<simplelist type="vert" columns="1">
|
|
<member>SC_PATH_TYPE_FILE_ID</member>
|
|
<member>SC_PATH_TYPE_DF_NAME</member>
|
|
<member>SC_PATH_TYPE_PATH</member>
|
|
<member>SC_PATH_TYPE_PATH_PROT</member>
|
|
</simplelist>
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|