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

<refnamediv>
<refname>gda-log</refname><refpurpose>Functions to write GDA logs</refpurpose>
</refnamediv>

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



void        <link linkend="gda-log-enable">gda_log_enable</link>                  (void);
void        <link linkend="gda-log-disable">gda_log_disable</link>                 (void);
<link linkend="gboolean">gboolean</link>    <link linkend="gda-log-is-enabled">gda_log_is_enabled</link>              (void);
void        <link linkend="gda-log-message">gda_log_message</link>                 (const <link linkend="gchar">gchar</link> *format,
                                             ...);
void        <link linkend="gda-log-error">gda_log_error</link>                   (const <link linkend="gchar">gchar</link> *format,
                                             ...);
void        <link linkend="gda-log-clean-all">gda_log_clean_all</link>               (const <link linkend="gchar">gchar</link> *prgname);
void        <link linkend="gda-log-clean-between">gda_log_clean_between</link>           (const <link linkend="gchar">gchar</link> *prgname,
                                             const <link linkend="gchar">gchar</link> *from,
                                             const <link linkend="gchar">gchar</link> *to);
void        <link linkend="gda-log-clean-entry">gda_log_clean_entry</link>             (const <link linkend="gchar">gchar</link> *prgname,
                                             const <link linkend="gchar">gchar</link> *entry);
</synopsis>
</refsynopsisdiv>





<refsect1>
<title>Description</title>
<para>
This module contains functions that let you send log messages from your
GDA applications (either clients or providers) to the GDA log system.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gda-log-enable">gda_log_enable ()</title>
<programlisting>void        gda_log_enable                  (void);</programlisting>
<para>
Enables GDA logs</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gda-log-disable">gda_log_disable ()</title>
<programlisting>void        gda_log_disable                 (void);</programlisting>
<para>
</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gda-log-is-enabled">gda_log_is_enabled ()</title>
<programlisting><link linkend="gboolean">gboolean</link>    gda_log_is_enabled              (void);</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"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-log-message">gda_log_message ()</title>
<programlisting>void        gda_log_message                 (const <link linkend="gchar">gchar</link> *format,
                                             ...);</programlisting>
<para>
Logs the given message in the GDA log 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>format</parameter>&nbsp;:</entry>
<entry> message string
</entry></row>
<row><entry align="right"><parameter>...</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-log-error">gda_log_error ()</title>
<programlisting>void        gda_log_error                   (const <link linkend="gchar">gchar</link> *format,
                                             ...);</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>format</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>...</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-log-clean-all">gda_log_clean_all ()</title>
<programlisting>void        gda_log_clean_all               (const <link linkend="gchar">gchar</link> *prgname);</programlisting>
<para>
Clear the entire log for the given program</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>prgname</parameter>&nbsp;:</entry>
<entry> program name
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-log-clean-between">gda_log_clean_between ()</title>
<programlisting>void        gda_log_clean_between           (const <link linkend="gchar">gchar</link> *prgname,
                                             const <link linkend="gchar">gchar</link> *from,
                                             const <link linkend="gchar">gchar</link> *to);</programlisting>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>prgname</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>from</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>to</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-log-clean-entry">gda_log_clean_entry ()</title>
<programlisting>void        gda_log_clean_entry             (const <link linkend="gchar">gchar</link> *prgname,
                                             const <link linkend="gchar">gchar</link> *entry);</programlisting>
<para>

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


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

</refsect1>




</refentry>
