opensc/doc/api/asn1/sc_asn1_encode.xml

49 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="scasn1encode">
<refentryinfo><title>OpenSC API Reference</title></refentryinfo>
<refmeta>
<refentrytitle>sc_asn1_encode</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>opensc</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sc_asn1_encode</refname>
<refpurpose>Encode ASN.1 entries into a stream</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para>
<programlisting>
#include &lt;opensc.h&gt;
int sc_asn1_encode(struct sc_context *ctx, const struct sc_asn1_entry *asn1,
unsigned char **newbuf, size_t *size);
</programlisting>
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
This function encodes an array of entries pointed to by <emphasis>asn1</emphasis> and terminated
by a NULL entry (i.e. where the <structfield>name</structfield> field of the entry is NULL) into
a newly allocated buffer.
</para>
<para>
The new buffer containing the ASN.1 stream will be stored in <emphasis>newbuf</emphasis>, and the
size of this buffer is stored in <emphasis>size</emphasis>. The application must free this buffer
after use.
</para>
</refsect1>
<refsect1>
<title>Return value</title>
<para>
Returns 0 if successful, or a negative value in case of error.
</para>
</refsect1>
</refentry>