<refentry id="libgda-common-gda-util">
<refmeta>
<refentrytitle>gda-util</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA-COMMON Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gda-util</refname><refpurpose>Convenient functions</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>



<link linkend="GList">GList</link>*      <link linkend="gda-util-hash-to-list">gda_util_hash_to_list</link>           (<link linkend="GHashTable">GHashTable</link> *hash_table);
<link linkend="gboolean">gboolean</link>    <link linkend="gda-util-destroy-hash-pair">gda_util_destroy_hash_pair</link>      (<link linkend="gchar">gchar</link> *key,
                                             <link linkend="gpointer">gpointer</link> value,
                                             <link linkend="GFreeFunc">GFreeFunc</link> free_func);
<link linkend="gchar">gchar</link>*      <link linkend="gda-util-load-file">gda_util_load_file</link>              (const <link linkend="gchar">gchar</link> *filename);
<link linkend="gboolean">gboolean</link>    <link linkend="gda-util-save-file">gda_util_save_file</link>              (const <link linkend="gchar">gchar</link> *filename,
                                             const <link linkend="gchar">gchar</link> *text);
</synopsis>
</refsynopsisdiv>





<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gda-util-hash-to-list">gda_util_hash_to_list ()</title>
<programlisting><link linkend="GList">GList</link>*      gda_util_hash_to_list           (<link linkend="GHashTable">GHashTable</link> *hash_table);</programlisting>
<para>
Convert a <link linkend="GHashTable">GHashTable</link> into a <link linkend="GList">GList</link>. It only adds to the list the
hash table's keys, not the data associated with it. Another thing
this function assumes is that the keys are strings (that is,
zero-delimited sequence of characters)</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>hash_table</parameter>&nbsp;:</entry>
<entry> a hash table
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> the newly created <link linkend="GList">GList</link>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-util-destroy-hash-pair">gda_util_destroy_hash_pair ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gda_util_destroy_hash_pair      (<link linkend="gchar">gchar</link> *key,
                                             <link linkend="gpointer">gpointer</link> value,
                                             <link linkend="GFreeFunc">GFreeFunc</link> free_func);</programlisting>
<para>
</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>key</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>value</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>free_func</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-util-load-file">gda_util_load_file ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gda_util_load_file              (const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
Load a file from disk, and return its contents as a newly-allocated
string. You must then free it yourself when no longer needed</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filename</parameter>&nbsp;:</entry>
<entry> file name
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-util-save-file">gda_util_save_file ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gda_util_save_file              (const <link linkend="gchar">gchar</link> *filename,
                                             const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Save the given text into a file</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filename</parameter>&nbsp;:</entry>
<entry> file name
</entry></row>
<row><entry align="right"><parameter>text</parameter>&nbsp;:</entry>
<entry> file contents
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>
