<refentry id="libtracker-common-TrackerStorage">
<refmeta>
<refentrytitle role="top_of_page" id="libtracker-common-TrackerStorage.top_of_page">TrackerStorage</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBTRACKER-COMMON Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>TrackerStorage</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="libtracker-common-TrackerStorage.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="TrackerStorage">TrackerStorage</link>;
<link linkend="TrackerStorage">TrackerStorage</link> *    <link linkend="tracker-storage-new">tracker_storage_new</link>                 (void);
<link linkend="GSList">GSList</link> *            <link linkend="tracker-storage-get-mounted-directory-roots">tracker_storage_get_mounted_directory_roots</link>
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage);
<link linkend="GSList">GSList</link> *            <link linkend="tracker-storage-get-removable-device-roots">tracker_storage_get_removable_device_roots</link>
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage);
<link linkend="GSList">GSList</link> *            <link linkend="tracker-storage-get-removable-device-udis">tracker_storage_get_removable_device_udis</link>
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage);
const <link linkend="gchar">gchar</link> *       <link linkend="tracker-storage-udi-get-mount-point">tracker_storage_udi_get_mount_point</link> (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         const <link linkend="gchar">gchar</link> *udi);
<link linkend="gboolean">gboolean</link>            <link linkend="tracker-storage-udi-get-is-mounted">tracker_storage_udi_get_is_mounted</link>  (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         const <link linkend="gchar">gchar</link> *udi);
<link linkend="gboolean">gboolean</link>            <link linkend="tracker-storage-uri-is-on-removable-device">tracker_storage_uri_is_on_removable_device</link>
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         const <link linkend="gchar">gchar</link> *uri,
                                                         <link linkend="gchar">gchar</link> **mount_point,
                                                         <link linkend="gboolean">gboolean</link> *available);
const <link linkend="gchar">gchar</link>*        <link linkend="tracker-storage-get-volume-udi-for-file">tracker_storage_get_volume_udi_for_file</link>
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         <link linkend="GFile">GFile</link> *file);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libtracker-common-TrackerStorage.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libtracker-common-TrackerStorage.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="TrackerStorage" role="struct">
<title>TrackerStorage</title>
<indexterm zone="TrackerStorage"><primary sortas="TrackerStorage">TrackerStorage</primary></indexterm><programlisting>typedef struct {
	GObject parent;
} TrackerStorage;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="tracker-storage-new" role="function">
<title>tracker_storage_new ()</title>
<indexterm zone="tracker-storage-new"><primary sortas="tracker_storage_new">tracker_storage_new</primary></indexterm><programlisting><link linkend="TrackerStorage">TrackerStorage</link> *    tracker_storage_new                 (void);</programlisting>
<para>
Creates a new instance of <link linkend="TrackerStorage"><type>TrackerStorage</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly created <link linkend="TrackerStorage"><type>TrackerStorage</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-get-mounted-directory-roots" role="function">
<title>tracker_storage_get_mounted_directory_roots ()</title>
<indexterm zone="tracker-storage-get-mounted-directory-roots"><primary sortas="tracker_storage_get_mounted_directory_roots">tracker_storage_get_mounted_directory_roots</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            tracker_storage_get_mounted_directory_roots
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage);</programlisting>
<para>
Returns a <link linkend="GSList"><type>GSList</type></link> of strings containing the root directories for
mounted devices.
</para>
<para>
Each element must be freed using <link linkend="g-free"><function>g_free()</function></link> and the list itself using
<link linkend="g-slist-free"><function>g_slist_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="TrackerStorage"><type>TrackerStorage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The list of root directories.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-get-removable-device-roots" role="function">
<title>tracker_storage_get_removable_device_roots ()</title>
<indexterm zone="tracker-storage-get-removable-device-roots"><primary sortas="tracker_storage_get_removable_device_roots">tracker_storage_get_removable_device_roots</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            tracker_storage_get_removable_device_roots
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage);</programlisting>
<para>
Returns a <link linkend="GSList"><type>GSList</type></link> of strings containing the root directories for
removable devices.
</para>
<para>
Each element must be freed using <link linkend="g-free"><function>g_free()</function></link> and the list itself
through <link linkend="g-slist-free"><function>g_slist_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="TrackerStorage"><type>TrackerStorage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The list of root directories.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-get-removable-device-udis" role="function">
<title>tracker_storage_get_removable_device_udis ()</title>
<indexterm zone="tracker-storage-get-removable-device-udis"><primary sortas="tracker_storage_get_removable_device_udis">tracker_storage_get_removable_device_udis</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            tracker_storage_get_removable_device_udis
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage);</programlisting>
<para>
Returns a <link linkend="GSList"><type>GSList</type></link> of strings containing the UDI for removable devices.
Each element is owned by the <link linkend="GHashTable"><type>GHashTable</type></link> internally, the list
itself through should be freed using <link linkend="g-slist-free"><function>g_slist_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="TrackerStorage"><type>TrackerStorage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The list of UDIs.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-udi-get-mount-point" role="function">
<title>tracker_storage_udi_get_mount_point ()</title>
<indexterm zone="tracker-storage-udi-get-mount-point"><primary sortas="tracker_storage_udi_get_mount_point">tracker_storage_udi_get_mount_point</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       tracker_storage_udi_get_mount_point (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         const <link linkend="gchar">gchar</link> *udi);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="TrackerStorage"><type>TrackerStorage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>udi</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="gboolean"><type>gboolean</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>udi</parameter> is mounted or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if it isn't.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-udi-get-is-mounted" role="function">
<title>tracker_storage_udi_get_is_mounted ()</title>
<indexterm zone="tracker-storage-udi-get-is-mounted"><primary sortas="tracker_storage_udi_get_is_mounted">tracker_storage_udi_get_is_mounted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tracker_storage_udi_get_is_mounted  (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         const <link linkend="gchar">gchar</link> *udi);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>udi</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-uri-is-on-removable-device" role="function">
<title>tracker_storage_uri_is_on_removable_device ()</title>
<indexterm zone="tracker-storage-uri-is-on-removable-device"><primary sortas="tracker_storage_uri_is_on_removable_device">tracker_storage_uri_is_on_removable_device</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tracker_storage_uri_is_on_removable_device
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         const <link linkend="gchar">gchar</link> *uri,
                                                         <link linkend="gchar">gchar</link> **mount_point,
                                                         <link linkend="gboolean">gboolean</link> *available);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mount_point</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>available</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="tracker-storage-get-volume-udi-for-file" role="function">
<title>tracker_storage_get_volume_udi_for_file ()</title>
<indexterm zone="tracker-storage-get-volume-udi-for-file"><primary sortas="tracker_storage_get_volume_udi_for_file">tracker_storage_get_volume_udi_for_file</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        tracker_storage_get_volume_udi_for_file
                                                        (<link linkend="TrackerStorage">TrackerStorage</link> *storage,
                                                         <link linkend="GFile">GFile</link> *file);</programlisting>
<para>
Returns the UDI of the removable device for <parameter>file</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>storage</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="TrackerStorage"><type>TrackerStorage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>file</parameter>&#160;:</term>
<listitem><simpara> a file
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Returns the UDI of the removable device for <parameter>file</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
