swfdecasarray.xml

Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and rendering engine is

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="swfdec-SwfdecAsArray">
<refmeta>
<refentrytitle role="top_of_page">SwfdecAsArray</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecAsArray</refname>
<refpurpose>the array object</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



                    <link linkend="SwfdecAsArray">SwfdecAsArray</link>;
<link linkend="SwfdecAsObject">SwfdecAsObject</link>*     <link linkend="swfdec-as-array-new">swfdec_as_array_new</link>                 (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);
<link linkend="void">void</link>                <link linkend="swfdec-as-array-append">swfdec_as_array_append</link>              (<link linkend="SwfdecAsArray">SwfdecAsArray</link> *array,
                                                         <link linkend="guint">guint</link> n,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *values);
#define             <link linkend="swfdec-as-array-push">swfdec_as_array_push</link>                (array,value)

</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
The array object provides some convenience functions for creating and
modifying arrays.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecAsArray" role="struct"/>SwfdecAsArray</title>
<indexterm><primary>SwfdecAsArray</primary></indexterm><programlisting>typedef struct {
} SwfdecAsArray;
</programlisting>
<para>
This is the type of the array object.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-as-array-new" role="function"/>swfdec_as_array_new ()</title>
<indexterm><primary>swfdec_as_array_new</primary></indexterm><programlisting><link linkend="SwfdecAsObject">SwfdecAsObject</link>*     swfdec_as_array_new                 (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context);</programlisting>
<para>
Creates a new <link linkend="SwfdecAsArray"><type>SwfdecAsArray</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new array or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on OOM.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-array-append" role="function"/>swfdec_as_array_append ()</title>
<indexterm><primary>swfdec_as_array_append</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_array_append              (<link linkend="SwfdecAsArray">SwfdecAsArray</link> *array,
                                                         <link linkend="guint">guint</link> n,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *values);</programlisting>
<para>
Appends the given <parameter>values</parameter> to the array.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsArray"><type>SwfdecAsArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
<listitem><simpara> number of values to add
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter>&nbsp;:</term>
<listitem><simpara> the values to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-array-push" role="macro"/>swfdec_as_array_push()</title>
<indexterm><primary>swfdec_as_array_push</primary></indexterm><programlisting>#define             swfdec_as_array_push(array,value)</programlisting>
<para>
Adds the given value to the array. This a macro that just calls
<link linkend="swfdec-as-array-append"><function>swfdec_as_array_append()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsArray"><type>SwfdecAsArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> the value to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>