<refentry id="GdaError">
<refmeta>
<refentrytitle>GdaError</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA-COMMON Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GdaError</refname><refpurpose></refpurpose>
</refnamediv>

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



<link linkend="GdaError">GdaError</link>*   <link linkend="gda-error-new">gda_error_new</link>                   (void);
<link linkend="GList">GList</link>*      <link linkend="gda-error-list-from-exception">gda_error_list_from_exception</link>   (<link linkend="CORBA-Environment">CORBA_Environment</link> *ev);
void        <link linkend="gda-error-to-exception">gda_error_to_exception</link>          (<link linkend="GdaError">GdaError</link> *error,
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *ev);
void        <link linkend="gda-error-list-to-exception">gda_error_list_to_exception</link>     (<link linkend="GList">GList</link> *error_list,
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *ev);
<link linkend="GDA-ErrorSeq">GDA_ErrorSeq</link>* <link linkend="gda-error-list-to-corba-seq">gda_error_list_to_corba_seq</link>   (<link linkend="GList">GList</link> *error_list);
void        <link linkend="gda-error-free">gda_error_free</link>                  (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-list-free">gda_error_list_free</link>             (<link linkend="GList">GList</link> *errors);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-description">gda_error_get_description</link>      (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-description">gda_error_set_description</link>       (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *description);
const <link linkend="glong">glong</link> <link linkend="gda-error-get-number">gda_error_get_number</link>            (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-number">gda_error_set_number</link>            (<link linkend="GdaError">GdaError</link> *error,
                                             <link linkend="glong">glong</link> number);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-source">gda_error_get_source</link>           (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-source">gda_error_set_source</link>            (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *source);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-help-url">gda_error_get_help_url</link>         (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-help-url">gda_error_set_help_url</link>          (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *helpurl);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-help-context">gda_error_get_help_context</link>     (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-help-context">gda_error_set_help_context</link>      (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *helpctxt);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-sqlstate">gda_error_get_sqlstate</link>         (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-sqlstate">gda_error_set_sqlstate</link>          (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *sqlstate);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-native">gda_error_get_native</link>           (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-native">gda_error_set_native</link>            (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *native);
const <link linkend="gchar">gchar</link>* <link linkend="gda-error-get-real-command">gda_error_get_real_command</link>     (<link linkend="GdaError">GdaError</link> *error);
void        <link linkend="gda-error-set-real-command">gda_error_set_real_command</link>      (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *realcommand);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GtkObject">GtkObject</link>
   +----GdaError
</synopsis>

</refsect1>




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

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gda-error-new">gda_error_new ()</title>
<programlisting><link linkend="GdaError">GdaError</link>*   gda_error_new                   (void);</programlisting>
<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-error-list-from-exception">gda_error_list_from_exception ()</title>
<programlisting><link linkend="GList">GList</link>*      gda_error_list_from_exception   (<link linkend="CORBA-Environment">CORBA_Environment</link> *ev);</programlisting>
<para>
Creates a list of <link linkend="GdaError">GdaError</link>'s from a CORBA_Environment structure. This
is the standard way of informing of errors.</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>ev</parameter>&nbsp;:</entry>
<entry> a CORBA_Environment structure
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> a list of <link linkend="GdaError">GdaError</link> structures.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-to-exception">gda_error_to_exception ()</title>
<programlisting>void        gda_error_to_exception          (<link linkend="GdaError">GdaError</link> *error,
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *ev);</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>error</parameter>&nbsp;:</entry>
<entry> a <link linkend="GdaError">GdaError</link> object
</entry></row>
<row><entry align="right"><parameter>ev</parameter>&nbsp;:</entry>
<entry> a CORBA exception
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-list-to-exception">gda_error_list_to_exception ()</title>
<programlisting>void        gda_error_list_to_exception     (<link linkend="GList">GList</link> *error_list,
                                             <link linkend="CORBA-Environment">CORBA_Environment</link> *ev);</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>error_list</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>ev</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-list-to-corba-seq">gda_error_list_to_corba_seq ()</title>
<programlisting><link linkend="GDA-ErrorSeq">GDA_ErrorSeq</link>* gda_error_list_to_corba_seq   (<link linkend="GList">GList</link> *error_list);</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>error_list</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-error-free">gda_error_free ()</title>
<programlisting>void        gda_error_free                  (<link linkend="GdaError">GdaError</link> *error);</programlisting>
<para>
Frees the memory allocated by the error object.</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>error</parameter>&nbsp;:</entry>
<entry> the error object.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-list-free">gda_error_list_free ()</title>
<programlisting>void        gda_error_list_free             (<link linkend="GList">GList</link> *errors);</programlisting>
<para>
Frees all error objects in the list and the list itself.
After this function has been called, the <parameter>errors</parameter> parameter doesn't point
to valid storage any more.</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>errors</parameter>&nbsp;:</entry>
<entry> a glist holding error objects.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-description">gda_error_get_description ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_description      (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-description">gda_error_set_description ()</title>
<programlisting>void        gda_error_set_description       (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *description);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>description</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-number">gda_error_get_number ()</title>
<programlisting>const <link linkend="glong">glong</link> gda_error_get_number            (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-number">gda_error_set_number ()</title>
<programlisting>void        gda_error_set_number            (<link linkend="GdaError">GdaError</link> *error,
                                             <link linkend="glong">glong</link> number);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>number</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-source">gda_error_get_source ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_source           (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-source">gda_error_set_source ()</title>
<programlisting>void        gda_error_set_source            (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *source);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>source</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-help-url">gda_error_get_help_url ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_help_url         (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-help-url">gda_error_set_help_url ()</title>
<programlisting>void        gda_error_set_help_url          (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *helpurl);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>helpurl</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-help-context">gda_error_get_help_context ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_help_context     (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-help-context">gda_error_set_help_context ()</title>
<programlisting>void        gda_error_set_help_context      (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *helpctxt);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>helpctxt</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-sqlstate">gda_error_get_sqlstate ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_sqlstate         (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-sqlstate">gda_error_set_sqlstate ()</title>
<programlisting>void        gda_error_set_sqlstate          (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *sqlstate);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>sqlstate</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-native">gda_error_get_native ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_native           (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-native">gda_error_set_native ()</title>
<programlisting>void        gda_error_set_native            (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *native);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>native</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-error-get-real-command">gda_error_get_real_command ()</title>
<programlisting>const <link linkend="gchar">gchar</link>* gda_error_get_real_command     (<link linkend="GdaError">GdaError</link> *error);</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>error</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-error-set-real-command">gda_error_set_real_command ()</title>
<programlisting>void        gda_error_set_real_command      (<link linkend="GdaError">GdaError</link> *error,
                                             const <link linkend="gchar">gchar</link> *realcommand);</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>error</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>realcommand</parameter>&nbsp;:</entry>
<entry>


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

</refsect1>




</refentry>
