<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="xfconf-xfconf-errors">
<refmeta>
<refentrytitle role="top_of_page" id="xfconf-xfconf-errors.top_of_page">Error Reporting</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XFCONF Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Error Reporting</refname>
<refpurpose>Xfconf library and daemon error descriptions</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="xfconf-xfconf-errors.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
#define             <link linkend="XFCONF-ERROR:CAPS">XFCONF_ERROR</link>
enum                <link linkend="XfconfError">XfconfError</link>;
</synopsis>
</refsynopsisdiv>









<refsect1 id="xfconf-xfconf-errors.description" role="desc">
<title role="desc.title">Description</title>
<para>
Both the Xfconf daemon and library provide error information via the
use of <link linkend="GError"><type>GError</type></link><!-- -->s.
</para>
</refsect1>

<refsect1 id="xfconf-xfconf-errors.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="XFCONF-ERROR:CAPS" role="macro">
<title>XFCONF_ERROR</title>
<indexterm zone="XFCONF-ERROR:CAPS"><primary>XFCONF_ERROR</primary></indexterm><programlisting>#define XFCONF_ERROR       (xfconf_get_error_quark())
</programlisting>
<para>
The <link linkend="GError"><type>GError</type></link> error domain for Xfconf.</para>
<para>

</para></refsect2>
<refsect2 id="XfconfError" role="enum">
<title>enum XfconfError</title>
<indexterm zone="XfconfError"><primary>XfconfError</primary></indexterm><programlisting>typedef enum
{
    XFCONF_ERROR_UNKNOWN = 0,
    XFCONF_ERROR_CHANNEL_NOT_FOUND,
    XFCONF_ERROR_PROPERTY_NOT_FOUND,
    XFCONF_ERROR_READ_FAILURE,
    XFCONF_ERROR_WRITE_FAILURE,
    XFCONF_ERROR_PERMISSION_DENIED,
    XFCONF_ERROR_INTERNAL_ERROR,
    XFCONF_ERROR_NO_BACKEND,
    XFCONF_ERROR_INVALID_PROPERTY,
    XFCONF_ERROR_INVALID_CHANNEL,
} XfconfError;
</programlisting>
<para>
An enumeration listing the different kinds of errors under the
XFCONF_ERROR domain.</para>
<para>

</para><variablelist role="enum">
<varlistentry id="XFCONF-ERROR-UNKNOWN:CAPS" role="constant">
<term><literal>XFCONF_ERROR_UNKNOWN</literal></term>
<listitem><simpara>An unknown error occurred
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-CHANNEL-NOT-FOUND:CAPS" role="constant">
<term><literal>XFCONF_ERROR_CHANNEL_NOT_FOUND</literal></term>
<listitem><simpara>The specified channel does not exist
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-PROPERTY-NOT-FOUND:CAPS" role="constant">
<term><literal>XFCONF_ERROR_PROPERTY_NOT_FOUND</literal></term>
<listitem><simpara>The specified property does not exist on the channel
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-READ-FAILURE:CAPS" role="constant">
<term><literal>XFCONF_ERROR_READ_FAILURE</literal></term>
<listitem><simpara>There was a failure reading from the configuration store
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-WRITE-FAILURE:CAPS" role="constant">
<term><literal>XFCONF_ERROR_WRITE_FAILURE</literal></term>
<listitem><simpara>There was a failure writing to the configuration store
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-PERMISSION-DENIED:CAPS" role="constant">
<term><literal>XFCONF_ERROR_PERMISSION_DENIED</literal></term>
<listitem><simpara>The user is not allowed to read or write to the channel or property
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-INTERNAL-ERROR:CAPS" role="constant">
<term><literal>XFCONF_ERROR_INTERNAL_ERROR</literal></term>
<listitem><simpara>An internal error (likely a bug in xfconf) occurred
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-NO-BACKEND:CAPS" role="constant">
<term><literal>XFCONF_ERROR_NO_BACKEND</literal></term>
<listitem><simpara>No backends were found, or those found could not be loaded
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-INVALID-PROPERTY:CAPS" role="constant">
<term><literal>XFCONF_ERROR_INVALID_PROPERTY</literal></term>
<listitem><simpara>The property name specified was invalid
</simpara></listitem>
</varlistentry>
<varlistentry id="XFCONF-ERROR-INVALID-CHANNEL:CAPS" role="constant">
<term><literal>XFCONF_ERROR_INVALID_CHANNEL</literal></term>
<listitem><simpara>The channel name specified was invalid

</simpara></listitem>
</varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
