swfdecurl.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-SwfdecURL">
<refmeta>
<refentrytitle role="top_of_page">SwfdecURL</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecURL</refname>
<refpurpose>URL handling in Swfdec
<parameter>see_also</parameter> <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



                    <link linkend="SwfdecURL">SwfdecURL</link>;
<link linkend="SwfdecURL">SwfdecURL</link>*          <link linkend="swfdec-url-copy">swfdec_url_copy</link>                     (const <link linkend="SwfdecURL">SwfdecURL</link> *url);
<link linkend="void">void</link>                <link linkend="swfdec-url-free">swfdec_url_free</link>                     (<link linkend="SwfdecURL">SwfdecURL</link> *url);
const <link linkend="char">char</link>*         <link linkend="swfdec-url-get-host">swfdec_url_get_host</link>                 (const <link linkend="SwfdecURL">SwfdecURL</link> *url);
const <link linkend="char">char</link>*         <link linkend="swfdec-url-get-path">swfdec_url_get_path</link>                 (const <link linkend="SwfdecURL">SwfdecURL</link> *url);
const <link linkend="char">char</link>*         <link linkend="swfdec-url-get-protocol">swfdec_url_get_protocol</link>             (const <link linkend="SwfdecURL">SwfdecURL</link> *url);
const <link linkend="char">char</link>*         <link linkend="swfdec-url-get-query">swfdec_url_get_query</link>                (const <link linkend="SwfdecURL">SwfdecURL</link> *url);
const <link linkend="char">char</link>*         <link linkend="swfdec-url-get-url">swfdec_url_get_url</link>                  (const <link linkend="SwfdecURL">SwfdecURL</link> *url);
<link linkend="SwfdecURL">SwfdecURL</link>*          <link linkend="swfdec-url-new">swfdec_url_new</link>                      (const <link linkend="char">char</link> *string);
<link linkend="SwfdecURL">SwfdecURL</link>*          <link linkend="swfdec-url-new-relative">swfdec_url_new_relative</link>             (const <link linkend="SwfdecURL">SwfdecURL</link> *url,
                                                         const <link linkend="char">char</link> *string);

</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
SwfdecURL is Swfdec's way of handling URLs. You probably don't need to mess 
with this type unless you want to write a <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link>. In that case you 
will want to use @<link linkend="swfdec-loader-get-url"><function>swfdec_loader_get_url()</function></link> to get its url and then use the 
functions in this section to access it.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecURL" role="struct"/>SwfdecURL</title>
<indexterm><primary>SwfdecURL</primary></indexterm><programlisting>typedef struct _SwfdecURL SwfdecURL;</programlisting>
<para>
this is the structure used for URLs. It is a boxed type to glib's type system
and it is not reference counted. It is also a static struct in that it cannot
be modified after creation.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-url-copy" role="function"/>swfdec_url_copy ()</title>
<indexterm><primary>swfdec_url_copy</primary></indexterm><programlisting><link linkend="SwfdecURL">SwfdecURL</link>*          swfdec_url_copy                     (const <link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
copies the given url.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-free" role="function"/>swfdec_url_free ()</title>
<indexterm><primary>swfdec_url_free</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_url_free                     (<link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
Frees the URL and its associated ressources.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-get-host" role="function"/>swfdec_url_get_host ()</title>
<indexterm><primary>swfdec_url_get_host</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_url_get_host                 (const <link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
Gets the host for <parameter>url</parameter>. If the host includes a portnumber, it will be present
in the returned string.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the host or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none (typically for file URLs).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-get-path" role="function"/>swfdec_url_get_path ()</title>
<indexterm><primary>swfdec_url_get_path</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_url_get_path                 (const <link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
Gets the path associated with <parameter>url</parameter>. If it contains no path, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is 
returned.
<note>The returned path does not start with a slash. So in particular for 
files, you want to prepend the slash yourself.</note></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the path or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-get-protocol" role="function"/>swfdec_url_get_protocol ()</title>
<indexterm><primary>swfdec_url_get_protocol</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_url_get_protocol             (const <link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
Gets the protocol used by this URL, such as "http" or "file".</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the protocol used or "error" if the URL is broken
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-get-query" role="function"/>swfdec_url_get_query ()</title>
<indexterm><primary>swfdec_url_get_query</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_url_get_query                (const <link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
Gets the query string associated with <parameter>url</parameter>. If the URL does not have a query
string, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Query string or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-get-url" role="function"/>swfdec_url_get_url ()</title>
<indexterm><primary>swfdec_url_get_url</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_url_get_url                  (const <link linkend="SwfdecURL">SwfdecURL</link> *url);</programlisting>
<para>
Gets the whole URL.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the complete URL as string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-new" role="function"/>swfdec_url_new ()</title>
<indexterm><primary>swfdec_url_new</primary></indexterm><programlisting><link linkend="SwfdecURL">SwfdecURL</link>*          swfdec_url_new                      (const <link linkend="char">char</link> *string);</programlisting>
<para>
Parses the given string into a URL for use in swfdec.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter>&nbsp;:</term>
<listitem><simpara> a full-qualified URL encoded in UTF-8
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-url-new-relative" role="function"/>swfdec_url_new_relative ()</title>
<indexterm><primary>swfdec_url_new_relative</primary></indexterm><programlisting><link linkend="SwfdecURL">SwfdecURL</link>*          swfdec_url_new_relative             (const <link linkend="SwfdecURL">SwfdecURL</link> *url,
                                                         const <link linkend="char">char</link> *string);</programlisting>
<para>
Parses <parameter>string</parameter> into a new URL. If the given <parameter>string</parameter> is a relative URL, it 
uses <parameter>url</parameter> to resolve it to an absolute url.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>string</parameter>&nbsp;:</term>
<listitem><simpara> a relative or absolute URL path
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecURL"><type>SwfdecURL</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if an error was detected.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>





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