<refentry id="libtracker-module-Metadata-Convenience-Fallback-Functions">
<refmeta>
<refentrytitle role="top_of_page" id="libtracker-module-Metadata-Convenience-Fallback-Functions.top_of_page">Metadata Convenience Fallback Functions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBTRACKER-MODULE Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Metadata Convenience Fallback Functions</refname>
<refpurpose>Helper functions to retrieve metadata or text for common files</refpurpose>
</refnamediv>

<refsynopsisdiv id="libtracker-module-Metadata-Convenience-Fallback-Functions.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;libtracker-module/tracker-module-metadata-utils.h&gt;

<link linkend="TrackerModuleMetadata">TrackerModuleMetadata</link> * <link linkend="tracker-module-metadata-utils-get-data">tracker_module_metadata_utils_get_data</link>
                                                        (<link linkend="GFile">GFile</link> *file);
<link linkend="gchar">gchar</link> *             <link linkend="tracker-module-metadata-utils-get-text">tracker_module_metadata_utils_get_text</link>
                                                        (<link linkend="GFile">GFile</link> *file);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libtracker-module-Metadata-Convenience-Fallback-Functions.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libtracker-module-Metadata-Convenience-Fallback-Functions.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="tracker-module-metadata-utils-get-data" role="function">
<title>tracker_module_metadata_utils_get_data ()</title>
<indexterm zone="tracker-module-metadata-utils-get-data"><primary sortas="tracker_module_metadata_utils_get_data">tracker_module_metadata_utils_get_data</primary></indexterm><programlisting><link linkend="TrackerModuleMetadata">TrackerModuleMetadata</link> * tracker_module_metadata_utils_get_data
                                                        (<link linkend="GFile">GFile</link> *file);</programlisting>
<para>
Returns a <link linkend="TrackerModuleMetadata"><type>TrackerModuleMetadata</type></link> filled in with all the
metadata that could be extracted for the given file.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>file</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GFile"><type>GFile</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly created <link linkend="TrackerModuleMetadata"><type>TrackerModuleMetadata</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the file is not found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-module-metadata-utils-get-text" role="function">
<title>tracker_module_metadata_utils_get_text ()</title>
<indexterm zone="tracker-module-metadata-utils-get-text"><primary sortas="tracker_module_metadata_utils_get_text">tracker_module_metadata_utils_get_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             tracker_module_metadata_utils_get_text
                                                        (<link linkend="GFile">GFile</link> *file);</programlisting>
<para>
Gets the text from <parameter>file</parameter>, if the file is considered as
containing plain text, it will be extracted, else this function
will resort to the installed text filters for the file MIME type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>file</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="GFile"><type>GFile</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly allocated string containing the file text, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1 id="libtracker-module-Metadata-Convenience-Fallback-Functions.see-also">
<title>See Also</title>
<para>
<link linkend="TrackerModuleMetadata"><type>TrackerModuleMetadata</type></link>, <link linkend="tracker-module-file-get-metadata"><function>tracker_module_file_get_metadata()</function></link> and <link linkend="tracker-module-file-get-text"><function>tracker_module_file_get_text()</function></link>
</para>
</refsect1>

</refentry>
